diff --git a/docs/assets/guide/en/tutorial_docs/VChart_Skill_Usage.md b/docs/assets/guide/en/tutorial_docs/VChart_Skill_Usage.md index 7c9f964be1..89cd17561a 100644 --- a/docs/assets/guide/en/tutorial_docs/VChart_Skill_Usage.md +++ b/docs/assets/guide/en/tutorial_docs/VChart_Skill_Usage.md @@ -39,12 +39,12 @@ Skill directory preview: Suggested prompt: ```text -Use VChart to generate a basic bar chart with xField, yField, and a minimal runnable example. +Use VChart to generate a basic bar chart with xField and yField, and deliver a complete HTML file I can open. ``` Expected result: -- A runnable minimal spec is generated. +- A complete HTML file contains the spec and chart initialization. - The chart can render correctly. ![simple chart demo](/vchart/guide/skill-usage/generate-chart.webp) @@ -79,6 +79,32 @@ Expected result: ![config fix demo](/vchart/guide/skill-usage/fix-config.webp) +## HTML and spec delivery + +| Goal | Request | Result | +| --- | --- | --- | +| View a chart or run a demo | “Generate complete runnable HTML” | A page with application interactions when requested | +| Let a host render the chart | “Return only the complete spec / JSON” | Configuration without HTML, instance code or a host envelope | +| Both | “Provide the spec and an HTML preview using it” | The same configuration and its preview | + +Explicit output requirements take priority, followed by established host/application context. Standalone viewing defaults to HTML. Editing a spec inside existing HTML keeps HTML delivery; editing a standalone spec keeps spec delivery. Components and combined deliverables also retain their established target. “Add labels” returns the complete updated artifact unless a patch is explicitly requested. An explicit request such as “return only JSON” changes the delivery target. + +```text +Monday 12, Tuesday 25, Wednesday 18, Thursday 32. +Use an appropriate VChart chart to compare the values. Return only the complete JSON spec, without explanation. +``` + +Host constraints may be established earlier: + +```text +The host renders VChart specs and accepts JSON only. It supports bar and line charts, but no functions. +Apply these constraints to subsequent data visualization requests. +``` + +The agent can then work from the goal and data without repeatedly asking for JS/React. Specs may be JSON or JavaScript; preserve documented callbacks in JS and never silently drop them to serialize JSON. Declarative tooltip and legend interactions stay in the spec; external events and business logic need application integration. + +Check actual data, field mappings and JSON syntax, and render when possible. Parsing does not prove rendering or host compatibility. A temporary validation page does not replace the requested spec deliverable. + ## Notes - Make sure the skill is installed in your project editor skill directory. diff --git a/docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md b/docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md index 48aedc1db3..0550a763dd 100644 --- a/docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md +++ b/docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md @@ -10,7 +10,7 @@ VChart 和 VTable 作为 VisActor 数据可视化解决方案的核心组件， ## 简介 -`vchart-skill` 面向支持 skills 的 AI 编辑器，核心目标是让模型更准确理解 VChart 语义与实践路径，从而减少试错成本。 +`vchart-skill` 面向支持 skills 的 AI 编辑器，核心目标是让模型更准确理解 VChart 语义与实践路径，从而减少试错成本。支持生成可直接查看的 HTML，以及供宿主消费的完整 VChart spec。 ## 安装与简单 Demo @@ -51,12 +51,12 @@ npx skills add VisActor/VChart --skill vchart-development-assistant 建议提示词： ```text -使用 VChart 生成一个基础柱状图，包含 xField、yField 和最小可运行示例。 +使用 VChart 生成一个基础柱状图，包含 xField、yField，交付可直接打开查看的完整 HTML。 ``` 验收点： -- 能输出可运行的最小 spec。 +- 能输出包含完整配置和实例创建的 HTML。 - 图表可正常渲染。 示例效果： @@ -97,6 +97,34 @@ npx skills add VisActor/VChart --skill vchart-development-assistant ![修复配置问题示例](/vchart/guide/skill-usage/fix-config.webp) +## HTML 与 spec 交付 + +| 需要什么 | 如何提出需求 | 得到什么 | +| --- | --- | --- | +| 直接查看或页面演示 | “生成可打开的完整 HTML” | 完整页面，按需包含应用交互 | +| 宿主渲染或配置集成 | “只返回完整 spec / JSON” | 配置本身，不混入页面、实例代码或宿主外壳 | +| 两种都需要 | “给 spec 和使用它的 HTML 预览” | 同一份配置与对应页面 | + +明确要求优先，其次沿用已知宿主/应用上下文；独立展示需求默认 HTML。已有 HTML 内的 spec 修改仍交付 HTML，独立 spec 修改仍交付 spec；组件和组合产物保留原目标。“加标签”默认返回修改后的完整产物，明确只要片段时才返回增量；明确“只返回 JSON”等要求时切换交付。 + +生成完整 JSON 的提示词： + +```text +周一 12、周二 25、周三 18、周四 32。 +用合适的 VChart 图表比较这些数值，只返回完整 JSON spec，不要解释。 +``` + +宿主上下文可以在前文提供： + +```text +宿主负责渲染，只接收 JSON VChart spec，支持 bar 和 line，不接受函数。 +后续给数据时按这些约束生成配置。 +``` + +后续只需说明表达目标与数据，不重复询问 JS/React。spec 不一定是 JSON；支持函数的环境可用 JS，纯 JSON 宿主采用声明式配置，不能通过序列化丢掉回调。tooltip/图例等声明式交互可以留在 spec 内，外部事件和业务代码单独处理。 + +配置会检查真实数据与字段，JSON 会检查可解析性；条件允许时实际渲染。未执行渲染或没有目标宿主环境时说明验证范围，不能把格式检查当作渲染验证。临时验收 HTML 不改变最终 spec 交付。 + ## 常见问题与注意事项 - 如果编辑器不支持 skills，需先确认当前版本是否提供该能力。 diff --git a/docs/skills/vchart-development-assistant-maintenance.md b/docs/skills/vchart-development-assistant-maintenance.md new file mode 100644 index 0000000000..b8620f2534 --- /dev/null +++ b/docs/skills/vchart-development-assistant-maintenance.md @@ -0,0 +1,39 @@ +# VChart 技能知识库维护 + +本文供仓库维护使用，普通图表生成不需要安装仓库依赖或运行维护检查。技能入口见 [SKILL.md](../../skills/vchart-development-assistant/SKILL.md)。 + +## 来源与生成 + +[metadata-sources.json](../../packages/vchart/scripts/skill-metadata/metadata-sources.json) 是维护入口清单，登记 36 个核心/扩展图型的真实源码入口、74 个人工详情映射及扩展注册前提。源码路径按仓库根解析，详情目标按技能 references 根解析。六个 3D 图型、pictogram 及 sequence 由宿主注册，注册前提不是 spec 字段。 + +内部抽取模型保留源码位置、原始类型、完整继承与映射关系；类型按真实符号解析，不按同名字符串合并。复杂依赖按实际符号生成，既有人工详情不会自动覆盖。 + +分发投影只保留配置生成所需知识；`source/inheritedFrom/originalType/category`、继承树和维护指纹不随 JSON 分发。维护审计仍从内部模型报告属性源码位置。 + +## 分发格式 3 + +- 顶层保留 `typeName/formatVersion/vchartVersion/effectiveProperties/complexTypeDefinitions`，按需保留扩展版本、注册前提、开放契约和行为差异说明。 +- 属性保留 `name/description/type/required/isSimple/dependencies`，按需保留 `defaultValue/since/deprecated/literalValues/dependencyBindings`。 +- 定义保留 `typeName/reference`，外部定义保留 `package/version`。导航键及别名绑定不因移除源码路径而改变。 +- `contractNotes` 保留 `description/example`；其中用于维护核查的源码位置仅存在于来源清单和内部模型。 +- `since` 是原始说明文本，可能描述某个取值的新增版本，不能直接当作纯 semver 或完整兼容承诺。 +- 不支持旧分发结构的回退读取；结构版本与 VChart 版本是不同概念。 + +## 命令 + +从仓库根执行，使用 Node.js 22 和仓库已安装依赖： + +```sh +node packages/vchart/scripts/skill-metadata.mjs audit --report /tmp/vchart-metadata-audit.json +node packages/vchart/scripts/skill-metadata.mjs generate --output /tmp/vchart-metadata-generated +# 审查候选输出后再更新已提交产物 +node packages/vchart/scripts/skill-metadata.mjs generate --write +node packages/vchart/scripts/skill-metadata.mjs check +node --test packages/vchart/scripts/skill-metadata/distribution.test.mjs packages/vchart/scripts/skill-metadata.test.mjs +``` + +临时路径由执行者选择，避免覆盖既有验收证据。`generate --output` 包含 type-meta 与补充声明，独立审计候选时须在完整 references 副本中替换这些产物，再传 `audit --references DIR`；该目录还需要 topkey 和人工详情。 + +`audit/check` 只读，差异使退出码非零。`audit --report` 的 `provenance` 记录核心/扩展版本、TypeScript 版本、输入内容指纹和相关源码提交，报告保存在指定位置，不复制到技能目录。指纹不包含当前时间或无关文档提交。 + +生成只更新 type-meta 和补充声明；topkey 与人工详情按源码依据维护，audit 检查字段、作用域及导航。这些检查不要求用户对生成配置执行 schema 或编译验证。 diff --git a/docs/superpowers/plans/2026-10-14-vchart-delivery-context-and-diagnostic-data.md b/docs/superpowers/plans/2026-10-14-vchart-delivery-context-and-diagnostic-data.md new file mode 100644 index 0000000000..f2be92f673 --- /dev/null +++ b/docs/superpowers/plans/2026-10-14-vchart-delivery-context-and-diagnostic-data.md @@ -0,0 +1,162 @@ +# VChart Delivery Context and Diagnostic Data Implementation Plan + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [x]`) syntax for tracking. +> +> 上述技能不可用时，在当前会话顺序执行，不自行安装技能或创建其他聊天。本文件是两项 review 问题的专项计划，已完成修复与本轮验收；结果见 [专项验收记录](../validation/2026-10-14-vchart-delivery-context-and-diagnostic-data.md)。 + +**Goal:** 保证修改 HTML 内的 spec 不会隐式改变交付目标，并让描述诊断优先使用真实数据，仅在明确的演示场景使用标注的 mock。 + +**Architecture:** 主文件维护唯一的交付选择顺序，配置修改只识别任务内容，不越过已建立的产物目标；专项流程引用这条规则。诊断流程按已知数据和任务性质决定继续处理或澄清，不将“没有 spec”推导成“没有真实数据”。复用现有行为评估和 HTML 工具验证，不新增状态机或校验系统。 + +**Tech Stack:** 中文 Markdown、既有 VChart HTML 模板/生成器、JSON 标准解析器、现有浏览器工具；维护者测试使用 Node.js 22。 + +## 全局约束 + +- 只修复本轮 review 的两项 P2 问题，不重新设计 HTML/spec 场景或增量生成模式。 +- 实施基础是当前含上一轮未提交改动的工作区，不用 HEAD 或已安装技能覆盖它。 +- 不修改图库运行时、生成器、模板、React 实现或宿主集成；不引入 schema、依赖或新的评测平台。 +- 本轮明确要求优先；没有改变输出要求时保留已建立的 HTML、spec、组件或组合交付目标。 +- “已有 spec”“配置修改”“加标签”描述输入或修改内容，不能单独作为切换产物的指令。 +- 没有既定目标时，独立配置请求选择 spec；独立展示选择 HTML。仍无法判断且影响可用性时才澄清，不每次询问格式。 +- 完整产物仍为默认；只有明确要求片段/补丁才返回局部配置。JSON/JS 及宿主约束保持现有规则。 +- 缺少原 spec 不代表缺少真实数据。当前请求、已有对话和可访问真实数据源均需优先使用，不能被 mock 替换。 +- 缺少影响诊断的实际数据或字段时询问必要信息；无法取得的真实数据绑定保留其契约并说明验收限制，不填 mock 冒充成功。 +- Mock 仅用于用户明确请求/允许的教学或样式演示，明确标注来源；无固定“至少 5 条”要求，不把演示配置报告为原业务问题已经修复。 +- 验证检查真实产物、数据和必要交互，不添加只匹配 Markdown 用词的测试。未执行、只做走查或格式解析不能登记为实际渲染通过。 +- 原版行为测试未失败时如实记录，不人为诱导失败；本期验收证明规则和指定边界成立，不推导成功率提升。 +- 不发布、不向 issue 发消息、不更新全局安装副本；提交 PR 前遵循仓库全量视觉基线要求。 + +## 文件与职责 + +以下路径相对仓库根目录。 + +| 文件 | 修改范围 | +| --- | --- | +| `skills/vchart-development-assistant/SKILL.md` | 限定 spec 识别信号的作用范围，明确“任务内容不自动改变已建立目标” | +| `skills/vchart-development-assistant/workflows/scenario-2-generation.md` | 共享入口引用主规则，不把修改输入的 spec 当作最终产物选择 | +| `skills/vchart-development-assistant/README.md` | 修正“已有 spec 修改沿用配置目标”的无条件表述 | +| `docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md`、对应英文文件 | 对齐相同的上下文保持规则，保留已有内容和图片 | +| `skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md` | 对齐信息收集与描述诊断的数据来源；去除无条件 mock 和最少条数要求 | +| `evals/vchart-development-assistant/generation-scenarios.md` | 增加 R01–R07 专项边界，复用既有场景作回归 | +| `docs/superpowers/validation/2026-10-14-vchart-delivery-context-and-diagnostic-data.md` | 实施时新增，记录当前工作区快照、实际任务与验收限制 | + +HTML/spec 专项流程已要求保持目标和使用真实数据，本期只检查它们与上述修复一致；不重写或复制一套规则。上一轮验收记录保留，本轮新增记录，不能将旧结果直接改为新修复通过。 + +## Task 1：修复交付识别信号与既有目标的优先级 + +**输入：** 用户本轮要求、既定 HTML/spec/组件目标、作为输入的已有配置。 +**输出：** 沿用或明确切换后的交付目标。 + +- [x] 冻结当前技能到新的临时目录，保留本轮修复前的实际工作区版本，避免错误地比较上一轮优化前的 HEAD： + +```sh +python3 - <<'PY' +from pathlib import Path +import shutil +import tempfile +snapshot = Path(tempfile.mkdtemp(prefix='vchart-review-before-')) +shutil.copytree('skills/vchart-development-assistant', snapshot / 'vchart-development-assistant') +print(snapshot) +PY +``` + +- [x] 用冻结副本执行一次 R01、R04，保存实际产物和决策。不要求必然失败；静态歧义可以存在于一次正确输出中。 +- [x] 在主文件将交付规则明确为下列语义，场景表的信号只在该顺序内使用： + +```text +1. 本轮明确指定产物或变更格式：按要求交付，遵守实际能力限制。 +2. 未指定变更：保持已建立的交付目标，包括已有 HTML、组件和组合产物。 +3. 仍无目标：根据当前任务识别；独立配置请求选 spec，独立展示选 HTML。 +4. 必要歧义影响可用性时才澄清。 + +已有 spec 是配置输入，不等于用户请求 spec 作为最终输出。 +``` + +- [x] 主文件相关条目写为：“尚未建立交付目标时，独立的配置生成/修改请求选择 spec；已有 HTML 或组件上下文时保留原产物，除非用户明确改变交付要求。”React 特例和组合交付继续成立。 +- [x] 共享生成流程继续引用主文件，并明确 HTML 内 spec 修改不重新路由。只修改冲突句，不再定义第二套默认值。 +- [x] README 及中英文教程同步：已有 HTML 中的 spec 修改继续交付 HTML；独立 spec 修改继续交付 spec；“只返回 JSON”是明确变更，优先于旧 HTML 目标。 +- [x] 执行 R01–R03，确认上下文保持、显式切换和无既定目标的配置请求均成立。对 R01 实际打开更新页面，核对原数据、标签和既有交互。 + +建议提交：`docs(skills): preserve delivery target during spec edits`。 + +## Task 2：修复描述诊断的真实数据与 mock 规则 + +**输入：** 当前或此前提供的数据、可访问真实数据源/绑定、错误描述、是否已有 spec，以及是否明确为演示任务。 +**输出：** 使用真实数据的修复配置、必要澄清，或明确标注的演示配置。 + +- [x] 配置诊断的信息收集先复用已提供信息，只补充影响定位的缺项；移除“至少 3–5 条”机械要求，防止已有上下文仍被重复追问。 +- [x] 描述诊断在“问题类型/图型/目标”之外，检查已有真实数据、字段、单位和可用绑定。不要因为未提供原 spec 就默认生成数据。 +- [x] 用以下规则替换“构建至少 5 条 mock 数据”： + +```text +真实数据或可用绑定已知：按原字段和口径构建配置，不替换或增加记录。 +真实数据缺失且影响诊断：询问必要数据/字段，不能伪造完整业务修复配置。 +绑定真实但本地不可访问：保留绑定契约，区分配置分析与未完成的运行验收。 +用户明确请求或允许演示：可用明确标注的 mock 解释问题，不报告业务修复通过。 +``` + +- [x] 仍按既定 HTML/spec 目标交付，不因数据不足强制 HTML；无法完成时说明或澄清，不输出空数据或假数据的“已修复”配置。 +- [x] 对照主文件、共享流程和 spec 流程检查一致性；只将诊断分支收敛到现有真实数据规则，不新增数据解析器。 +- [x] 执行 R04–R07：真实数据、缺少必要信息、允许 mock 演示、不可访问绑定分别检查。实际 JSON 的记录数、字段和原值必须可核实。 + +建议提交：`docs(skills): use actual data in descriptive diagnosis`。 + +## Task 3：专项行为验证与已有场景回归 + +每个独立任务只提供技能、原始请求和必要输入，不提供判定答案或疑似问题。R01 先完成 HTML 生成，再在同一任务追加真实修改请求，以实际历史验证目标保持。描述诊断任务按需读取诊断工作流，审查读取记录以确认该分支被覆盖。 + +| ID | 完整请求与上下文 | 检查内容 | +| --- | --- | --- | +| R01 | 第一轮：“周一 12、周二 25、周三 18、周四 32。生成完整 VChart HTML，点击柱子在页面显示 day/value；先不显示数值标签。”第二轮：“在已有 HTML 中，把 spec 的数值标签打开，其他内容保留。” | 第二轮仍是完整 HTML；四条数据不变；真实标签出现，点击结果仍正确；没有只交付 JSON/spec | +| R02 | 使用 R01 的完整 HTML 上下文，新请求：“现在只返回其中更新后的完整 JSON spec，不要 HTML 或解释。” | 明确变更生效；最终答复可解析 JSON，无实例/事件代码；数据完整 | +| R03 | 独立上下文，提供完整周数据 JSON 柱图：“加上数值标签，返回修改后的配置。” | 完整 spec，不因独立展示默认值生成 HTML；没有退化成补丁 | +| R04 | “我的 VChart 柱图数值轴空白，没有原 spec。真实数据为 [{day:'周一',amount:11},{day:'周二',amount:23},{day:'周三',amount:7},{day:'周四',amount:35}]，amount 单位为元。请按这些真实字段提供可用完整 JSON 配置，不要解释。” | 覆盖描述诊断流程；只含四条真实记录，保留 day/amount 和单位；不能替换成 A/B 类别或增加第 5 条；不能声称已定位未提供代码的根因 | +| R05 | “业务图数值不对，我暂时没有原配置、实际数据或字段定义。请给修复后的完整 spec，不能使用模拟数据。” | 询问必要信息或说明当前不能完成；不填 mock、不虚构字段，不报修复/渲染通过 | +| R06 | “这是教学演示：请用明确标注的 mock 数据解释 yField 指错导致柱图空白的情况，给可运行 HTML。” | 演示能力保留，标注 mock；可运行修复示例；不声称真实业务问题已解决 | +| R07 | “宿主负责绑定 dataId='actual-orders' 的真实数据，字段 day/amount，但本地不能访问它。我没有原 spec，只知道数值轴空白；请给配置排查方向，保留真实绑定，不生成模拟数据。” | 保留绑定信息，不以内嵌 mock 替代；区分候选原因、配置检查与未执行运行验收 | + +- [x] R01 与 R04 修复后各执行两次，其余各一次；另复用已有 G01、G03、G08-R 请求各一次。重复次数只作为边界冒烟，不宣称统计稳定性。 +- [x] 对 R01 比较改动前后数据、应用交互和实际标签。不要只看 HTML 文件存在或单个 canvas；明确切换的 R02 按纯 JSON 检查。 +- [x] 对 R04 用标准 JSON 解析器核对真实字段与完整记录： + +```python +expected = [ + {'day': '周一', 'amount': 11}, + {'day': '周二', 'amount': 23}, + {'day': '周三', 'amount': 7}, + {'day': '周四', 'amount': 35}, +] +data = actual_spec['data'] +sources = data if isinstance(data, list) else [data] +assert len(sources) == 1 +assert sources[0]['values'] == expected +assert actual_spec['xField'] == 'day' +assert actual_spec['yField'] == 'amount' +``` + +`actual_spec` 是从实际答复解析的 JSON，不能由测试者重写后再检查。此处检查的字段绑定适用于该固定垂直柱图任务，不把它变成通用 VChart 校验器。 + +- [x] R04 条件允许时实际渲染四个原值；R06 实际打开修复演示；R07 不通过接入 mock 伪造运行结果。记录所有无法执行的阶段。 +- [x] 运行既有转义单测、技能结构校验和本地链接检查；本期不新增文本匹配测试： + +```sh +python3 -m unittest discover -s skills/vchart-development-assistant/tests -v +git diff --check +``` + +结构校验复用现有 `skill-creator/scripts/quick_validate.py` 与可用的 PyYAML 环境；不修改项目依赖。 + +- [x] 保存独立的 validation 文档，记录修复前/后实际观察、两项问题对应的证据、回归结果和未验证范围；保留上一轮记录。 +- [ ] 提交 PR 前按仓库要求运行 `node packages/vchart/scripts/visual-test.mjs`，审查报告。本轮未创建 PR，仅修改 Markdown，未重跑图库视觉比较；此项保留为未来 PR 的前置要求。图表基线不能代替上述技能行为测试，也不能因其通过就忽略数据/产物错误。 + +## 完成条件 + +- [x] 输入含 spec 不再自动覆盖已建立的 HTML/组件/组合目标，显式产物变更仍优先。 +- [x] 描述诊断优先使用真实数据/绑定，未提供 spec 不再触发无条件 mock。 +- [x] 缺少关键信息时不伪造配置；明确教学演示仍可使用标注的 mock。 +- [x] R01–R07 与三项既有回归有真实结果记录，实际 HTML 交互与 JSON 数据核对符合要求。 +- [x] 规则集中维护，没有新增场景、运行时改造、schema 或依赖。 + +## 深度交互 + +这两项修复都属于规则优先级收敛：输入类型不决定最终产物，缺少配置不决定数据来源。维护一条主决策并让专项流程遵循，比新增更多例外或场景更容易长期保持一致。 diff --git a/docs/superpowers/plans/2026-10-14-vchart-development-assistant-optimization.md b/docs/superpowers/plans/2026-10-14-vchart-development-assistant-optimization.md new file mode 100644 index 0000000000..b8a155d379 --- /dev/null +++ b/docs/superpowers/plans/2026-10-14-vchart-development-assistant-optimization.md @@ -0,0 +1,218 @@ +# VChart Development Assistant Scenario Optimization Implementation Plan + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [x]`) syntax for tracking. +> +> 上述技能不可用时，在当前会话依次执行并记录结果；不自行安装技能或创建其他聊天。用户已授权实施，仓库技能修改与本次验收已完成；未提交或发布。结果见 [验收记录](../validation/2026-10-14-vchart-development-assistant-optimization.md)。 + +**Goal:** 扩展现有 `vchart-development-assistant` 的生成场景，明确区分“生成可查看的 HTML”和“生成可复用的 VChart spec”，让已有开发者与自主 Agent 均能获得符合目标的产物。 + +**Architecture:** 配置生成保留共享的意图理解、选图、字段绑定和配置查询，再按交付目标进入 HTML 或 spec 工作流。诊断、视觉还原和 React 能力继续保留，并遵循相同的交付选择。验证使用数据与配置自检、JSON 解析及可用的真实渲染，不建设新的校验系统。 + +**Tech Stack:** 中文 Markdown、原生 VChart JSON/JavaScript 示例、既有 HTML 模板与生成脚本、Python 3 标准库、仓库已有浏览器与视觉测试工具；维护者视觉回归使用 Node.js 22。 + +## 范围与约束 + +- 本期核心是场景和交付契约：扩展现有技能，不新增独立技能。 +- 本期不实施 schema 校验，不新增 schema CLI、Ajv/semver 依赖、版本检查器或替代 schema，不以 schema 工作完成作为交付条件。 +- 不新增预览平台或共享渲染器，不调整既有 render/update/release 生命周期，不修改图库运行时。 +- 优先复用配置知识库、HTML 模板与生成脚本。生成脚本只在本期场景验收暴露直接阻断时做最小修复，修复须有明确复现和对应测试；不捆绑无关重构。 +- 明确 HTML 或 spec 需求时直接执行。已有宿主只接收 spec 的上下文持续有效，不每轮重复询问。 +- 普通独立“画图/展示数据”请求且无宿主上下文时，延续可查看 HTML 的交付方式，不全面改成默认 JSON。只有上下文仍无法判断、且选择会影响可用性时才问一次交付形式。 +- spec 场景不默认询问 JS/React；HTML 场景也不机械追问框架，独立网页默认原生 JS，已有 React 上下文则复用专项路径。 +- 信息充分时自主选图，不逐次确认；只澄清会影响图义、真实数据口径或交付可用性的缺失信息。 +- 不补造真实业务数据，不默认聚合、抽样、截断、补零或改写缺失；必要的数据变换说明规则及影响。功能教学允许明确标注的 mock 数据，不把 mock 当作用户数据。 +- spec 不等同于 JSON。纯 JSON 宿主采用可序列化配置；文档化函数需求在允许 JavaScript 的场景中保留，不序列化丢失回调。 +- 用户要求机器可消费的纯 JSON 时只输出配置本身；说明、假设、验证结果不混入配置。普通对话可给配置文件链接及简短说明。 +- spec 的临时渲染页只是验收材料，不能代替所请求的 spec 产物。未执行渲染时如实说明，不因文件生成或 JSON 解析通过就声称渲染成功。 +- 已知宿主约束只依据用户、已有上下文或可核实资料；不臆测宿主版本、图型、尺寸、函数及资源支持。浏览器验证不冒充目标宿主验证。 +- 本期不改相邻数据科学技能；统计图 HTML 需求保持现有分流，明确的原生 VChart spec 需求进入本技能 spec 场景，不因提到“数据分析”就改变交付。 +- 只维护仓库技能源码，不自动更新已安装副本。实施前检查当前工作区，保留其他任务改动。 +- 按仓库 `AGENTS.md` 运行适当检查；提交 PR 前执行全量官方 develop 基线视觉比较，审查差异和执行错误，不用自比较代替。 + +## 场景模型 + +技能面向用户明确说明四类场景：HTML 生成、spec 生成、问题诊断、视觉还原。HTML/spec 是生成需求的两条交付路径；诊断与视觉还原可以交付其中一种。React 和 API 集成保持能力模块，不再新增一组并行场景。 + +| 维度 | HTML 生成 | spec 生成 | +| --- | --- | --- | +| 目标 | 直接查看、演示、操作图表 | 交给宿主渲染、嵌入应用或供其他工具消费 | +| 典型信号 | “生成 HTML”“可运行 demo”“能打开查看”；无宿主上下文的普通展示需求 | “只要 spec”“返回 JSON”“生成配置”；上下文已声明接收 spec 的宿主 | +| 共享输入 | 表达目标、真实数据、已知图型与样式要求 | 表达目标、真实数据、已知图型与样式要求 | +| 专属上下文 | 必要的应用环境、交互 API、页面展示要求 | 宿主已知支持范围、配置格式与必要运行约束 | +| 产物 | 可运行 HTML；React 请求按已有专项契约处理 | 完整可复用 spec；只有明确要求片段或补丁才返回增量 | +| 边界 | 按需包含实例创建、事件和页面代码 | 不混入 HTML、实例创建、宿主包装或传输代码 | +| 验收 | 实际打开页面，检查图元及明确请求的交互 | 检查字段、数据、必需配置及格式；条件允许时真实渲染 | + +交付选择顺序：最新明确要求 → 已建立的宿主/应用上下文 → 用户任务目标 → 既有独立 HTML 默认。最新消息未改变交付目标时保留之前目标。同时请求 spec 与 HTML 时交付两者，并使用同一份配置。格式沿用用户要求、宿主契约与已有配置，均未知时可序列化配置用 JSON，确需且环境允许函数时用 JS。 + +## 文件与职责 + +下列路径相对仓库根目录。 + +| 文件 | 改动 | +| --- | --- | +| `skills/vchart-development-assistant/SKILL.md` | 修改：入口描述、四类场景、HTML/spec 路由、条件化澄清、输出和自检原则 | +| `skills/vchart-development-assistant/workflows/scenario-2-generation.md` | 修改：共享生成过程和两条交付流程的导航，保留原路径 | +| `skills/vchart-development-assistant/workflows/scenario-2-html-generation.md` | 新增：HTML 交付与既有模板/脚本使用，按需交互和实际验收 | +| `skills/vchart-development-assistant/workflows/scenario-2-spec-generation.md` | 新增：自主 spec 编写、宿主约束、JSON/JS、验证与交付 | +| `skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md`、`scenario-1-react.md`、`scenario-3-image-replication.md` | 修改：对齐交付选择及上下文保持，不重写专项知识 | +| `skills/vchart-development-assistant/references/chart/chart-type-guide.md` | 修改：有针对性地补充选图和数据语义，校正被触及的误导规则 | +| `skills/vchart-development-assistant/examples/spec-generation/README.md`、`weekly-bar.json`、`composition-pie.json`、`callback-label.js` | 新增：用途和边界说明；JSON 业务图与 JS 回调示例 | +| `evals/vchart-development-assistant/generation-scenarios.md` | 新增：固定提示、上下文、预期产物、判定与实际输出记录要求 | +| `skills/vchart-development-assistant/README.md` | 修改：两种生成场景的用途、提问示例和交付区别 | +| `docs/assets/guide/zh/tutorial_docs/VChart_Skill_Usage.md`、对应英文文件 | 修改：中文优先补全场景说明，英文按现有体系同步 | +| `docs/superpowers/validation/2026-10-14-vchart-development-assistant-optimization.md` | 实施时新增：规则走查、Agent 行为、真实渲染、既有场景及视觉回归证据 | + +## Task 1：明确场景入口与交付决策 + +**输入：** 用户需求与已有上下文。 +**输出：** HTML 或 spec 交付目标，以及诊断/视觉还原等当前任务类型；分类是内部决策，不要求用户传新协议。 + +- [x] 调整 description，覆盖“生成可查看 HTML”和“为宿主生成可复用 spec”，保留诊断、还原、API 和 React 识别条件。 +- [x] 主文件明确四类场景，按上方选择顺序路由。现有配置生成流程保留为共享入口，不复制选图和配置查询知识。 +- [x] 将“所有场景必须 HTML”替换成条件化输出规范：HTML 场景交付可运行页面；spec 场景交付完整配置；诊断、还原沿用用户明确目标及上下文。 +- [x] 移除无条件框架追问和选图确认，补充信息充分时直接执行的规则。 +- [x] 诊断生成错误时保留交付目标：spec 出错仍修复 spec，HTML 出错仍修复页面；用户明确要求转换产物时才切换交付目标。 +- [x] 删除无证据的“字段映射占 80% 问题源”，要求 Agent 根据实际数据检查字段，不能只把检查责任交给用户。 +- [x] 规则走查：明确 HTML、明确 spec、上下文宿主、普通独立展示、spec 失败后诊断，各检查一次；只记为文档一致性检查，不冒充行为实测。 + +建议提交：`docs(skills): distinguish HTML and spec generation scenarios`。 + +## Task 2：编写两条生成工作流 + +**共享过程：** 目标理解 → 数据语义 → 选图 → 字段绑定 → 配置查询与生成。 +**分支过程：** HTML 包装和页面验收；或 spec 格式、宿主约束和配置验收。 + +- [x] `scenario-2-generation.md` 保留完整/增量生成说明，将两种交付的专项规则集中到对应文件，不再定义相反默认值。 +- [x] HTML 流程继续使用 `template/demo.html` 和 `scripts/generate_demo_html.py`；独立网页默认原生 JS，页面按钮与交互代码只按真实需求添加。 +- [x] HTML 流程记录现有脚本的工作目录要求，以可执行命令说明，而不是借本期重构所有生成器： + +```sh +cd skills/vchart-development-assistant +python3 scripts/generate_demo_html.py \ + --spec-file /tmp/vchart-skill-check/spec.js \ + --output /tmp/vchart-skill-check/chart.html +``` + +`spec.js` 是前一步实际生成的配置。实施验收使用新的临时目录；该 HTML 命令不能作为仅要 spec 的任务的最终交付。 + +- [x] spec 流程从目标、数据和已有约束开始，不要求技术栈、实例或应用代码；图型与字段已知时直接生成。 +- [x] 完整 spec 包含数据或明确可用的数据绑定、图型所需字段和用户要求的配置。不能把“完整 spec”固定成所有图型都必须有 xField/yField。 +- [x] JSON 通过标准解析器验证，保持 0、null、Unicode 和数据顺序；JS 保留文档化回调，明确不能用于只接收 JSON 的宿主。 +- [x] 宿主只能接收 JSON 而需求依赖函数时，优先查询已知声明式能力；无法表达则说明限制，不静默删除函数，也不擅自改交付 HTML。 +- [x] 明确不得静默改变单位、顺序、缺失和分母；只检查会影响当前选图的语义，不扩大为数据审计。 +- [x] 验证分三项记录：数据/配置检查、JSON 格式检查（仅 JSON）、真实渲染（条件允许）；本期不包含 schema 阶段。 +- [x] 真实渲染直接使用交付 spec。可临时加 `const spec = ...` 并复用现有演示工具；针对 JS 回调直接保留代码。记录实际使用的渲染环境与版本证据，不凭模板 URL 猜宿主支持。 +- [x] 移除原流程无必要的选图确认和 spec 输出里强制附带 `new VChart`/render 调用的要求。 + +建议提交：`docs(skills): add dedicated HTML and spec generation workflows`。 + +## Task 3：示例与既有场景对齐 + +**输入：** 标准原生 VChart 配置及现有专项流程。 +**输出：** 无宿主外壳的可复用示例，以及保持原交付目标的诊断/还原说明。 + +- [x] 新建周数据柱图示例： + +```json +{ + "type": "bar", + "data": { + "values": [ + {"day": "周一", "value": 12}, + {"day": "周二", "value": 25}, + {"day": "周三", "value": 18}, + {"day": "周四", "value": 32} + ] + }, + "xField": "day", + "yField": "value" +} +``` + +- [x] `composition-pie.json` 采用同一总体 A=30、B=70，配置 `type:'pie'`、`categoryField:'category'`、`valueField:'value'`，注明演示数据和分母。 +- [x] `callback-label.js` 在周数据柱图基础上使用文档化 label formatMethod 回调，注明 JS 格式要求；不把该例转换为 JSON 以“验证兼容”。 +- [x] README 说明三份示例的目标、数据、格式与宿主要求，不把示例数据当作用户数据。 +- [x] 选图指南只修正与本期相关的语义：数字 ID 与度量区分、趋势与类目比较、占比分母、零与缺失；移除仅按记录数量机械选图的规则。 +- [x] 诊断、React 和视觉还原文件对齐主入口契约。保留已有专项模板及知识，避免把 React 组件问题当作纯配置生成。 +- [x] 修正触及文件的 `chart-type-guide.md` 路径和死链，不做知识库全面搬迁。 + +建议提交：`docs(skills): add reusable specs and preserve existing scenario contracts`。 + +## Task 4：验证场景行为与实际产物 + +**执行原则：** 不建设新的评测平台。行为任务使用相同模型与设置、独立上下文和固定提示，保存实际产物和结果；不能拿手工示例通过替代 Agent 成功。 + +| ID | 固定任务与上下文 | 判定 | +| --- | --- | --- | +| G01 | issue 四天数据，明确“只返回 JSON spec” | JSON 可解析；四条值与顺序正确；无框架追问、选图确认、HTML 或实例代码 | +| G02 | 相同数据，明确“生成可打开查看的 HTML” | 完整 HTML；实际绘制正确柱值 | +| G03 | 前文宿主声明只接收 JSON，本轮只说“用合适图表展示” | 保留 spec 目标；不重复问宿主或改成 HTML | +| G04 | 无宿主上下文的普通独立展示需求 | 默认可查看 HTML；不会因新增 spec 场景直接改为 JSON | +| G05 | JSON 宿主要求只能用函数实现的效果 | 核实声明式能力；不能实现时说明限制；不删除函数后声称完成 | +| G06 | 给错误 spec，要求完整修复 JSON；随后反馈仍有问题 | 修复配置并保留 JSON 交付目标；不强制 HTML | +| G07 | HTML 需求：点击柱子获取 datum | 真实点击后断言数据值，不以点击成功或截图存在代替 | +| G08 | React 问题和图片还原，各一个代表任务 | 两个子任务分别检查；保持已有专项能力和用户指定交付目标 | +| G09 | 数据含零、缺失、数字 ID；明确字段含义 | 图义和字段角色正确；不静默补零、删行或把 ID 当度量 | +| G10 | 明确要 spec，但当前没有可用浏览器 | 给出可完成的 spec，自检说明真实；不声称实际渲染通过 | + +- [x] 在 `evals/vchart-development-assistant/generation-scenarios.md` 写出每份任务的完整提示、数据、已知约束和判定；不能在执行后补充有利假设。 +- [x] G01–G04 各执行三次；其余至少一次。G08 两个子任务分别记录，总计至少 19 份实际任务输出。另补充完整增量交付、JSON 原生 tooltip、spec/HTML 组合交付与 JS 回调四项边界任务。记录结果，失败则调整规则并重测相关任务，不用一次成功证明稳定。 +- [x] 比较原版与新版的关键 HTML/spec 路由行为，避免新增 spec 场景抢占既有 HTML 需求。 +- [x] 用 Python 标准库解析实际 JSON 产物；检查数据与字段。示例格式检查可以从仓库根执行： + +```sh +python3 - <<'CHECK' +import json +from pathlib import Path +root = Path('skills/vchart-development-assistant/examples/spec-generation') +def reject_constant(value): + raise ValueError(f'JSON 不允许 {value}') +for file in sorted(root.glob('*.json')): + spec = json.loads(file.read_text(), parse_constant=reject_constant) + assert isinstance(spec, dict), file + assert isinstance(spec.get('type'), str), file + print(file) +CHECK +``` + +此命令只证明示例 JSON 基本格式，不证明 VChart 配置正确、Agent 任务成功或图表已经渲染。 + +- [x] 用已有浏览器工具打开实际 HTML，以及由实际交付 spec 临时生成的验收 HTML；检查真实数据、字段、图元和可见效果。JS 回调示例检查真实标签内容。 +- [x] G07 断言实际 datum；做一次受控反例确认字段错误或动作被抑制时不能通过。反例不作为合法 spec 提交，也不固化为兼容承诺。 +- [x] 不改变现有模板生命周期以便通过验收。若脚本存在直接阻断，记录复现、最小修复和针对性测试；新修复必须独立说明。 +- [x] 单独记录目标宿主验收情况；没有真实宿主环境时记录未执行，浏览器验证通过不改变该结论。 + +建议提交：`test(skills): document generation scenario evaluation and evidence`。 + +## Task 5：文档与交付验收 + +- [x] README 和中文教程按 HTML/spec 两类生成场景介绍用途、提问和产物；补充纯 JSON 和既有宿主上下文案例，英文按现有结构同步。 +- [x] 明确“HTML 用于直接查看；spec 用于其他环境消费”，并说明 spec 场景生成临时 HTML 验收不会改变最终产物。 +- [x] 检查触及文件的 Markdown 链接、JSON 示例和全文规则一致性。纯文档改动不新增只匹配文字的实现镜像测试。 +- [x] 按改动运行相关视觉目录；本期没有图库运行时修改，主要有效证据来自真实生成产物和场景行为，不把图库基线测试代替技能验收。 +- [x] 提交 PR 前运行 `node packages/vchart/scripts/visual-test.mjs`，审查 `agent-summary.md` 和三图 HTML。差异说明、执行错误和环境阻断如实记录，不跳过或放宽阈值。 +- [x] 只有发现相关公共渲染覆盖空缺时才新增图库 case，按显式清单登记并完成用例指南要求；不写虚构或空白 BugServer ID。 +- [x] 新建 validation 文档：固定模型与设置、任务产物路径、每次判定、JSON 检查、实际渲染/交互、既有场景和视觉回归结果；失败及未执行单独记录。 +- [x] 检查 diff 与本期范围一致；不发布、不更新全局技能副本、不向 issue 发消息。 + +建议提交：`docs(skills): explain HTML and spec delivery scenarios`。 + +## 最终验收 + +- [x] HTML/spec 两类生成场景均有明确触发、输入、产物和验收要求，主文件与专项流程无矛盾。 +- [x] 明确 spec 需求和宿主上下文可直接产出完整配置，普通独立展示继续交付 HTML。 +- [x] JSON/JS 格式选择尊重真实约束，不丢回调、不混入宿主包装或应用代码。 +- [x] 诊断及还原保留交付目标；React 和真实 API 交互未退化。 +- [x] 数据、格式、自检和实际渲染证据分开记录，未执行不写成通过。 +- [x] G01–G04 三次及其余任务的实际产物均有记录；失败已修正并完成相关重测。 +- [x] 文档、示例和 PR 前视觉结果已审查；没有新增 schema 校验、预览平台或渲染器重构。 + +## 深度交互 + +HTML/spec 是交付目标，不是两套图表知识。两条工作流共享选图与配置查询，专项文件只承载各自的交付规则，避免长期重复维护。独立 HTML 默认与宿主 spec 上下文可以同时成立，新增场景不需要强制所有用户改变使用方式。 + + +## 执行记录 + +2026-10-14 完成上述任务，详见验收记录。旧版三项对照也得到正确产物，本次不宣称模型成功率提升。直接验收暴露了既有生成器对回调代码 `${...}` 的插值问题，进行了单点转义修复并增加行为回归测试；没有引入新渲染器或改变图库运行时。目标宿主、React 挂载和自动技能发现不在本次已通过的证据范围内。 diff --git a/docs/superpowers/plans/2026-10-14-vchart-metadata-dependency-navigation.md b/docs/superpowers/plans/2026-10-14-vchart-metadata-dependency-navigation.md new file mode 100644 index 0000000000..63ddb3a6b0 --- /dev/null +++ b/docs/superpowers/plans/2026-10-14-vchart-metadata-dependency-navigation.md @@ -0,0 +1,278 @@ +# VChart 元数据依赖与类型导航修复计划 + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [x]`) syntax for tracking. +> +> 本计划于 2026-10-15 在当前会话顺序实施。未安装额外技能、未创建其他聊天、未提交或推送代码。结果见 [验收记录](../validation/2026-10-15-vchart-metadata-dependency-navigation.md)。 + +**Goal:** 修复同名类型覆盖、人工详情绕过传递依赖检查、typeof 导航缺失三个问题，补充能在修复前暴露问题的反例测试，保持现有 HTML/spec 场景规则不变。 + +**Architecture:** 继续使用仓库 TypeScript Compiler API。依赖内部按真实声明位置和符号标识归并，输出阶段再分配导航键；将相关类型解析校验与文档展开策略分离；为类型查询补充对应值声明及导航。保留现有元数据消费字段、生成 CLI 和技能交付流程，不建立新的文档平台。 + +**Tech Stack:** Node.js 22、仓库 TypeScript 4.9.5、node:test、现有 Python unittest；复用项目依赖，不安装或升级依赖。 + +## 范围与已知事实 + +- 当前分支为 `codex/improve-vchart-skill-html-spec`，HEAD 为 `de46ca24b`。上一轮元数据优化仍在工作区，不能以 HEAD 代替本轮基线，也不能覆盖或提交其他未提交内容。 +- 同一属性 `A | B` 引用两个模块的同名 `Item` 时，当前依赖 Map 只保留一个定义；当前 36 个入口未发现真实碰撞。 +- 属性经 `Broken` 引用缺失模块时，没有人工详情会拒绝；配置人工详情后会跳过递归，错误被遗漏。当前直接缺模块测试没有覆盖这个分支。 +- 新补充文档中 `DirectionType = keyof typeof Direction` 和 `RenderMode = keyof typeof RenderModeEnum` 已缺少所引用枚举的详情导航。 +- 当前 12 项 Node 测试与 check 均通过。因此新增测试必须证明修复前的上述失败，不能仅追加通过的生成快照。 + +## 方案选择 + +| 方案 | 代价 | 判断 | +| --- | --- | --- | +| 修复共享依赖解析、校验与序列化路径 | 局部修改维护脚本，三类问题都有统一回归入口 | 采用 | +| 手工添加缺失 JSON/Markdown 引用 | 下一次生成仍覆盖修补；同名与传递依赖问题仍存在 | 不采用 | +| 全仓库语义检查、全量递归复制文档 | 无关可选依赖可能阻断生成，资源进一步膨胀 | 不采用 | + +## 全局约束 + +1. 不修改 HTML/spec 选择、JSON/JS 格式、增量完整交付、诊断真实数据、React 或 API 场景规则。 +2. 不修改图库运行时、公开类型、转换器、HTML 生成器或模板，不引入 schema 校验或用户生成时的编译步骤。 +3. 保留 `dependencies: string[]`、`complexTypeDefinitions`、`reference`、`typeName`、`inheritanceTree`、`effectiveProperties` 等现有消费字段。导航键是查找标识，`typeName` 始终保留真实符号名。 +4. 无碰撞的短名称继续使用原键；有碰撞时所有相关目标使用稳定的模块区分键，不能让遍历顺序决定谁保留短名称。 +5. 人工详情映射只能改变展示入口；不能决定是否校验类型依赖。显式 any、合法索引签名及 pictogram 的开放契约继续保留。 +6. 只校验可达的公开类型声明及实际类型查询。不遍历函数体、未被引用的导入或整个包，不把 TS Program 的全部诊断当作失败条件。 +7. 若可达类型声明确实依赖缺失模块或符号，必须报错。不能用“可选依赖”标签忽略实际相关错误；与配置类型无关的可选模块缺失不阻断生成。 +8. 校验范围与文档展开范围分离：保留外部类型的直接声明及包版本边界，不因补校验而递归复制外部依赖手册。 +9. 同一输入、不同入口或属性访问顺序输出稳定；新增键和锚点不携带个人路径。使用现有源码路径规范化和 hash 工具。 +10. 本轮实施时未经后续请求不提交、推送、创建 PR、发布或同步全局技能。未来提交 PR 前遵循仓库全量视觉比较要求。 + +## 文件职责 + +| 文件 | 计划修改 | +| --- | --- | +| `packages/vchart/scripts/skill-metadata/extract.mjs` | 依赖身份、碰撞导航键、可达类型校验、typeof 解析、详情与审查一致性 | +| `packages/vchart/scripts/skill-metadata.test.mjs` | 三组反例与正例、CLI 不写入检查、真实类型导航回归 | +| `packages/vchart/scripts/skill-metadata.mjs` | 仅在需要跨图型收集后统一序列化时调整 buildArtifacts；保留命令接口 | +| `skills/vchart-development-assistant/references/type-meta/*.json` | 用修复后的生成器重建，仅接受有依据的导航和来源变更 | +| `skills/vchart-development-assistant/references/type-details/AdditionalTypes-Type-Definition.md` | 补真实 typeof 值声明和相关链接 | +| `docs/superpowers/validation/2026-10-15-vchart-metadata-dependency-navigation.md` | 实施时新增，记录修复前失败、修复后通过和场景约束检查 | + +`SKILL.md`、workflows、scripts、template、topkey、人工 type-details 和 metadata-sources.json 不计划修改。若实施发现必须改变这些文件，先说明具体原因；不得借维护修复改写场景规则。 + +## Task 1：冻结本轮基线并建立真实 fixture + +**Files:** 测试文件、实施验收记录；基线文件存放临时目录。 + +**输入：** 当前工作区完整技能及维护脚本。 +**输出：** 可重现的修复前状态、临时源码 fixture、受保护文件的内容摘要。 + +- [x] 保存当前工作区技能与维护工具快照、git 起点、Node/TS/包版本及文件摘要，不 reset 工作区。 +- [x] 保存 `SKILL.md`、README、workflows、scripts、template、topkey、人工 type-details 的摘要，后续逐文件比较；生成目录另记录 type/required/原始声明/继承视图。 +- [x] 在现有测试文件加入下列 fixture 辅助函数。全部 TS 源码放临时目录，通过现有 createContext 的真实 Compiler API 解析，finally 清理。 + +```javascript +function withFixture(files, fn, detailReferences = {}) { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-navigation-')); + try { + for (const [name, text] of Object.entries(files)) { + const file = path.join(directory, name); + fs.mkdirSync(path.dirname(file), { recursive: true }); + fs.writeFileSync(file, text); + } + const sourceFile = path.relative(root, path.join(directory, 'index.ts')); + const item = { chart: 'fixture', typeName: 'Spec', sourceFile, package: '@visactor/vchart' }; + const mapped = Object.fromEntries(Object.entries(detailReferences).map(([name, target]) => { + const [file, symbol] = name.split('#'); + const relative = path.relative(root, path.join(directory, file)).split(path.sep).join('/'); + return [`${relative}#${symbol}`, target]; + })); + const c = createContext(root, [item], { ...manifest, detailReferences: mapped }); + return fn(c, item, directory); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +} +``` + +- [x] 跑现有 12 项 Node 测试和 check，记录本轮实际基线。夹具断言读取真实符号、source/filePath 和类型；不以与 extractor 无关的 rootDir 提示为失败依据。 + +## Task 2：按真实身份保留同名依赖 + +**Files:** extract.mjs、skill-metadata.test.mjs。 + +**内部接口：** + +```typescript +type DependencyEdge = { + id: string; // 规范化声明文件 + 符号限定名；包含命名空间/所属声明链 + symbol: ts.Symbol; + expressions: Set; // 此声明内出现的引用拼写，例如 A、B +}; +// 现有 dependencies/boundDependencies 改为按 id 合并，避免短名称覆盖。 +type DependencyMap = Map; +``` + +**输出约定：** `dependencies` 继续指向 `complexTypeDefinitions` 的键。唯一名称用 `Item`；同名不同来源用 `Item__<来源身份hash的12位前缀>`。收集当前图表的完整依赖后一次性分配键，并检测意外 hash/键碰撞，禁止静默覆盖。详情锚点沿用真实来源身份。 + +已有顶层声明继续使用 `文件#名称` 身份；同一文件不同命名空间的同名声明使用各自限定名。不要把行号加入正常身份，使无关插入行导致全部键和锚点迁移。 + +当引用拼写与真实名称不同，或发生同名碰撞时，属性增加可选 `dependencyBindings`，例如 `{ A: 'Item__abc...', B: 'Item__def...' }`。这样 `type: 'A | B'` 能对应到两个实际目标，不仅保留两个无法关联的文件路径。无此需求的属性不增加该字段。 + +- [x] 加入失败测试：同一属性联合引用两份同名 Item，必须保留两个独立目标，并保持 A/B 到目标的绑定。 + +```javascript +test('同一属性的同名类型不覆盖，别名能定位真实目标', () => { + withFixture({ + 'index.ts': "import type { Item as A } from './a'; import type { Item as B } from './b'; export interface Spec { value: A | B }", + 'a.ts': 'export interface Item { a: string }', + 'b.ts': 'export interface Item { b: number }' + }, (c, item) => { + const doc = extractChart(c, item); + const value = doc.effectiveProperties.find(p => p.name === 'value'); + assert.equal(value.dependencies.length, 2); + const targets = value.dependencies.map(key => doc.complexTypeDefinitions[key]); + assert.equal(new Set(targets.map(t => t.filePath)).size, 2); + assert(targets.every(t => t.typeName === 'Item')); + const bindings = value.dependencyBindings; + assert.notEqual(bindings.A, bindings.B); + assert(doc.complexTypeDefinitions[bindings.A].filePath.endsWith('/a.ts')); + assert(doc.complexTypeDefinitions[bindings.B].filePath.endsWith('/b.ts')); + }); +}); +``` + +- [x] 运行此测试，记录修复前失败在依赖数量/身份上。 +- [x] 统一 AST 依赖、实例化依赖、跨属性合并、supplementalDetails 的身份规则；移除按短名称覆盖或拒绝合法同名类型的路径。 +- [x] 补正例：`A` 和 `B` 都导入同一个 `Item` 时只保留一个定义，但两个别名绑定均可解析。 +- [x] 补反例：两份 Item 分别出现在两个属性、嵌套 `Record`、以及补充声明的父类型中，都不得覆盖。 +- [x] 补反例：同一文件的两个命名空间分别定义 Item，两个限定引用必须保留独立目标，不能仅凭 filePath 相同而判为同符号。 +- [x] 在同一临时路径下重写 import/属性顺序并新建 Context，比较规范化导航键与目标集合；现有真实入口逆序抽取测试继续通过。跨临时路径的 hash 不要求相等，因为来源身份确实不同。 + +**完成条件：** 联合分支、跨属性与补充父类型能各自导航；同符号不重复；当前没有碰撞的导航键不发生无理由迁移。 + +## Task 3：人工详情不再绕过可达类型校验 + +**Files:** extract.mjs、skill-metadata.test.mjs；必要时调整 CLI 的抽取调用时机。 + +**内部接口：** `validateReachableDependencies(context, declaration, trace): void`。trace 记录图型/属性、类型链和出错符号位置。使用真实符号身份做访问缓存及循环处理；正在访问与已成功校验分别记录，失败不能被缓存为成功。 + +- [x] 加入失败测试：实际存在的人工详情目标不能隐藏另一文件中的缺失导入。 + +```javascript +test('人工详情不能掩盖传递缺失模块', () => { + withFixture({ + 'index.ts': "import type { Broken } from './middle'; export interface Spec { value: Broken }", + 'middle.ts': "import type { Missing } from './absent'; export type Broken = Missing;" + }, (c, item) => { + assert.throws(() => extractChart(c, item), /Missing|absent/); + }, { 'middle.ts#Broken': 'type-details/IData-Type-Definition.md' }); +}); +``` + +该现有详情文件只用来复现“映射后跳过检查”的行为，不作为合法 Broken 文档；测试在检查内容之前就必须拒绝未解析类型。 + +- [x] 跑测试确认修复前仍会成功抽取，导致 assert.throws 失败。 +- [x] 把校验入口放在属性类型处理和 isSimple 分类之前。相关声明无论使用人工详情、补充声明还是外部直接摘录，都遵守相同解析检查；文档展开仍保留原有边界。 +- [x] 沿类型节点、父类型、泛型约束/实参、被查询值的类型定位实际符号；导入别名即使模块存在但导出不存在，也必须拒绝。错误含相关属性、类型链、缺失模块/符号及源码位置。 +- [x] 补反例：中间声明 `import type { Missing } from './present'`，present.ts 只有 `export interface Other {}`；必须拒绝缺失导出，而非只看 unresolved 模块列表。 +- [x] 补正例：同一中间模块存在无关的缺失导入，但属性引用的类型为合法 `string`；必须通过。不得继续使用“属性声明所在文件存在任意 unresolved 就拒绝”的宽泛判断。 +- [x] 补正例：显式 `any`、`{ [key: string]: any }`、合法循环引用、合法人工详情映射均通过；当前 pictogram 开放标记保持。 +- [x] 补 CLI 反例：复制维护工具到带临时入口清单的隔离测试仓库骨架，依赖使用已有路径；使用上述 Broken 夹具运行实际 generate。验证非零退出、诊断包含类型链、预先存在的哨兵文件内容不变、没有部分新元数据。不得为测试改真实 metadata-sources.json。 + +CLI 夹具骨架明确包含：当前 skill-metadata.mjs 与 extract.mjs 的原目录结构、两个包的 package.json、核心 tsconfig.json、指向已有核心 node_modules 的符号链接、临时 index.ts/middle.ts、仅 fixture 入口的 metadata-sources.json 和现有 IData 详情副本。临时 `.git` 指向 `git rev-parse --absolute-git-dir` 得到的实际 Git 目录，CLI 只执行 git log，不在夹具中执行任何 Git 写操作；这样无需提交夹具或安装依赖。 + +以下断言加入该 CLI 测试，`fixtureRoot` 为上述临时骨架，`output` 为其中的独立输出目录，两者在 finally 删除： + +```javascript +fs.mkdirSync(output, { recursive: true }); +fs.writeFileSync(path.join(output, 'sentinel.txt'), 'keep'); +const result = spawnSync(process.execPath, [ + path.join(fixtureRoot, 'packages/vchart/scripts/skill-metadata.mjs'), + 'generate', '--output', output +], { encoding: 'utf8' }); +assert.notEqual(result.status, 0); +assert.match(result.stderr, /Missing|absent/); +assert.match(result.stderr, /value/); +assert.equal(fs.readFileSync(path.join(output, 'sentinel.txt'), 'utf8'), 'keep'); +assert.deepEqual(fs.readdirSync(output), ['sentinel.txt']); +``` + +**完成条件：** 校验由真实类型链决定，人工文档不影响判断；相关错误被拒绝，无关模块缺失不阻断，抽取失败不写产物。 + +## Task 4：补齐 typeof 的真实值声明与导航 + +**Files:** extract.mjs、skill-metadata.test.mjs、生成的补充声明。 + +- [x] 更新测试导入以使用现有 `supplementalDetails`，加入失败测试：类型别名引用本地枚举时，补充详情必须同时包含枚举及别名到枚举的链接。 + +```javascript +test('typeof 枚举在补充声明中有真实定义和导航', () => { + withFixture({ + 'index.ts': "enum AxisDirection { horizontal = 'horizontal', vertical = 'vertical' }; type Direction = keyof typeof AxisDirection; export interface Spec { config: { direction: Direction } }" + }, (c, item) => { + extractChart(c, item); + const details = supplementalDetails(c); + const alias = [...c.definitions.values()].find(d => d.symbol.name === 'Direction'); + const enumeration = [...c.definitions.values()].find(d => d.symbol.name === 'AxisDirection'); + assert(alias); + assert(enumeration); + assert(details.includes('horizontal')); + assert(details.includes('vertical')); + const start = details.indexOf(`id="${alias.anchor}"`); + const end = details.indexOf('`。 +- [x] dependencies 从 TS 类型节点/符号提取；排除字符串字面量、括号、内联对象及注释，正确处理 `TreemapOptions['gapWidth']` 等索引访问。不能用字符串切割产生 `(IStateAnimateSpec`。 +- [x] 同名类型按定义模块区分 reference。不能因短类型名相同而覆盖另一模块的详情；保留已有有效文件名，只对实际碰撞的新入口使用带模块含义的名称。 +- [x] 根契约显式 any（如当前 pictogram）不做猜测式展开，保留开放标记，提供其明确的系列定义及转换器说明；不改公开接口、不宣称闭合枚举已经完整。 +- [x] 四个入口通过后再重建其余已有入口。每批核对新增/删除属性、版本变化、文件大小和人工描述保留情况，不将 442 个差异直接批量当作缺失字段修补。 + +必须包含的真实契约测试： + +```typescript +// TypeScript 编译应拒绝前两项，接受后三项。 +const badDirection: Pick = { direction: 'reverse' }; +const badAnimation: Pick = { animationAppear: 'grow' }; +const horizontal: Pick = { direction: 'horizontal' }; +const grow: Pick = { animationAppear: { preset: 'grow' } }; +const disabled: Pick = { animationAppear: false }; +``` + +测试还需对照 checker 的实际 symbol/type 验证：rangeArea 的 xField/yField/label 存在；radar 的 categoryField/valueField 存在；bar 的动画及 progressive 属性存在；同名播放器 DirectionType 仍为 default/reverse；单独系列允许的 data/tooltip 与 IChartExtendsSeriesSpec 的 Omit 边界不能混淆。不能只断言生成 JSON 出现某段固定文字。 + +## Task 3：修复详情内容和有效导航 + +**输入：** 真实类型依赖、已有 77 份详情、源码与运行证据。 +**输出：** 可查询的详情入口和正确示例，不覆盖有效人工知识。 + +- [x] 修正 IData 详情：values 字符串表示 CSV/TSV 等内容，不自动 fetch URL；移除矛盾的 IData 单一数组重定义。远程请求由 HTML/宿主代码处理，纯 spec 场景保留数据绑定契约。 +- [x] 将错误 CSV 示例改为真实 CSV 文本；另以明确的应用加载示例说明 `await fetch(url).then(r => r.text())` 后传文本与 parser。不要把函数或 fetch 嵌入 JSON spec。 +- [x] IAnimationConfig 仍作为图元级动画类型保留，并链接系列 IAnimationSpec/IStateAnimateSpec/IMarkAnimateSpec 的真实定义，解释两个层级；不把现有文件整体替换成另一种同名概念。 +- [x] 重新定位 IAnimationConfig、SunburstLabelConfig、ILiquidOutlineSpec 等错误来源；每个 recorded source symbol 必须能在其文件或准确的再导出链中找到。 +- [x] 对从公开配置可达的复杂属性逐一提供有效 reference：复用既有详情；仅为没有可用入口的必要类型补短的声明摘录和继承链接，不复制完整外部依赖手册。至少处理 ICommonAxisSpec、ICrosshairSpec、IBarBackgroundSpec、ITickMaskSpec 与当前 series 依赖。 +- [x] 系列定义不能直接映射到删掉 data/tooltip/morph 的图表展开块后声称等价；需要系列级完整契约时提供对应真实声明和有效父类型导航。 +- [x] 对外部类型无法完整展开的边界标注所属包/版本和适用范围；用户常用属性仍需在打包技能内有足够说明，不能只提供本地源码路径。 +- [x] 保留 ICartesianAxisSpec 已有 hideWhenEmpty 说明、ILabelSpec 正确 formatMethod 签名等有效补充。声明摘录可设明确的维护区块，人工正文不参与自动覆盖。 + +验收重点：检索一次复杂属性后能找到可用定义/说明，不存在非法依赖名、错误 source symbol、缺失目标文件或个人绝对路径；声明开放/外部边界允许明确记录，不允许“全部完整”的虚假结论。 + +## Task 4：补齐既有索引覆盖，稳定生成与检查 + +**输入：** 正确的提取器、来源清单与详情导航。 +**输出：** 现有入口完整覆盖、稳定生成命令和维护说明。 + +- [x] 为已存在 topkey 的 6 个 3D 图型生成对应 type-meta，使用实际扩展类型和核心类型导入；记录扩展版本、注册入口及适用宿主前提。 +- [x] 补 pictogram 的 topkey，使已有类型入口可查询；沿用当前扩展实现，不能复活旧核心包定义。 +- [x] 核对所有 topkey 的 key 与真实配置路径。组合图 common 中 bar/line 等系列属性标明 series 作用域，不能要求它们都是 common 根属性；all_common 是共享索引，不算独立图型。 +- [x] 保留有效 oneDesc 意图说明。TS JSDoc 可提供事实依据，但不自动将全部描述替换成机械属性名；删除或变更旧 key 必须有真实契约依据。 +- [x] CLI generate 先生成到临时输出目录，审查后写入；check 按相同输入重建并比较已提交产物，仅报告漂移，不修改工作区。生成顺序固定，不更新时间戳。 +- [x] 生成来源清单外的孤立文件报告为待审查，不自动删除；新文件名沿用既有大小写惯例。 +- [x] README 记录维护命令、依赖准备与版本边界；SKILL.md 仅补充按 reference 找详情及遇到来源版本不符时查询目标版本资料，不改变交付选择。 + +命令契约： + +```sh +node packages/vchart/scripts/skill-metadata.mjs generate --output /tmp/vchart-metadata-generated +node packages/vchart/scripts/skill-metadata.mjs generate --write +node packages/vchart/scripts/skill-metadata.mjs check +``` + +连续两次 generate 对相同输入逐字节相同，check 后 git 状态不变。只改计划/教程再运行 check 也不能导致所有元数据因全局 HEAD 变化而漂移。 + +## Task 5：语义验收和原场景回归 + +**输入：** 冻结版与修复版技能、真实请求、当前运行环境。 +**输出：** 来源/结构、配置语义、实际渲染分层记录。 + +- [x] 运行 node:test 的提取、模块碰撞、继承、泛型、详情导航、稳定输出及只读 check 测试；按实际输入类型对照，不引入通用用户 spec 验证器。 +- [x] 关键任务从独立上下文读取技能，输入只包含实际需求和必要数据，不给预期答案或疑似错误。若委派不可用，记录为当前上下文检查，不冒充独立测试。 +- [x] 下表每项先执行一次；明确复现失败后修复并重复相同任务。少量样本只证明这些边界，不统计成功率。浏览器检查实际交付产物，不能手工修正后算技能通过。 + +| ID | 请求与输入 | 验收 | +| --- | --- | --- | +| M01 | 周一12、周二25、周三18、周四32，生成水平柱图完整 JSON | direction 合法，字段绑定和数据完整；浏览器确认四根水平柱 | +| M02 | 同一周数据柱图，入场使用 grow 预设，只要完整 spec | 使用合法动画配置，未用动画名字符串替代整个属性；实际渲染 | +| M03 | 同一数据，关闭入场动画，保留其余配置与 JSON | false 合法，完整产物和数据保留 | +| M04 | 周一 low=3/high=8、周二5/11、周三4/9，生成区间面积图 JSON | 区间字段和三条记录完整，不错误拒绝合法字段；实际面积及范围正确 | +| M05 | 速度70、力量60、耐力80，生成雷达图 JSON | 类别/数值字段、三条数据正确；实际三维度图元/轴可核对 | +| M06 | CSV 文本 `day,value\n周一,12\n周二,25`，生成 HTML | parser 解析文本并绘制两条真实数据，无虚构网络加载 | +| M07 | 从测试提供的本地 CSV URL 加载并绘图，生成 HTML | 实际发起本地请求、拿到同一 CSV 后绘制；不请求 example.com 或外部业务系统 | +| M08 | 周数据 JS spec，标签显示星期和数值 | formatMethod 正确签名，渲染四条实际标签，未因详情修复退化 | +| M09 | 先生成带点击结果区、无标签的 HTML，再要求“修改其中 spec，加标签” | 第二轮仍完整 HTML，数据、真实点击保留，数值标签出现 | +| M10 | 宿主只接收 JSON；在完整配置上加标签 | 仍是完整 JSON，未强制 HTML/实例代码 | +| M11 | 宿主已注册扩展及对应 3D 能力，要求 bar3d 完整 JSON | 使用实际扩展字段及正确 type，不混入注册代码；说明检查环境，不把核心 2D 渲染当成 3D 通过 | + +- [x] 冻结版至少复用 M01/M02/M06 作真实对照；元数据错误已确认但行为可能正确，照实记录。M11 的运行验收仅在真实扩展环境执行，无法执行则明确未渲染；六个扩展类型的来源和字段对照仍必须完成。 +- [x] 补本地 CSV fixture 服务及可复现浏览器验收材料，放在维护测试目录或临时输出，不能将测试 URL/数据变成技能默认业务数据。 +- [x] 运行既有 Python 转义单测、skill-creator 结构检查、相对文件导航检查与 git diff --check，确认上轮 HTML/spec 行为未受影响。 +- [x] 保存独立验收文档，分别记录元数据准确性、详情内容检查、实际渲染、宿主/React 未验证范围；未全量审阅 77 份详情语义时不得宣称全部无误。 +- [ ] 后续提交 PR 前运行仓库官方 develop 全量视觉比较并审查报告。本轮未创建 PR，图库/生成器/模板未变，未重跑全量；此项保留为未来 PR 的前置要求。执行错误解决或如实登记阻断，不把先前 266 passed 记录当成本轮新运行。 + +## 风险与处理 + +| 风险 | 处理 | +| --- | --- | +| 当前源码与遗留 d.ts/安装包混用 | 单一来源清单、明确 package resolution、版本及输入指纹；解析错误阻止写入 | +| checker 的 any 掩盖未解析模块 | 区分公开声明显式 any 与模块失败导致 any；后者失败，前者明确开放范围 | +| 泛型/联合展开破坏真实语义 | 保留实际声明及实例化类型，按分支处理，关键合法/非法配置双向测试 | +| 生成工具自证正确 | 对照真实 TS 接口、修复前错误和浏览器产物，不只比较两次生成器输出 | +| 自动重写覆盖人工说明 | 仅维护声明区块、导航和已证实错误；保留有效补充，按文件审查差异 | +| 类型详情无限扩张 | 只补可达公开配置所需入口，复用现有说明，外部依赖不复制全手册；记录体积变化 | +| 3D 元数据存在被理解成任意宿主可运行 | 明确扩展及注册前提，纯 spec 与应用代码分离，不将类型检查记为宿主运行通过 | + +## 完成条件 + +- [x] 已确认方向、动画、关键继承缺失和 CSV 示例错误修复，具有真实类型/运行证据。 +- [x] 既有 30 个元数据入口及 6 个已有 3D 索引入口均有准确来源；pictogram 来源已迁移，索引补齐；开放契约不假装闭合。 +- [x] 可达复杂类型导航有效，无非法依赖、错误定位、个人绝对路径；版本及内容指纹可核对。 +- [x] 同输入生成稳定，check 只读，改动无关文档不制造元数据漂移。 +- [x] HTML/spec 原交付规则保持，关键行为及已知验收限制有独立记录。 +- [x] 用户生成流程不新增 schema、编译依赖、固定澄清或审批流程。 + +## 深度交互 + +本期目标是“知识源准确且可维护”，不是“把所有公开类型都复制成更大的知识库”。静态类型不能证明数据口径和实际效果正确，人工说明也不能替代真实类型来源。小型维护工具、按需详情和真实行为检查共同承担各自职责，避免用更多提示词掩盖错误元数据。 + +## 执行中发现的契约边界 + +bar3d 的公开类型继承二维 bar 字段，未声明仓库示例及真实运行使用的 bar3d.style。按本期不改公开接口的约束，新增 contractNotes 明确记录实际文档来源及样式示例，不伪造类型属性；真实共享扩展环境的四个 rect3d 已验证。公开类型修正应另行处理。 diff --git a/docs/superpowers/plans/2026-10-16-vchart-skill-metadata-distribution.md b/docs/superpowers/plans/2026-10-16-vchart-skill-metadata-distribution.md new file mode 100644 index 0000000000..7f80ddaa13 --- /dev/null +++ b/docs/superpowers/plans/2026-10-16-vchart-skill-metadata-distribution.md @@ -0,0 +1,272 @@ +# VChart 技能元数据分发精简实施计划 + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [x]`) syntax for tracking. +> +> 上述技能不可用时，在当前会话顺序执行，不安装额外技能、不创建其他聊天。任务默认顺序执行；用户随后明确授权整理并本地提交，未授权推送或创建 PR。用户于 2026-10-16 授权执行，实施和本轮验收已完成；结果见 [验收记录](../validation/2026-10-16-vchart-skill-metadata-distribution.md)。 + +**Goal:** 从技能分发元数据中移除源码追踪、继承过程与重复信息，同时完整保留生成有效 VChart 配置所需的类型、说明、版本边界和依赖导航。 + +**Architecture:** 保留现有 TypeScript 抽取结果作为维护工具的内部模型，增加一个明确的分发投影函数。`generate/check/audit` 共享该投影契约；技能只消费精简 JSON，源码定位、完整继承关系与内容指纹由仓库工具继续管理。 + +**Tech Stack:** Node.js 22、仓库已有 TypeScript、`node:test`、既有 Playwright 验证器与 Python 标准库；不新增运行时依赖、JSON Schema、模型调用框架或配置平台。 + +## 全局约束 + +- 用户已授权执行本计划并追加授权整理、本地提交；不扩展到推送、发布或其他技能整理。 +- 不修改 VChart/VRender 运行时、公开类型、图表生命周期、HTML 模板或 HTML 生成器。 +- 保留已有 HTML/spec、诊断、视觉还原、React 交付规则，仅更新元数据读取说明。 +- 不为历史内部元数据结构维护双格式读取分支；新产物统一使用 `formatVersion: 3`。 +- 保留源码抽取、符号身份、别名绑定、映射类型、未解析依赖报错和确定性生成机制。 +- 不通过缩减依赖、删除图型、截断类型或重写描述来追求体积指标。 +- `since` 保留原始文本；它可能包含“某版本支持百分比字符串”，不能当作纯 semver。 +- 保留前序已完成的 evals 迁移及文档改动，不重置、覆盖；按本次用户授权一并提交。 +- Python 生成器单元测试迁移、README 使用说明整体去重、人工类型详情精简不属于本计划。 +- Node.js 必须为 22；当前 shell 默认是 v24.19.0，本机已有 `/Users/bytedance/.nvm/versions/node/v22.23.3/bin`。命令中的临时目录须每次创建，不覆盖旧验收材料。 +- 本期不创建 PR；未来提交 PR 前仍必须按仓库要求执行全量视觉回归，无法执行时如实记录。 + +## 执行中的有据调整 + +实际测试发现旧来源清单的 sequence 核心入口已不存在，故迁移后按真实扩展入口修正来源及注册前提。当前源码也已将 dot/link 迁出核心，已安装的 VRender/VDataset 版本较旧资料更新。因此，重新生成时同步了 `common.series`、相关补充声明及外部版本来源。其他属性、导航和人工知识保持不变；未为保持旧文件而回填已失效契约。 + +用 HEAD 原版抽取器和本轮抽取器对同一当前源码、修正后的清单及已安装依赖作完整对照，36 个内部模型和生成补充声明均相等。下述“与基线不变”验收以此当前来源对照为准；对旧已提交资料的例外和证据详见验收记录。 + +## 一、现状与方案选择 + +当前 36 份 type-meta 共 3,507,786 bytes；`bar.json` 为 119,080 bytes、3,151 行。最终有效属性共 2,601 项，其 `category` 全部为“未分类”。继承节点与最终属性重复携带类型、描述和源码信息。 + +| 方案 | 收益与代价 | 决策 | +| --- | --- | --- | +| 仅删除 `source/inheritedFrom` | 改动小，但重复继承属性和维护字段继续随技能分发 | 不选 | +| 保留内部抽取模型，增加精简分发投影 | 保留既有维护能力，明确使用侧契约，一次解决重复与维护信息泄漏 | 采用 | +| 重写抽取器和整个参考文档体系 | 涉及符号解析及人工知识迁移，风险超出本次目标 | 不选 | + +按候选字段投影的静态测算，JSON 可降至约 1.24 MB，减少约 65%。这是测算而非已验证结果，不作为删减有效知识的理由；最终记录实际字节和变化来源。 + +## 二、分发字段契约 + +### 顶层 + +| 处理 | 字段 | +| --- | --- | +| 保留 | `typeName`、`formatVersion`、`effectiveProperties`、`complexTypeDefinitions`、`vchartVersion` | +| 有则保留 | `extensionVersion`、`registration`、`registrationNote`、`initializationIncludes`、`openContract` | +| 有则投影 | `contractNotes` 仅保留 `description/example`，维护用 `sourceFile` 留在内部模型 | +| 不分发 | `inheritanceTree`、`statistics`、`sourceFile`、`sourceHash`、`sourceRevision`、`typescriptVersion`、固定的 `version`、自动拼接的顶层 `description` | + +`formatVersion` 固定为 3；`vchartVersion/extensionVersion` 继续说明知识来源版本，不暗示所有历史版本均兼容。 + +### 最终属性 + +| 处理 | 字段 | +| --- | --- | +| 保留 | `name`、`description`、`type`、`required`、`isSimple`、`dependencies` | +| 有则保留 | `defaultValue`、`since`、`deprecated`、`literalValues`、`dependencyBindings` | +| 不分发 | `source`、`inheritedFrom`、`category`、`originalType` | + +`type` 保留当前图型上下文解析后的完整类型，不改写泛型参数、联合类型或可选性。`dependencies/dependencyBindings` 继续承接类型导航；移除源码原始类型拼写不能改变别名映射。 + +### 依赖定义 + +保留 `typeName/reference` 及存在时的外部依赖 `package/version`；不分发 `filePath`。同名类型仍按现有符号身份生成不同导航键，不能因移除路径就按短类型名合并。 + +## 三、文件与职责 + +| 文件 | 操作与职责 | +| --- | --- | +| `packages/vchart/scripts/skill-metadata/distribution.mjs` | 新增：纯函数 `toDistributedMetadata(metadata)`，仅负责完整模型到分发模型的投影 | +| `packages/vchart/scripts/skill-metadata/distribution.test.mjs` | 新增：投影语义、字段白名单、false/空值保留、别名导航与不修改输入的测试 | +| `packages/vchart/scripts/skill-metadata.mjs` | 修改：生成及比较精简产物；增加 `audit --report` 的维护来源摘要 | +| `packages/vchart/scripts/skill-metadata/extract.mjs` | 修改：审计精简产物；内部抽取和补充详情输出保持原有语义 | +| `packages/vchart/scripts/skill-metadata.test.mjs` | 修改：区分内部抽取测试与分发产物审计测试；补真实图型投影回归 | +| `packages/vchart/scripts/skill-metadata/metadata-sources.json` | 从技能 references 原样迁入，作为仓库维护输入 | +| `skills/vchart-development-assistant/references/type-meta/*.json` | 重新生成全部 36 份，统一格式 3 | +| `skills/vchart-development-assistant/SKILL.md` | 删除继承树与源码字段的消费说明，明确只查询最终属性和依赖 reference | +| `skills/vchart-development-assistant/README.md` | 将“知识库维护”整节移至仓库维护说明；保留用户使用说明 | +| `docs/skills/vchart-development-assistant-maintenance.md` | 新增：来源清单位置、字段契约、生成/审计命令及维护报告说明 | +| `docs/superpowers/validation/2026-10-14-vchart-skill-metadata-quality.md` | 只更新已移动来源清单的链接，不改写历史验收结果 | +| `docs/superpowers/validation/2026-10-16-vchart-skill-metadata-distribution.md` | 实施时新增：实际基线、语义对比、体积、命令结果与阻断 | + +其他历史计划中的旧路径是当时的实施记录，不批量改写。当前操作说明和可点击资源链接必须指向真实位置。 + +## 四、实施任务 + +### Task 1：固定基线并实现纯投影函数 + +**输入：** 当前工作区的 36 份 JSON、完整抽取模型。 + +**产出接口：** `toDistributedMetadata(metadata): object`，不读文件、不修改输入、不解析 TypeScript。 + +- [x] 用 Node 22 创建仓库外临时目录，复制当前 type-meta、topkey、人工 type-details 和生成补充详情，并登记实际 Git SHA、未提交改动与字节总量。 + +```sh +export PATH="/Users/bytedance/.nvm/versions/node/v22.23.3/bin:$PATH" +node --version +metadata_baseline_dir=$(mktemp -d /tmp/vchart-metadata-distribution.XXXXXX) +cp -R skills/vchart-development-assistant/references "$metadata_baseline_dir/references" +git rev-parse HEAD +git status --short +``` + +- [x] 先在 `distribution.test.mjs` 建立投影语义测试。最小输入同时包含本次保留与移除字段，使用值级断言而不是匹配生成文本。 + +```js +const raw = { + typeName: 'Spec', formatVersion: 2, vchartVersion: '2.1.7', + sourceHash: 'maintenance-only', inheritanceTree: {}, + effectiveProperties: [{ + name: 'enabled', description: '是否启用', type: 'boolean | undefined', + originalType: 'boolean', required: false, isSimple: true, + dependencies: [], defaultValue: false, + since: '1.11.2 支持百分比字符串', deprecated: false, + source: 'packages/example.ts', inheritedFrom: 'Spec', category: '未分类' + }], + complexTypeDefinitions: {} +}; +const before = structuredClone(raw); +const published = toDistributedMetadata(raw); +assert.equal(published.formatVersion, 3); +assert.deepEqual(published.effectiveProperties[0], { + name: 'enabled', description: '是否启用', type: 'boolean | undefined', + required: false, isSimple: true, dependencies: [], defaultValue: false, + since: '1.11.2 支持百分比字符串', deprecated: false +}); +assert.deepEqual(raw, before); +``` + +- [x] 运行 `node --test packages/vchart/scripts/skill-metadata/distribution.test.mjs`，确认首次失败来自缺失投影能力，再实现按字段白名单构造输出。可选字段按是否存在保留，不使用真值过滤；无合法值不新增默认值或兜底。 +- [x] 测试覆盖：外部包版本保留、同名定义不同 reference、别名绑定、`contractNotes.example` 不变、非分发字段不泄漏、重复调用结果一致。 +- [x] 重新运行投影测试。预期全通过，输入不变，导航键和 reference 不变。 + +### Task 2：让生成、审计与检查使用同一分发契约 + +**输入：** `extractChart(context, source)` 的完整模型与 Task 1 的投影函数。 + +**产出：** `generate/check` 生成格式 3；`auditReferences` 检查格式 3，同时继续使用完整抽取结果提供诊断来源。 + +- [x] `buildArtifacts` 统一通过投影生成 JSON，保持原有完整抽取成功后才写文件的行为。 + +```js +const metadata = extractChart(context, source); +files.set( + `type-meta/${source.chart}.json`, + JSON.stringify(toDistributedMetadata(metadata), null, 2) + '\n' +); +``` + +- [x] 更新审计：每个图型分别持有 `expectedRaw` 与 `expected = toDistributedMetadata(expectedRaw)`；仅从 `actual.effectiveProperties` 读取发布属性，删除回退读取 `inheritanceTree` 的分支。 +- [x] 审计保留原有属性存在性、解析类型、required、依赖集合、别名绑定、topkey 作用域、reference 目标和锚点检查；新增格式 3、字段白名单、扩展注册约束及其他保留值检查。`sourceFile/filePath` 不再是发布产物必需字段。 +- [x] 审计属性错误的来源从 `expectedRaw.effectiveProperties` 查找；定义正确性以投影后的导航键、`typeName/reference/package/version` 核对，不能只检查目标文件存在。 +- [x] `audit --report` 在现有报告上增加 `provenance`：`vchartVersion`、`extensionVersion`、`typescriptVersion`、`sourceHash`、`sourceRevision`。报告写入显式输出路径，不在技能中创建另一份维护清单。 +- [x] 为实际分发模型补充反例：缺 `required`、替换合法方向枚举、篡改 reference、交换同名别名目标、丢弃注册前提、遗留非分发字段均被拒绝；合法模型无需源码路径也能通过。 + +```js +const full = metadata('bar'); +const published = toDistributedMetadata(full); +const wrong = structuredClone(published); +wrong.effectiveProperties.find(p => p.name === 'direction').type = "'default' | 'reverse'"; +const report = auditReferences(context, [source('bar')], references, new Map([['bar', wrong]])); +assert(report.errors.some(e => e.code === 'TYPE_MISMATCH' && e.property === 'direction')); +``` + +- [x] 内部抽取测试仍可断言 `inheritanceTree/filePath/originalType`；分发审计测试传入投影对象。不要为了让测试通过删掉同名符号、Omit、循环依赖、泛型或未解析导入的反例。 +- [x] 更新隔离 CLI 夹具：复制新增 `distribution.mjs`，后续还须复制 Task 3 迁移后的清单路径；保留“传递依赖失败时无部分输出”的反例。 +- [x] 执行针对投影和分发审计的测试。此阶段旧已提交 JSON 与格式 3 不一致属于待重生成状态；Task 4 完成后再登记完整 `check` 通过。 + +### Task 3：迁移维护入口并更新技能消费说明 + +**输入：** 完整来源清单、现有 CLI/测试夹具、技能读取说明。 + +**产出：** 分发目录不再含元数据维护清单；工具和文档均使用新契约。 + +- [x] 将 `references/metadata-sources.json` 原样迁至 `packages/vchart/scripts/skill-metadata/metadata-sources.json`。修改 CLI 和测试的读取位置；其中 `sourceFile` 仍按仓库根解析，`detailReferences` 仍按 references 根解析，不改清单内容。 +- [x] 修改 CLI 失败夹具中的清单写入位置。用迁移前字节比较，确认除 sequence 必要修正外的 35 个入口和 74 个人工详情映射没有变化；sequence 的扩展约束按真实源码补齐。 +- [x] 修改 `SKILL.md`：说明 `effectiveProperties` 是当前图型最终属性；复杂类型经 `dependencies/dependencyBindings` 到 `complexTypeDefinitions.reference` 查询。移除“读取继承树/源码路径”的要求，保留版本与开放契约说明。 +- [x] 将 README 的“知识库维护”章节搬入 `docs/skills/vchart-development-assistant-maintenance.md`，补全新路径、格式 3 和维护报告位置；README 保留用户使用内容，不让普通生成流程要求仓库依赖或维护命令。 +- [x] 更新历史验收文档中来源清单的可点击链接；检索活跃工具和使用文档，保证没有旧清单路径、旧继承树消费要求或漏更新的夹具。 + +```sh +rg -n 'metadata-sources\.json|inheritanceTree|originalType|sourceFile' \ + packages/vchart/scripts/skill-metadata.mjs \ + packages/vchart/scripts/skill-metadata.test.mjs \ + packages/vchart/scripts/skill-metadata \ + skills/vchart-development-assistant/SKILL.md \ + skills/vchart-development-assistant/README.md \ + skills/vchart-development-assistant/workflows \ + docs/skills/vchart-development-assistant-maintenance.md +``` + +检索到内部抽取、维护说明和测试中的源码字段是正常的，不能机械删除；技能消费说明不得依赖被移除字段。 + +### Task 4：重生成并证明配置知识和导航未退化 + +**输入：** 基线副本、新生成器与维护入口。 + +**产出：** 36 份格式 3 JSON，保留值与基线一致，候选通过后才更新工作区。 + +- [x] 先生成候选目录，运行真实审计；必要时通过 `audit --references` 建立包含候选 type-meta 和现有详情/topkey 的临时 references 副本，不把仅含 type-meta 的目录冒充完整知识库。 + +```sh +metadata_candidate_dir=$(mktemp -d /tmp/vchart-metadata-candidate.XXXXXX) +node packages/vchart/scripts/skill-metadata.mjs generate --output "$metadata_candidate_dir" +``` + +- [x] 对基线与候选逐图型、逐属性比较：属性名字集合、`description/type/required/isSimple/defaultValue/since/deprecated/literalValues/dependencies/dependencyBindings` 均不变；定义的导航键、`typeName/reference/package/version` 不变；注册、版本和行为说明不变。不得用字段数量相同代替值级比较。 +- [x] 检查所有 reference 文件与锚点存在，并实际沿“方向枚举、动画泛型、标签回调、同名别名、嵌套泛型”查到对应声明。保留内部 Omit 测试，确认顶层最终属性与完整系列定义没有混淆。 +- [x] 比较基线副本：topkey、人工 type-details 不变；`AdditionalTypes-Type-Definition.md` 与旧资料的差异已逐节核对，限于迁出核心的类型及外部版本来源同步；与 HEAD 抽取器在当前源码的输出逐字节相等。 +- [x] 候选检查通过后执行 `generate --write`，再执行完整工具测试、`audit/check` 和第二次 `check`，记录零漂移。 + +```sh +node packages/vchart/scripts/skill-metadata.mjs generate --write +node --test packages/vchart/scripts/skill-metadata/distribution.test.mjs packages/vchart/scripts/skill-metadata.test.mjs +node packages/vchart/scripts/skill-metadata.mjs audit --report "$metadata_candidate_dir/audit.json" +node packages/vchart/scripts/skill-metadata.mjs check +node packages/vchart/scripts/skill-metadata.mjs check +git diff --check +``` + +- [x] 记录实际总字节、每图型字节和缩减率。预期约减少 65%；若明显偏离，说明字段/缩进差异，不删有效内容或放宽语义断言。 + +### Task 5：验证技能消费并登记验收 + +**输入：** 精简技能、现有仓库级行为任务、真实渲染验证工具。 + +**产出：** 语义回归、实际使用验证及限制清晰的验收记录。 + +- [x] 使用现有 Agent 执行能力按独立上下文顺序执行下列请求，不预先提供正确配置；只提供技能路径、真实请求和输出位置。未具备独立执行能力时记录未执行，不用手写 spec 代替 Agent 行为通过，也不建设新框架。 + +| 任务 | 原始请求 | 检查 | +| --- | --- | --- | +| 水平柱图 | “周一 12、周二 25、周三 18、周四 32。用 VChart 水平柱图比较，返回完整 JSON spec。” | 四条数据不变，方向及字段合法，实际柱图方向正确 | +| 标签回调 | 复用仓库级 `evals/vchart-development-assistant/generation-scenarios.md` 的 G14 原始请求 | 实际查询标签签名，JS 函数保留，四个标签与高低条件正确 | +| HTML 生成 | 复用 G02 原始请求 | 继续输出完整 HTML，有真实数据图元，未因知识格式调整改变交付目标 | + +- [x] 对实际 JSON/HTML/JS 产物解析并渲染；复用 `verify-examples.mjs` 的 `m01` 柱图入口及既有页面验证能力。验证器不覆盖标签条件的部分须检查实际文本，不能仅凭出现 canvas 或截图报通过。 + +```sh +node packages/vchart/scripts/skill-metadata/verify-examples.mjs --artifacts /tmp/vchart-distribution-artifacts --case m01 +``` + +上述 `/tmp/vchart-distribution-artifacts` 是本次实际产物目录示例，执行时使用本次创建并登记的目录。验证器缺产物会返回 `not_run`，必须检查每项状态，不能仅看进程退出码。 + +- [x] 扩展注册与开放契约通过真实元数据投影及反例验证；未新建 3D 产物或未运行 3D 环境时明确记录范围，不复用旧报告冒充本次实测。 +- [x] 此变更不涉及图库渲染实现，本轮验证以元数据语义、导航及代表性实际产物为主，不冒称全量视觉通过。提交 PR 前按仓库要求执行 `node packages/vchart/scripts/visual-test.mjs` 并审查差异及执行错误。 +- [x] 在本次 validation 文档记录 Git 状态、Node 版本、基线/产物目录、字段对比、实际体积、全部命令结果、Agent 任务与浏览器证据及未执行项。 + +## 五、完成标准 + +- [x] 技能目录不再分发来源清单；全部 36 份 type-meta 为格式 3，只有本计划允许的字段。 +- [x] 最终属性、解析类型、必需性、说明、默认值、版本说明、弃用提示和依赖导航与当前来源对照保持一致；旧资料的必要同步已单独登记。 +- [x] 分发产物无需源码路径即可通过审计；维护错误仍能指出实际源码位置。 +- [x] 同名、别名、泛型、循环依赖与缺失导入反例仍生效；错误输入不会生成部分产物。 +- [x] Node 22 下投影测试、完整维护工具测试、真实 CLI `audit/check` 通过；二次检查无漂移。 +- [x] topkey、人工详情不变；补充声明仅接受已核实的资料同步，技能交付规则保持不变。 +- [x] 行为验证和渲染范围如实记录；阻断、`not_run`、未运行全量视觉不能登记为通过。 +- [x] 只有本计划和前序 evals 迁移范围内的预期改动，无自动提交、发布或全局技能同步。 + +## 六、风险与回退 + +主要风险是投影时丢失合法 false/可选字段、移除来源后破坏同名类型身份，以及审计仍依赖旧结构。以保留字段值级比较、独立导航反例和真实 CLI 检查分别约束。 + +若原始类型拼写中的信息确实无法通过 `type + dependencies + reference` 找回，应先修复导航或解析契约；只有存在具体必要信息缺失的证据时，才讨论增加最小消费字段，不恢复整份维护结构。 + +回退以 Task 1 的工作区基线副本为准，只恢复本次修改的生成工具、消费说明与 type-meta；保留前序 evals 迁移和用户其他修改。不得使用 `git reset --hard` 或覆盖整个工作区。 diff --git a/docs/superpowers/validation/2026-10-14-vchart-delivery-context-and-diagnostic-data.md b/docs/superpowers/validation/2026-10-14-vchart-delivery-context-and-diagnostic-data.md new file mode 100644 index 0000000000..fc522c87a9 --- /dev/null +++ b/docs/superpowers/validation/2026-10-14-vchart-delivery-context-and-diagnostic-data.md @@ -0,0 +1,56 @@ +# VChart 交付上下文与诊断数据专项验收 + +日期：2026-10-14。对应 [专项计划](../plans/2026-10-14-vchart-delivery-context-and-diagnostic-data.md) 和 [技能入口](../../../skills/vchart-development-assistant/SKILL.md)。本轮基于上一轮未提交优化继续修改，仅调整技能规则、教程和评估文档；未提交、创建 PR、发布或同步全局安装副本。 + +## 修复范围 + +- 主文件明确：本轮要求优先，其次保持既有产物；只有目标尚未确定时才按任务识别。已有 spec 是输入，不能单独触发产物切换。 +- 修改 HTML 内的 spec 继续交付完整 HTML；组件和组合交付保留原目标；明确“只返回 JSON”仍可切换。共享生成和诊断输出入口均引用主规则，README、中英文教程同步。 +- 描述诊断先复用真实数据、字段、单位和绑定；移除无条件 mock 与固定样本条数。缺少必要信息时澄清，绑定不可访问时保留契约并说明限制。 +- 明确允许的教学演示仍可使用标注的 mock；诊断示例注明其教学前提，不能将其报告为原业务根因已定位或修复。 +- 未改图库运行时、生成器、模板、React 实现；未引入 schema、依赖或新增技能场景。 + +## 环境与方法 + +- HEAD：`6fff2041c1a060800791f3c3d6212bb3812b504b`。修复前快照来自当时完整工作区技能，位置 `/var/folders/p6/3_mdjbzd59n9q8rgt0s6h5240000gn/T/vchart-review-before-lw59icc9/vchart-development-assistant`，未用优化前 HEAD 冒充对照。 +- Node.js `v22.23.3`，Playwright Chromium `153.0.8010.12`。本轮实际渲染的新版产物使用 VChart `2.1.7`；修复前 R01 使用 `2.0.0`，因此对照不构成固定运行时的效果实验。 +- 新版共 11 个从无父历史开始的独立 Agent 任务；R01 两次都各含两轮，R02 为 R01-a 第三轮。合计 9 次专项场景执行与 3 次既有回归。R01/R04 各两次，其余各一次。 +- 沿用默认模型设置，无 model/reasoning override。任务只接收技能路径、实际请求、必要输入和产物目录，不接收判定答案。诊断任务明确读取诊断工作流；已检查实际产物、渲染记录、截图和验证脚本。 +- 原始产物与复现脚本在 `/tmp/vchart-followup-evals/`。临时目录可能被清理；以下保留关键数据、实际结论及限制，不把临时产物作为技能运行依赖。 + +## 修复前对照 + +| 任务 | 实际结果 | +| --- | --- | +| R01，一次两轮 | 仍交付完整更新 HTML，标签开启、四条数据保留、逐柱点击正确；`before-r01/updated-verification.json` 无浏览器错误 | +| R04，一次 | 返回合法 JSON，保留 day/amount 与 11/23/7/35 四条原值，没有新增 mock；只做格式和数据检查，未渲染 | + +两项对照均通过。原规则仍有文本冲突，本轮消除冲突并确认指定边界；少量样本不能证明成功率提升或长期统计稳定性。 + +## 专项实际结果 + +| 场景 | 次数 | 验收结果与证据 | +| --- | --- | --- | +| R01，HTML 内 spec 修改 | 2 | `r01-a`、`r01-b` 均保留完整 HTML。父任务比较初始与更新文件，实际变化仅为源配置和编辑器中的 `label.visible: false → true`；四条 day/value 为周一12、周二25、周三18、周四32。浏览器真实显示四个数值标签，逐根点击分别显示对应 day/value；无页面错误。A 另验证编辑后点击仍有效 | +| R02，明确切换 JSON | 1 | R01-a 第三轮的 `converted-spec.json` 可直接解析，包含完整四条原数据、字段和 `label.visible=true`，无 HTML、实例创建或事件绑定；父任务核对实际文件 | +| R03，独立配置修改 | 1 | `r03/spec.json` 是完整 JSON，原 data/type/xField/yField 保留并开启标签，未转 HTML、未退化为补丁；格式及数据检查通过，未渲染 | +| R04，无 spec 但有真实数据 | 2 | `r04-a/spec.json`、`r04-b/spec.json` 都只有四条原始 day/amount 记录，值为 11/23/7/35，映射 day/amount，轴标题“金额（元）”。父任务实际渲染两份产物：四根正高度柱、图元原值及单位正确，无浏览器错误；证据 `parent-render-validation.json`、`parent-preview.png` | +| R05，缺必要数据且禁止 mock | 1 | `r05/response.md` 说明当前无法可靠生成修复配置，只索取真实数据/绑定、字段单位、当前与期望数值及口径；未伪造字段、数据、spec 或渲染结论 | +| R06，明确允许 mock 教学 | 1 | `r06/diagnosis.html` 使用标注的 A=10/B=20/C=15 MOCK，明确非业务修复。实际错误配置 `yField=values` 无有效高度柱，修复 `yField=value` 有三根柱；在错误侧编辑后恢复三根柱且数据不变。`verification.json` 断言通过、无页面错误/请求失败；截图确认教学说明和对比图 | +| R07，不可访问真实绑定 | 1 | `r07/response.md` 保留 `dataId='actual-orders'`，列出绑定、字段、轴关联、标签和范围等候选检查；未填 mock/空 values，明确未访问真实数据、未在目标宿主渲染，不声称已定位根因 | + +## 已有场景回归 + +| 场景 | 次数 | 实际结果 | +| --- | --- | --- | +| G01，纯 JSON 生成 | 1 | `regression-g01/spec.json` 是纯 JSON 完整柱图，day/value 及周一12、周二25、周三18、周四32 全部保留，无围栏、解释或 HTML；父任务解析及数据检查通过，未渲染 | +| G03，宿主消费配置 | 1 | `regression-g03/spec.json` 遵守原宿主仅 JSON、bar/line、无函数约束，完整四条原数据及字段正确，无宿主外壳；格式及数据检查通过，未在宿主渲染 | +| G08-R，React 修复 | 1 | `regression-react/Chart.jsx` 导入并使用标准 `VChart` 完整 spec 入口，`data.values=rows`，保留 props 数据，未转 HTML 或只给 spec。父任务对照仓库 VChart 导出、BaseChart spec 解析契约；交付与源码走查通过，未编译 JSX、未挂载或验证 props 更新 | + +## 基础检查与范围限制 + +- 官方 `skill-creator/scripts/quick_validate.py`：通过，`Skill is valid!`。沿用上轮 `/tmp/vchart-skill-validation-20261014` 的临时 PyYAML 环境，未改项目或全局依赖。 +- 既有模板字符串转义 unittest：1 个用例通过，使用 Node.js 22 的 PATH。该生成器修复来自上一轮，本轮生成器/模板与修复前快照逐文件一致。 +- 本地 Markdown 文件链接和 `git diff --check`：通过。覆盖技能主文件、README、全部工作流、专项计划与验收文档；教程未删除既有内容或图片。 +- 本轮仅 Markdown 变更，未重新运行图库全量视觉比较。上一轮相同图库代码的官方 develop 比较为 266 passed、0 diff、0 error、0 not_run，见 [上一轮验收](2026-10-14-vchart-development-assistant-optimization.md)。这是先前结果，不能算成本轮新运行；未来提交 PR 前仍须按仓库要求运行并审查全量视觉报告。 +- JSON 格式/数据检查、浏览器渲染、宿主验收分别记录。未访问 `actual-orders` 宿主；React 回归不预设已挂载；少量行为冒烟不证明自动技能发现率或所有既有请求都无回归。 diff --git a/docs/superpowers/validation/2026-10-14-vchart-development-assistant-optimization.md b/docs/superpowers/validation/2026-10-14-vchart-development-assistant-optimization.md new file mode 100644 index 0000000000..6d44d42a7b --- /dev/null +++ b/docs/superpowers/validation/2026-10-14-vchart-development-assistant-optimization.md @@ -0,0 +1,99 @@ +# VChart 技能 HTML/spec 场景优化验收 + +日期：2026-10-14。对应 [实施计划](../plans/2026-10-14-vchart-development-assistant-optimization.md) 与 [技能入口](../../../skills/vchart-development-assistant/SKILL.md)。本次修改仓库源码，未更新已安装技能、提交、发布或向 issue 发送消息。 + +## 完成范围 + +- 主文件将生成、诊断、视觉还原的任务类型与 HTML/spec 交付目标分别判断；明确要求、既有上下文、任务目标与独立 HTML 默认按顺序处理。 +- 配置生成保留共享选图/查询，新建 HTML 与 spec 专项流程；诊断、React 和视觉还原对齐目标保持。 +- 增量修改默认交付完整产物；片段需明确请求。JSON/JS 遵循宿主和已有格式，原生声明式交互不混入实例 API；组合交付使用同一份 spec。 +- 补充三份完整示例、中英文教程和行为任务定义；不新增 schema 校验、预览平台或共享渲染器。 +- 真实回调验收暴露生成器文本插值错误，进行了最小转义修复与对应回归测试，没有改变图表生命周期或图库代码。 + +## 环境与独立执行 + +- 仓库 HEAD：`6fff2041c1a060800791f3c3d6212bb3812b504b`；工作区包含本次未提交技能与文档改动。 +- Node.js：`v22.23.3`；macOS arm64；Playwright `1.63.0`；Chromium `153.0.8010.12`。 +- 生成器及 Python unittest 使用系统 Python `3.9.6`。官方 quick_validate 需要 PyYAML，现有解释器未安装；在 `/tmp/vchart-skill-validation-20261014` 的临时 Python 3.11 venv 安装 PyYAML 6.0.3 后通过，未添加项目/全局依赖。 +- 新版执行 23 个独立任务，其中 G06 另含同一任务的第二轮修改；关键 G01–G04 每类三次，G08-R/G08-I 分别执行，补充 G11–G14 四个边界任务。每个任务从无父对话历史的独立 Agent 开始，G06 后续轮保留其实际历史。 +- 使用相同默认继承模型设置，未覆盖 model 或 reasoning effort。工具没有提供确切模型标识，不将这次记录视为指定模型的长期成功率评测，也未测试自动技能发现率。 +- 每个 Agent 只收到实际请求、技能路径、必要输入与输出目录，没有收到优化计划、判定答案或已知错误。评估定义见 [generation-scenarios.md](../../../evals/vchart-development-assistant/generation-scenarios.md)。 +- 原始产物、截图、实际验证脚本保留在 `/tmp/vchart-skill-evals/`；临时目录可能被系统清理，本文保留实际结论、关键数据和复现入口，不把临时产物作为技能运行依赖。 + +## 基础检查 + +| 检查 | 实际结果 | +| --- | --- | +| 官方 `quick_validate.py` | passed，Skill is valid | +| 修改技能文件的相对文件链接 | passed，无缺失本地文件链接 | +| 三份示例与实际 JSON 交付字段/原值 | passed，周数据顺序和值 12/25/18/32 保留 | +| `git diff --check` | passed | +| Python 回调代码转义回归 | passed，1 个用例；修复前因 datum 未定义执行失败 | +| 原演示生成器及诊断生成器 | 三份示例 HTML、诊断 HTML 生成成功；React CLI help 正常，仅作为生成/命令冒烟 | + +复现回归测试（仓库根目录，Node.js 22 在 PATH）： + +```sh +python3 -m unittest discover -s skills/vchart-development-assistant/tests -v +``` + +结构检查命令： + +```sh +/tmp/vchart-skill-validation-20261014/bin/python /Users/bytedance/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/vchart-development-assistant +``` + +该路径只记录本机实际执行。其他环境使用已有 PyYAML 的 Python 运行同一标准校验脚本，不需要复用本机路径。 + +## 实际产物与场景判定 + +| 任务 | 次数 | 实际观察与判定 | +| --- | --- | --- | +| G01 纯 JSON | 3 | 三次最终答复均是完整 JSON 柱图，四条原值和顺序正确，无额外说明、HTML、实例代码或确认问题；passed | +| G02 明确 HTML | 3 | 三份完整 HTML，Chromium 实测四根柱及原数据，VChart 2.1.7；passed | +| G03 宿主上下文 | 3 | 三份宿主可消费 JSON 配置，无宿主外壳或框架追问；配置文件与必要的对话说明分离；passed | +| G04 独立展示默认 | 3 | 三次交付可查看 HTML，实际渲染原数据；没有被 spec 路由抢占；passed | +| G05 JSON 无业务事件能力 | 1 | 给合法配置并明确无法实现点击 POST 及所需宿主能力，没有制造事件字段或真实请求接口；passed | +| G06 诊断及后续改动 | 1，含两轮 | yField 从 values 修复为 value；第二轮加 label.visible 后仍返回完整 JSON/data；passed | +| G07 点击 datum | 1 | 四根柱的真实点击分别显示 day/value；编辑重渲染后再次逐柱断言通过，无页面错误；passed | +| G08-R React | 1 | 交付带 BarChart 导入、以 rows props 传 data 的完整 JSX，不强制 HTML/spec；核对仓库 props/导出源码；路由与源码契约 passed，未进行组件挂载 | +| G08-I 图片还原 | 1 | 实际读取截图，JSON 保留真实周数据、颜色 #3b82f6、barMaxWidth=56 和标签样式；VChart 2.0.0 实际绘制四根柱，颜色/宽度与输入一致；passed | +| G09 数值 ID/零/缺失 | 1 | id 101/102/103 保持类别，amount=0/null/25 不改写；父任务用本地 2.1.7 UMD 复核 band 轴与原数据；passed | +| G10 无浏览器 | 1 | 完整 JSON、自检记录，无 HTML 或虚构渲染证据，明确未执行浏览器/宿主验证；passed | +| G11 完整增量 | 1 | “加标签”返回完整 data/type/字段/label，而非补丁；父任务实际渲染四根柱；passed | +| G12 JSON tooltip | 1 | 原生 tooltip.visible/trigger 在 JSON spec 内，无 HTML、实例事件或函数；父任务实际渲染通过；passed（未把该项记为 tooltip hover 内容验收） | +| G13 组合交付 | 1 | JSON spec 和 HTML 齐全；父任务比较 HTML 的 SPEC_START 源配置与 JSON 全量对象完全相同，实际四根柱值正确；passed | +| G14 JS 回调 | 1 | 完整 JS 保留 formatMethod(text, datum) 条件回调；实际标签为周一 12 较低、周二 25 较高、周三 18 较低、周四 32 较高；值=20 的边界断言为较高；passed | + +原始目录：`g01-a/b/c`、`g02-a/b/c`、`g03-a/b/c`、`g04-a/b/c`、`g05`、`g06`、`g07`、`g08-react`、`g08-image`、`g09`、`g10`、`g11`、`g12`、`g13`、`g14`，均位于上述临时根目录。父任务另复核了相关 JSON/data、五份实际 JSON 渲染和组合交付源对象；不是只采信 Agent 的自述。 + +### 原版对照 + +从 HEAD 通过 `git archive` 冻结原技能至 `/tmp/vchart-skill-evals/old/skills/vchart-development-assistant/`，不覆盖工作区。使用相同 G01、G03、G04 请求分别执行一次，产物在 `old-g01`、`old-g03`、`old-g04`。 + +三项对照均得到正确产物：旧版也能够遵循明确 JSON 请求和宿主上下文，并为独立展示交付 HTML。因此本次样本**没有证明新版成功率高于旧版**。本次明确改善是消除主文件/生成流程中的输出冲突、将两条场景边界及增量/交互规则集中维护。三轮重复测试是冒烟检查，不证明长期稳定性。 + +## 真实示例与受控反例 + +原生成器生成的周数据柱图、同一总体饼图及 JS 回调标签示例在 Chromium 实际渲染，运行时均报告 VChart 2.1.7：柱图 4 根、饼图 2 个扇区，数据为原值；JS 标签实际显示“周一: 12”等四项。证据 `/tmp/vchart-skill-evals/examples/validation.json` 与对应 PNG。 + +回调示例初次渲染失败：`datum is not defined`，页面没有 window.vchart。原生成器把回调代码注入 `initialCode` 模板字符串，却未转义 `${...}`，导致代码文本被提前执行。修复只在 `escape_js_string` 中增加 `${` 转义；回归测试验证 JS 文本完整往返，Unicode、反引号、反斜线和换行保留，文本里的 `${globalThis.executed = true}` 未执行。修复后重生成并实际渲染三份示例通过。 + +G07 受控反例：不执行点击时，目标 day/value 断言在限定时间内失败；随后真实点击首柱才得到“day: 周一，value: 12”。记录 `/tmp/vchart-skill-evals/g07/counterexample.json`。不以鼠标动作成功或截图存在代替交互判定。 + +## 官方基线全量视觉比较 + +实际命令（仓库根目录）： + +```sh +PATH=/Users/bytedance/.nvm/versions/node/v22.23.3/bin:$PATH node packages/vchart/scripts/visual-test.mjs +``` + +- 状态：passed；完整比较 true；266 passed，0 diff，0 error，0 not_run。 +- 官方 develop 基线 SHA：`c5ec72804c6b7205d69f1d93e65b299741404547`；没有使用 self-compare。 +- 已读取 [agent-summary.md](../../../.vchart-visual/runs/1791960528746-45ab1c94/agent-summary.md) 及 summary.json，所有用例均无差异或执行错误。[三图报告](../../../.vchart-visual/runs/1791960528746-45ab1c94/index.html)。 +- 此次运行在技能文档编辑过程中完成；后续变化只有教程、评估材料和上述 HTML 生成器文本转义修复。图库运行时没有变化；转义修复由独立单元与真实产物渲染覆盖，没有把之前的图库截图当成该修复的验证。 + +## 验证限制 + +未访问实际飞书等目标宿主，没有记录宿主验收通过。React 子任务验证交付路由、JSX 与源码契约，没有进行实际组件挂载；本次没有修改 React 运行时。JSON 解析、配置自检、真实浏览器渲染与目标宿主验证分别记录，不将其相互替代。本期没有 schema 阶段。 diff --git a/docs/superpowers/validation/2026-10-14-vchart-skill-metadata-quality.md b/docs/superpowers/validation/2026-10-14-vchart-skill-metadata-quality.md new file mode 100644 index 0000000000..297cc0b771 --- /dev/null +++ b/docs/superpowers/validation/2026-10-14-vchart-skill-metadata-quality.md @@ -0,0 +1,105 @@ +# VChart 技能元数据质量优化验收 + +日期：2026-10-14。对应 [计划](../plans/2026-10-14-vchart-skill-metadata-quality.md)、[技能入口](../../../skills/vchart-development-assistant/SKILL.md)、[来源清单](../../../packages/vchart/scripts/skill-metadata/metadata-sources.json)。本轮未提交、推送、创建 PR、发布或同步全局技能。 + +## 完成范围 + +- 维护工具使用真实 TypeScript 符号及模块导入链，修正方向、动画、继承/泛型/Omit 和依赖解析；保留旧消费字段，增加最终有效属性与有效 reference。 +- 30 个既有元数据入口按当前源码重建，新增六个已有 3D 索引入口的元数据；pictogram 迁到扩展来源并补 topkey。 +- 修复 IData 的 CSV URL 误导与类型重定义；补系列/图元动画层级说明，其他有效人工详情保留。 +- 修正组合图系列属性和共享 state 的作用域，删除实际契约中不存在、没有说明的 sankey.nameKey 索引；nodeKey 入口保留。 +- 补充源码声明及按模块区分的导航。所有文件来源使用相对路径或外部包名/版本，记录源码指纹、相关提交及 TypeScript 版本。 +- check 重建并审查，只读报告漂移；未把 schema、维护编译工具或额外确认步骤加入用户生成图表流程。 +- 图库运行时、公开接口、原 HTML 生成器、模板和工作流均未修改；与修复前技能快照逐文件核对，生成器/模板/工作流一致。 + +## 来源与环境 + +- 起点 HEAD：`de46ca24b`；分支 `codex/improve-vchart-skill-html-spec`，工作区为本轮未提交修改。 +- 修复前冻结的完整技能：`/var/folders/p6/3_mdjbzd59n9q8rgt0s6h5240000gn/T/vchart-metadata-before-fwzpwf8k/vchart-development-assistant`。不使用更早的 HEAD 代替本轮基线。 +- Node.js `22.23.3`，TypeScript `4.9.5`，VChart/extension `2.1.7`。维护工具复用已有依赖，没有安装或升级项目依赖。 +- 浏览器使用仓库 Playwright Chromium 或本机 Chrome，验证报告记录实际 VChart 版本。3D 验收使用标准 Rollup 将当前核心和扩展 CJS 入口绑定为同一模块，避免双 Factory/渲染器；依赖是 tools/bundler 已有依赖。 +- 独立任务继承默认模型设置，未覆盖 model/reasoning；不带父对话历史，不提供预期答案。新版共 10 个独立上下文，覆盖 M01–M11：M03 为 M02 的后续真实修改，M09 两轮保留真实 HTML 历史。 +- 冻结版另执行 M01/M02/M06 三个独立任务。原始产物、实际浏览器记录和脚本在 `/tmp/vchart-metadata-evals/`，临时目录可能被清理，本文保留关键结论和复现命令。 + +## 静态审查与生成 + +修复前 audit 记录 442 个缺失的图型/属性组合，以及方向、动画等类型表达差异、错误来源和导航。旧版与当前表达比较也包含别名/格式等差异；同一根因在多个图型和检查项中重复计数，不能把审查总数当成独立 bug 数或运行失败数。 + +修复后 audit/check：**errors=0、sourceChanges=0、changed=[]、orphanMetadata=[]**。另如实记录一个公开开放契约（pictogram）和一个已证实的运行时/类型差异（bar3d）。 + +| 项目 | 修复前 | 修复后 | +| --- | --- | --- | +| topkey | 36 文件，170,967 bytes | 37 文件，172,558 bytes | +| type-meta | 30 文件，973,777 bytes | 36 文件，3,507,786 bytes | +| type-details | 77 文件，515,535 bytes | 78 文件，1,043,923 bytes | + +元数据增加最终属性视图、出处、完整继承和扩展入口，体积增加；补充声明通过类型索引和锚点按需读取。外部类型仅保留直接声明及包版本，不递归复制外部手册。未全量语义审阅原有 77 份人工详情，不能宣称全部说明均已校正。 + +## 自动检查 + +| 检查 | 实际结果 | +| --- | --- | +| Node 维护测试 | 12/12 passed：真实模块碰撞、继承、动画正/反例、Omit 边界、缺模块拒绝、开放/扩展来源、导航、重复键、查询顺序稳定、真实 CLI 只读检查 | +| TypeScript 合法/非法用法 | reverse、animationAppear 字符串 grow 被拒绝；horizontal、preset 对象及 false 合法 | +| audit/check | passed，0 错误/属性差异/生成漂移/孤立元数据；记录开放范围和已证实契约差异 | +| Python 既有转义回归 | 1/1 passed；生成器与本轮前相同 | +| 官方 skill-creator quick_validate | passed；复用之前临时 PyYAML 环境，未改项目或全局依赖 | +| Markdown 相对文件/类型锚点 | passed，技能入口、README 和全部详情目标有效 | +| Prettier、git diff --check | 维护脚本格式检查及差异检查通过 | + +类型联合排序采用 TS 语法节点，保留成员语义；不同入口顺序的新 TS Program 也产生相同属性结果。指纹包括实际源码/依赖内容、版本、来源清单与契约说明源文档，不使用当前时间或无关文档的全局 HEAD。 + +## 实际行为与渲染 + +| 场景 | 实际观察 | +| --- | --- | +| 冻结版 M01/M02/M06 | 均通过。水平柱图和 preset grow 正确，M02 查源码纠正冻结元数据误导；CSV 页面两柱正常。不能据此宣称成功率提升 | +| M01 水平 JSON | 完整配置，day/value 四天 12/25/18/32 保留；父任务确认四根正面积水平柱 | +| M02/M03 动画与关闭 | grow 采用 preset 对象；后续仅改 animationAppear=false，其他配置深度相等；两份实际配置均绘制原四柱 | +| M04 区间面积 | 三条 low/high 数据为 3/8、5/11、4/9，采用真实 minField/maxField；父任务核对三对有限且不同的面积端点，截图上/下边界对应原范围 | +| M05 雷达 | 速度70、力量60、耐力80，完整字段映射；真实三点/线及 datum 正确，父任务复核 | +| M06 CSV 文本 HTML | 两条周一12/周二25，实际两柱、原值及比例正确；未虚构网络加载 | +| M07 本地 CSV URL HTML | 真正 fetch 指定本地服务后绘制两条数据；请求/原值/柱高比例、编辑后颜色变化通过，没有业务外部请求；CDN 图库在验收时替换为同版本本地 bundle | +| M08 JS 回调 spec | formatMethod(text,datum) 显示四条“星期: 数值”；实际标签和四个原数据柱通过；无 HTML/实例代码 | +| M09 HTML 内 spec 修改 | 第二轮仍完整 HTML，仅两处内嵌 label.visible false→true；原四条数据、真实逐柱点击保留，四个标签可见，无页面错误 | +| M10 已知 JSON 宿主 | 完整 JSON，只增加 label.visible=true，原数据和格式保持；父任务实际四柱及标签渲染 | +| M11 扩展 bar3d JSON | 数据完整，不混注册/实例代码；父任务真实共享核心/扩展环境创建四个 rect3d，原 datum、有限正面积、截图及无浏览器错误通过；不是用核心二维柱替代 | + +父任务读取实际配置并核对数据、增量差异，读取浏览器记录、验证脚本及截图；未只依赖 Agent 最终自述。 + +文档 CSV 的独立回归直接执行其原始代码块：URL 当 values 的反例为 0 柱/空数据，实际 CSV 文本示例为两柱，应用 fetch 后文本为两柱；本地服务只收到一次 GET，数据为周一12、周二25。 + +## 已知边界 + +- pictogram 当前公开类型包含 IChartExtendsSeriesSpec，不能伪造闭合字段集合；系列声明和根字段转发来源明确保留。 +- IBar3dSeriesSpec 继承二维 bar 类型，未声明运行时与仓库示例使用的 bar3d.style。元数据 contractNotes 明确记录说明、来源和最小样式示例，没有把文档字段伪造进类型属性。公开接口修正应单独处理；本期没有修改类型契约。 +- M09 按“其他内容保持”保留初始编辑提示，其中“当前不显示数值标签”与更新后的状态不一致。数据、标签、点击和交付检查通过；未将提示文案一致性计作通过，未借此改写技能交付规则。 +- 浏览器验收不代表真实宿主已验收；未进行 React 组件挂载或所有六个扩展图型的运行验收。六个扩展入口的真实来源、字段和注册关系均完成静态核对。 +- 本轮未创建 PR，未重新运行图库全量视觉比较。图库、生成器、模板没有变化；未来提交 PR 前仍须运行并审查官方 develop 全量比较，不能拿上一轮 266 passed 充当本轮新结果。 + +## 复现入口 + +仓库依赖已准备、Node.js 22 在 PATH： + +```sh +node --test packages/vchart/scripts/skill-metadata.test.mjs +node packages/vchart/scripts/skill-metadata.mjs audit --report /tmp/vchart-metadata-audit.json +node packages/vchart/scripts/skill-metadata.mjs check +node packages/vchart/scripts/skill-metadata/verify-examples.mjs --csv-example /tmp/vchart-csv-example-validation.json +python3 -m unittest discover -s skills/vchart-development-assistant/tests -v +``` + +生成候选产物再审查： + +```sh +node packages/vchart/scripts/skill-metadata.mjs generate --output /tmp/vchart-metadata-generated +``` + +已有实际 Agent 产物时，维护验证器读取原配置，不手工补数据/字段： + +```sh +node packages/vchart/scripts/skill-metadata/verify-examples.mjs --build-extension /tmp/vchart-extension-runtime.js +node packages/vchart/scripts/skill-metadata/verify-examples.mjs --artifacts /tmp/vchart-metadata-evals --case m11 --extension-bundle /tmp/vchart-extension-runtime.js +``` + +缺产物/缺扩展环境记为 not_run，不能算 passed。M07 所用本地 CSV 服务已在验收结束后关闭。 diff --git a/docs/superpowers/validation/2026-10-15-vchart-metadata-dependency-navigation.md b/docs/superpowers/validation/2026-10-15-vchart-metadata-dependency-navigation.md new file mode 100644 index 0000000000..7dce447230 --- /dev/null +++ b/docs/superpowers/validation/2026-10-15-vchart-metadata-dependency-navigation.md @@ -0,0 +1,84 @@ +# VChart 元数据依赖与类型导航修复验收 + +日期：2026-10-15。对应[实施计划](../plans/2026-10-14-vchart-metadata-dependency-navigation.md)。本轮以执行前工作区为基线，保留上一轮未提交改动；未提交、推送、创建 PR、发布或同步全局技能。 + +## 实际变更 + +1. 依赖内部使用规范化文件路径和符号限定名区分身份，统一 AST 与实例化依赖的归并。同名不同来源使用稳定 hash 后缀导航键，同符号不同别名去重；必要时属性提供 dependencyBindings，关联 A/B 等声明拼写和真实目标。无碰撞时保留原短键。 +2. 可达类型解析校验与人工/补充/外部详情的展示策略分离。校验发生在简单类型分类之前，报告属性、类型链、符号及相关模块位置；不再因为声明所在文件包含任意缺失导入就整体拒绝。整条类型链成功后才提交校验缓存，循环链失败不留下部分成功状态。 +3. 补充 typeof 查询依赖，解析导入、命名空间和枚举成员的真实来源。成员查询导航到所属枚举，避免只有孤立成员摘录。audit 同时检查属性别名绑定、补充声明内容及其传递链接；不会只凭目标文件存在判定导航有效。 + +实现文件为 `packages/vchart/scripts/skill-metadata/extract.mjs`、`packages/vchart/scripts/skill-metadata.test.mjs`。CLI、图库源码、公开接口、技能场景规则与应用生成工具均未修改。 + +## 基线与环境 + +- 分支 `codex/improve-vchart-skill-html-spec`，起点 HEAD 为 `de46ca24b`；不是用 HEAD 覆盖上一轮工作区资源。 +- Node.js 22.23.3，TypeScript 4.9.5，VChart/extension 2.1.7；未安装或升级依赖。 +- 执行前完整技能、维护脚本和文件摘要保存在临时快照中，位置记录于 `/tmp/vchart-navigation-baseline-path.txt`。 +- 执行前原有 Node 测试为 12/12 passed；原有 check 无漂移。新增核心 11 组测试在冻结的旧 extractor/CLI 上全部失败，修复后全部通过。补充的跨模块属性和循环失败缓存两组回归也通过。 +- CLI 夹具仅在临时目录复制工具和最小源码，使用现有依赖；Git 仅用于读取提交信息，不修改真实仓库索引或配置。macOS 临时路径使用 realpath 调用实际 CLI，避免 `/var` 与 `/private/var` 的路径别名使 CLI 入口没有执行。 + +## 测试与反例 + +最终 Node 测试 **25/25 passed**，包含原有 12 项与新增 13 项。原有逆序入口测试扩展为全部 36 个图型，独立 TS Context 抽取结果一致。 + +| 检查 | 实际结果 | +| --- | --- | +| 同属性 A/B 引用两模块 Item | 两个真实定义、独立导航键、别名绑定准确；调换导入顺序目标不变 | +| 同符号两个别名 | 只保留 Item 短键，A/B 均能导航 | +| 跨属性、Record 泛型、同文件命名空间 | 不拒绝合法同名类型、不覆盖不同声明 | +| 补充父类型的同名依赖 | 两个父类型及各自锚点均存在 | +| 人工详情下传递缺模块/缺导出 | 拒绝，错误含 value、Broken、Missing、模块及 middle.ts | +| 无关缺失导入 | 引用类型合法则通过；不是整文件拒绝 | +| 显式 any、索引签名、合法循环 | 保留实际公开契约；原 pictogram 开放契约测试继续通过 | +| 循环链失败后再次校验 | 再次拒绝，不使用部分成功缓存绕过错误 | +| typeof 枚举、导入、限定成员、常量对象 | 真实定义及相关链接存在；未执行应用源码 | +| typeof 同名值与缺失导入 | 不串来源；人工详情不能掩盖缺失导入 | +| 真实 DirectionType、RenderMode | 分别导航至 typings/space.ts 的 Direction 和 spec/common.ts 的 RenderModeEnum；未混入播放器方向 | +| 故意破坏别名绑定/枚举锚点 | audit 报错，避免只检查文件存在 | +| 实际 generate：先合法入口、再错误入口 | 非零退出；哨兵文件不变，不写入部分新元数据 | +| audit/check | errors=0、sourceChanges=0、changed=[]、orphanMetadata=[] | +| Python 既有生成器转义回归 | 1/1 passed | +| skill-creator quick_validate | passed，复用已有临时 Python 环境 | +| Prettier、git diff --check | passed | + +原产物仍明确记录 pictogram 开放契约与 bar3d 类型/运行时差异，没有把其范围收窄为闭合校验。 + +## 资源差异与场景规则 + +- 全部 36 份元数据的 effectiveProperties、原始/解析类型、必需项以及继承声明/映射内容保持不变；源码内容指纹也未变化。 +- 4 份元数据更新导航锚点：linearProgress 的 progress/track、boxPlot 的 boxPlot、wordCloud/wordCloud3d 的 word。原因是声明身份包含所属枚举，避免同文件不同作用域同名时碰撞；属性类型、短导航键和文件大小没有变化。 +- 补充声明从 580 项变为 590 项，增加所需的枚举/值来源及相关链接；该文件增加 10,648 bytes。type-meta 总计仍为 3,507,786 bytes；type-details 总计由 1,043,923 变为 1,054,571 bytes。 +- 对执行前快照逐文件比较：SKILL.md、README、workflows、scripts、template、topkey、metadata-sources.json 与所有人工 type-details 均保持原字节内容。 +- 连续生成及独立逆序 Context 检查稳定。维护命令未进入用户生成配置流程，未增加 schema、编译或确认步骤。 + +## 原场景产物复核 + +把上一轮实际原产物复制到 `/tmp/vchart-navigation-evals/`，配置和 HTML 内容未改写。复用原浏览器检查脚本，输出保存在副本目录，不覆盖上一轮证据。HTML 页面实际加载 VChart 2.1.7 和原 Monaco 编辑器；JS/JSON spec 使用同版本本地构建验证。 + +| 场景 | 本轮实际观察 | +| --- | --- | +| M06 CSV HTML | 两条真实 CSV 文本记录、两柱、12/25 柱高比例正确，浏览器无 pageerror | +| M08 JS 回调 spec | formatMethod 产生四条星期/数值标签，四根柱及原数据正确，无浏览器错误 | +| M09 HTML 内 spec 修改 | 原更新后的完整 HTML 正常运行，4 条数值标签可见；逐柱点击返回对应原 day/value，四次均通过 | +| M10 JSON 宿主配置 | 读取原 JSON，四柱和原数据匹配，无页面错误，验证报告 passed | + +已查看 M09 本轮截图。其编辑提示仍有上一轮已记录的“当前不显示数值标签”旧文案，本轮未修改原产物，也未把文案一致性计作通过。 + +这些复核证明保留的原产物仍能运行，不等于重新执行了全部 Agent 行为评测、真实宿主集成或 React 挂载。HTML/spec 决策规则保持的直接证据是受保护文件逐字节相等。 + +## 复现与证据 + +从仓库根目录执行，使用 Node.js 22： + +```sh +node --test packages/vchart/scripts/skill-metadata.test.mjs +node packages/vchart/scripts/skill-metadata.mjs audit --report /tmp/vchart-navigation-audit.json +node packages/vchart/scripts/skill-metadata.mjs check +python3 -m unittest discover -s skills/vchart-development-assistant/tests -v +git diff --check +``` + +本轮临时证据包括 `/tmp/vchart-navigation-red-fixed.log`、`/tmp/vchart-navigation-tests-final.log`、`/tmp/vchart-navigation-audit.json`、`/tmp/vchart-navigation-contract-comparison.json`、`/tmp/vchart-navigation-file-comparison.json` 和 `/tmp/vchart-navigation-evals/`。临时目录可能被清理；仓库内保留回归测试和关键结论。 + +本轮没有修改图库运行时，也未创建 PR，未重跑全量视觉比较。未来提交 PR 前仍须执行并审查官方 develop 全量视觉比较，不使用此前结果替代。 diff --git a/docs/superpowers/validation/2026-10-16-vchart-skill-metadata-distribution.md b/docs/superpowers/validation/2026-10-16-vchart-skill-metadata-distribution.md new file mode 100644 index 0000000000..13ce003c0d --- /dev/null +++ b/docs/superpowers/validation/2026-10-16-vchart-skill-metadata-distribution.md @@ -0,0 +1,90 @@ +# VChart 技能元数据分发精简验收 + +日期：2026-10-16。对应 [实施计划](../plans/2026-10-16-vchart-skill-metadata-distribution.md) 与 [维护说明](../../skills/vchart-development-assistant-maintenance.md)。实施验收阶段未提交；用户随后授权整理并创建本地提交，未授权推送、创建 PR、发布或同步全局技能。 + +## 结果 + +- 全部 36 份 type-meta 改为格式 3，只分发最终属性、配置说明、版本边界、扩展约束与类型导航。 +- 移除逐属性 `source/inheritedFrom/category/originalType`、完整继承树及顶层维护信息；内部抽取模型继续保留这些信息，审计错误仍能定位源码。 +- 来源清单迁至 `packages/vchart/scripts/skill-metadata/metadata-sources.json`；README 的维护章节迁至仓库维护说明。前序 evals 迁移保持不变。 +- type-meta 从 **3,507,786 bytes 降到 1,233,236 bytes，减少 64.84%**；`bar.json` 从 119,080 bytes 降到 42,934 bytes。 +- Node 22 下 **29/29 项工具测试通过**，`audit` 为零错误/零来源缺项，连续两次 `check` 均无漂移。3 个独立技能任务的真实产物均完成浏览器检查。 + +## 环境和证据 + +- 起始 HEAD：`e4517de1dee49b814ccf73669121251598c12f3b`，同时保存在基线目录 `sha.txt`；实施验收阶段没有创建新提交。起始状态包含前序 evals 迁移及本计划，保存为 `initial-status.txt`。 +- 主执行与最终检查使用 Node.js `v22.23.3`，TypeScript `4.9.5`，核心/扩展 VChart `2.1.7`。 +- 临时基线和产物目录：`/var/folders/p6/3_mdjbzd59n9q8rgt0s6h5240000gn/T/vchart-metadata-distribution.498plj0q/`。其中包含完整原技能 `skill/`、候选 `candidate/`、完整候选 references、审计报告、源模型对照脚本和浏览器产物。临时目录可能被系统清理，本文记录主要结论及复现方式。 +- 全量工具测试日志：`/tmp/vchart-distribution-full-tests-final.log`；初次缺少投影模块的测试和缺失空依赖数组的审计反例分别先失败，修复后通过。 +- 官方 `quick_validate.py` 首次因系统 Python 缺少 PyYAML 未运行成功；复用已有 `/tmp/vchart-skill-validation-20261014/bin/python` 环境后返回 `Skill is valid!`，未安装新依赖。 + +## 与旧已提交资料的差异及必要修正 + +初始全入口测试发现旧清单的 `packages/vchart/src/chart/sequence/interface.ts` 不存在，无法重生成。本轮没有恢复已删除类型或绕过该入口，而是核对当前源码后修正为 `packages/vchart-extension/src/charts/sequence/interface.ts`、扩展包及 `registerSequenceChart` 注册前提。来源清单的其他 35 个入口和 74 项人工详情映射保持不变。 + +旧 JSON 与当前源码/已安装依赖还存在以下变化，和分发投影区别记录： + +| 项目 | 已核实差异 | +| --- | --- | +| 最终属性 | 共 2,601 项，只有 `common.series` 的类型与依赖集合变化：当前核心公开类型不再包含迁往扩展的 `IDotSeriesSpec/ILinkSeriesSpec`；其余 2,600 项保留字段逐值一致 | +| 依赖定义 | `common` 移除上述两个已不属于核心联合的定义；其余导航键、类型名与 reference 不变 | +| 外部版本 | VRender 相关包从旧记录 1.1.11 更新为当前 1.1.12；VDataset 从 1.0.27 更新为 1.0.28，路径与导航锚点不变 | +| sequence | 最终属性不变，新增真实扩展版本与注册要求 | +| 补充声明 | 590 节变为 583 节，537,354 bytes 变为 529,835 bytes；移除迁出核心且不再被当前入口引用的 7 节，正文变化仅为 `ChartSpecMap/ICommonChartSpec` 的真实核心类型变化，另同步外部版本来源行 | +| topkey 与人工详情 | 全部逐字节不变；人工详情指向补充声明的链接无新增断链 | + +因此，计划中“旧资料的所有保留字段和补充声明均不变”调整为：分发投影不改变当前源码的抽取结果，上述既有资料过期项按真实来源同步，禁止隐藏为精简变化。 + +额外把 HEAD 原版 `extract.mjs` 保存到临时目录，用相同的当前来源清单、源码和依赖独立创建上下文，逐图型比较本轮抽取器与原版结果：**36 个完整内部模型、2,601 个属性均深度相等，生成补充声明也逐字节相等**。这验证了资料更新来自原有源码/依赖漂移，未因分发投影改变类型解析。 + +## 工具验证 + +| 检查 | 实际结果 | +| --- | --- | +| 纯投影 | false、0、空字符串、null、版本说明、扩展约束、同名定义及别名绑定保留；不修改输入 | +| 审计反例 | 遗留维护字段、缺属性说明/required/dependencies、错误方向类型、错误类型名/reference、别名目标交换、注册约束丢失均被拒绝 | +| 维护诊断 | 错误方向类型仍报告 `packages/vchart/src/chart/cartesian/interface.ts` | +| 既有深层测试 | Omit、同名类型、泛型、typeof、循环依赖、缺失导入、无部分输出、真实 CLI 等测试保留并通过 | +| 候选及最终 audit | `errors: 0`、`sourceChanges: 0`；开放边界 1 项、运行时契约说明 1 项 | +| check | 两次 `changed: []`、`orphanMetadata: []`；最终测试还执行真实 CLI 检查 | +| 格式和差异 | 修改的 5 个 JS 文件 Prettier 检查通过，`git diff --check` 通过 | + +审计还检查保留字段的存在性：缺少简单属性的空 `dependencies: []` 不能被静默归一化后当成通过。该反例先失败，补强字段存在性检查后，重新执行全部 29 项测试通过。 + +## 独立技能消费及实际渲染 + +三个任务使用无父对话历史的独立上下文，按计划顺序执行，未覆盖 model 或 reasoning effort。没有确切模型标识，不将这三次冒烟观察推广成成功率或自动技能发现率评测。子任务自述的资料读取与本次主任务实际检查的产物分开：主任务读取原产物并运行浏览器验证，不仅采信最终自述。 + +| 任务标识 | 产物与读取说明 | 主任务实际验收 | +| --- | --- | --- | +| `/root/distribution_horizontal` | `agent-artifacts/m01/spec.json`；子任务报告读取 bar topkey/type-meta、数据说明及工作流 | 原 spec 未重写，既有验证器在 VChart 2.1.7 渲染 4 根有效水平柱；四条数据与次序保持，图元几何正确 | +| `/root/distribution_callback` | `agent-artifacts/g14/spec.js`；子任务报告读取 bar 元数据、ILabelSpec 与回调示例 | 原 JS 配置未重写，实际渲染 4 根柱，真实文本为“周一: 12 较低”“周二: 25 较高”“周三: 18 较低”“周四: 32 较高”；无页面错误 | +| `/root/distribution_html` | `agent-artifacts/g02/chart.html`；子任务报告使用共享/HTML 工作流、元数据及原模板/生成器 | Node 22 重新检查两个内联脚本语法；原 HTML 经本地 HTTP 打开，在线 VChart 2.1.7 与 Monaco 依赖实际加载，4 根柱和数据正确，无页面错误或请求失败 | + +三份截图由主任务查看，确认方向、四条数值和标签可见。JSON/JS/HTML 的验证输出分别为 `spec-parent-validation.json`、`callback-render.json`、`html-render.json`，截图在各任务目录。 + +执行边界说明：HTML 子任务最初使用默认 Node 24 做静态检查，并额外读取了一份仓库外的 brainstorming 技能文件；该读取不符合子任务限定范围，记录为执行偏差。主任务随后使用 Node 22 对同一原产物重新检查及渲染；未将子任务的静态检查冒充浏览器通过。 + +## 复现主要检查 + +使用 Node.js 22，从仓库根执行： + +```sh +node --test packages/vchart/scripts/skill-metadata/distribution.test.mjs packages/vchart/scripts/skill-metadata.test.mjs +node packages/vchart/scripts/skill-metadata.mjs audit --report /tmp/vchart-metadata-distribution-audit.json +node packages/vchart/scripts/skill-metadata.mjs check +node packages/vchart/scripts/skill-metadata.mjs check +git diff --check +``` + +已有本次实际 Agent 产物时，水平柱图可复用： + +```sh +node packages/vchart/scripts/skill-metadata/verify-examples.mjs --artifacts /var/folders/p6/3_mdjbzd59n9q8rgt0s6h5240000gn/T/vchart-metadata-distribution.498plj0q/agent-artifacts --case m01 +``` + +缺失临时产物应记录为 `not_run`，不能凭进程退出码登记通过。 + +## 验证范围 + +本轮没有修改图库运行时、HTML 生成器、模板或公开类型。未运行新的 3D 图元用例、目标业务宿主验收或全量视觉回归；扩展注册和开放契约只完成元数据/反例检查。未来创建 PR 前仍需按仓库要求执行全量视觉回归并审查报告。本次未将这些未执行项登记为通过。 diff --git a/evals/vchart-development-assistant/generation-scenarios.md b/evals/vchart-development-assistant/generation-scenarios.md new file mode 100644 index 0000000000..d2225b1697 --- /dev/null +++ b/evals/vchart-development-assistant/generation-scenarios.md @@ -0,0 +1,56 @@ +# 生成场景前向测试 + +使用仓库技能及下列真实请求，在独立上下文执行；按需读取技能引用，不提供预期答案、优化计划或其他任务产物。临时输出放在仓库之外，保留实际配置、页面、截图和验证记录。不建设模型调用框架，不把手工示例测试计入 Agent 行为通过。 + +同一批任务使用相同继承模型/推理设置，不做模型覆盖。工具未提供确切模型标识时记录这一限制。G01–G04 各运行三次，其余至少一次；G08 两个子任务分开。重复只作为冒烟检查，不推导长期成功率。 + +## 原始任务 + +共享周数据：周一 12，周二 25，周三 18，周四 32。涉及数据的任务使用这些明确数值，不提供图型答案。 + +| ID | 完整提示及最小上下文 | 判定 | +| --- | --- | --- | +| G01 | “下面的数据：周一 12，周二 25，周三 18，周四 32。用合适的 VChart 图表比较这些天的数值，只返回完整 JSON spec，不要解释。” | 最终答复是可解析 JSON；完整配置、四个值与顺序保留，无 HTML/实例代码或无必要澄清 | +| G02 | “下面的数据：周一 12，周二 25，周三 18，周四 32。用 VChart 比较四天数值，生成可打开查看的完整 HTML。” | 完整 HTML，打开后有真实数据图元；检查值和字段 | +| G03 | 已有上下文：“宿主负责渲染，只接收纯 JSON VChart spec，支持 bar/line，不接受函数或 HTML。”本轮：“下面的数据：周一 12，周二 25，周三 18，周四 32。用合适的 VChart 图表比较这些数据。” | 配置产物遵守上下文；无框架追问或宿主外壳；普通对话说明可在配置之外 | +| G04 | “周一 12、周二 25、周三 18、周四 32。用合适的 VChart 图表比较这四天的数值，展示给我。”无宿主上下文 | 可查看 HTML；没有新增 spec 场景导致的默认 JSON 抢占 | +| G05 | “宿主只接收 JSON，不接受函数，也不提供事件映射。生成周数据图表 spec，并在点击柱子时向我的业务接口发 POST 请求。请只给可用配置；接口不应在本次测试真实请求。” | 查清声明式与应用代码边界；不能满足则说明，不制造 JSON 字符串函数或自动改 HTML，不真实请求接口 | +| G06 | “我已有 JSON 柱图，data.values 是周数据，xField=day、yField=values；请修复字段问题并返回完整 JSON，不要解释。”随后：“再加标签，保留数据和 JSON 格式。” | 初次修复及后续修改均为完整配置，字段/data 保留；不是只有 label 的补丁 | +| G07 | “周一 12、周二 25、周三 18、周四 32。生成 VChart HTML；点击柱子把 datum 的 day 和 value 显示到页面结果区域。” | 真正点击不同柱子后检查 day/value；抑制动作时不能满足结果断言 | +| G08-R | “这是现有 React-VChart：function Chart({rows}) { const spec={type:'bar',data:{values:rows},xField:'day',yField:'value'}; return ; } 组件外没有导入 BarChart。请给可替换的 React 组件修复，数据由 props 传入，不要 HTML。” | 修复组件/导入，保留 props 数据；不强制 HTML 或只给原生 spec | +| G08-I | 输入一份实际柱图截图和共享周数据：“参考图片的柱图颜色、标签和布局还原，真实数据是上述四天；只返回完整 JSON spec。” | 实际读取图片；数据来自明确输入；完整 JSON，无 HTML 强制交付 | +| G09 | “数值 ID 101/102/103 是订单类别，不是连续量。金额（元）分别为 0/null/25。生成完整 JSON spec 比较各订单金额，保留原数据，缺失不能补零。” | ID 为类别；0/null 区分；不删行/补零；单位合理 | +| G10 | 环境限制：“本次没有可用浏览器，请勿执行渲染。”请求：“生成共享周数据的完整 JSON spec 文件，说明完成了哪些检查。” | 交付完整配置；JSON/data 自检和未渲染结论真实，无伪造图元证据 | +| G11 | “现有完整 JSON 柱图包含共享周数据、xField=day、yField=value。加上数值标签，只返回 JSON。” | 返回整合后完整配置，不因增量修改变成补丁 | +| G12 | “宿主只接收 JSON VChart 配置。用共享周数据生成柱图，打开原生 tooltip，只返回 JSON。” | 声明式 tooltip 在 spec 内；无事件代码、函数或 HTML | +| G13 | “用共享周数据生成完整 spec，再给使用同一份配置的可打开 HTML 预览。” | 两种产物齐全，实际页面与 spec 的数据/字段一致 | +| G14 | “宿主接受 JavaScript spec 和函数。我已有共享周数据柱图。只要完整 spec；标签显示星期、数值，数值 >=20 时追加‘较高’，否则追加‘较低’。” | 沿用 JS 格式，正确函数签名和条件；完整数据，无实例代码；渲染检查真实标签 | + +## 证据与执行 + +每份任务记录独立 Agent 任务标识、是否澄清、读取的流程、产物路径，以及实际完成的格式/数据/渲染/交互检查。需读取对应 Agent 的实际工具过程或产物，不凭其最终自述判全部通过。 + +JSON 解析不代表配置有效；HTML 存在不代表图表已经绘制。浏览器检查图元数据、字段、标签及要求的交互；无法渲染或无法访问目标宿主时分别记录未执行。 + +G01–G04 的旧版与新版对比使用相同原始请求、相同模型设置和独立技能副本；旧版只从仓库 HEAD 取技能资源，不能覆盖当前工作区。结果只描述观察到的差异，不预设旧版必失败或据少数任务推导成功率。 + +执行结果与复现材料在本次 validation 文档中登记；此文件定义任务，不预填通过。 + + +## 交付上下文与诊断数据专项边界 + +本组延续相同的独立测试方法。已有产物保持任务使用真实多轮历史；描述诊断任务读取诊断工作流，记录实际读取与产物，确保具体分支得到覆盖。修复前快照来自当时工作区，不能用上一轮优化前的 HEAD 代替。 + +| ID | 原始任务与上下文 | 判定 | +| --- | --- | --- | +| R01 | 第一轮：“周一 12、周二 25、周三 18、周四 32。生成完整 VChart HTML，点击柱子在页面显示 day/value；先不显示数值标签。”第二轮：“在已有 HTML 中，把 spec 的数值标签打开，其他内容保留。” | 两轮都是完整 HTML；标签从关闭变成真实可见，数据与点击 datum 交互保留 | +| R02 | 在 R01 实际 HTML 历史后：“现在只返回其中更新后的完整 JSON spec，不要 HTML 或解释。” | 显式切换优先，完整 JSON，不带应用事件、实例代码或 HTML | +| R03 | 独立上下文，输入 type=bar、xField=day、yField=value、四天周数据的完整 JSON 柱图：“加上数值标签，返回修改后的配置。” | 没有已有 HTML 目标时交付完整 spec，不强制 HTML 或补丁 | +| R04 | “我的 VChart 柱图数值轴空白，没有原 spec。真实数据为 [{day:'周一',amount:11},{day:'周二',amount:23},{day:'周三',amount:7},{day:'周四',amount:35}]，amount 单位为元。请按这些真实字段提供可用完整 JSON 配置，不要解释。” | 只含四条真实记录，day/amount 和单位正确；不创建第 5 条或换成 mock，不声称定位未提供代码的根因 | +| R05 | “业务图数值不对，我暂时没有原配置、实际数据或字段定义。请给修复后的完整 spec，不能使用模拟数据。” | 澄清必要信息或说明不能完成，不伪造字段/数据，不报告修复或渲染通过 | +| R06 | “这是教学演示：请用明确标注的 mock 数据解释 yField 指错导致柱图空白的情况，给可运行 HTML。” | 标注 mock、实际可运行修复演示；不将演示当作原业务问题已修复 | +| R07 | “宿主负责绑定 dataId='actual-orders' 的真实数据，字段 day/amount，但本地不能访问它。我没有原 spec，只知道数值轴空白；请给配置排查方向，保留真实绑定，不生成模拟数据。” | 保留真实绑定契约，不用 mock 或空数据替代；候选原因与未执行验收分开 | + +R01/R04 各执行两次，其他各一次；复用 G01/G03/G08-R 各一次确认已有场景。R01 第一轮故意关闭标签，以检查第二轮发生真实变化，不以原本已显示的标签冒充修改通过。 + +实际 JSON 检查原字段和完整数据，HTML 检查标签与真实点击。不能用手工重写的修复配置代替 Agent 产物，不能将未访问的宿主或未挂载的 React 组件登记为通过。 diff --git a/packages/vchart/scripts/skill-metadata.mjs b/packages/vchart/scripts/skill-metadata.mjs new file mode 100644 index 0000000000..1c0a1685bd --- /dev/null +++ b/packages/vchart/scripts/skill-metadata.mjs @@ -0,0 +1,105 @@ +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { parseArgs } from 'node:util'; +import { createContext, extractChart, supplementalDetails, auditReferences } from './skill-metadata/extract.mjs'; +import { toDistributedMetadata } from './skill-metadata/distribution.mjs'; + +const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../..'); +const references = path.join(repoRoot, 'skills/vchart-development-assistant/references'); + +export function buildArtifacts(context, sources) { + const files = new Map(); + for (const source of sources) + files.set( + `type-meta/${source.chart}.json`, + JSON.stringify(toDistributedMetadata(extractChart(context, source)), null, 2) + '\n' + ); + files.set('type-details/AdditionalTypes-Type-Definition.md', supplementalDetails(context)); + return files; +} + +export function compareArtifacts(files, directory) { + return [...files] + .filter( + ([name, content]) => + !fs.existsSync(path.join(directory, name)) || fs.readFileSync(path.join(directory, name), 'utf8') !== content + ) + .map(([file]) => file); +} + +export function run(args) { + const { values, positionals } = parseArgs({ + args, + allowPositionals: true, + options: { + output: { type: 'string' }, + report: { type: 'string' }, + references: { type: 'string' }, + write: { type: 'boolean' }, + help: { type: 'boolean' } + } + }); + if (values.help) { + console.log( + '维护命令（Node.js 22，仓库已有依赖）：audit [--references DIR] [--report FILE]；generate --output DIR 或 --write；check。用户生成图表无需运行。' + ); + return; + } + const command = positionals[0]; + if (positionals.length !== 1 || !['audit', 'generate', 'check'].includes(command)) + throw new Error('需要 audit、generate 或 check 命令'); + if (command === 'generate' && !!values.output === !!values.write) + throw new Error('generate 必须且只能指定 --output 或 --write'); + if (command !== 'generate' && (values.output || values.write)) throw new Error('--output/--write 只用于 generate'); + if (command !== 'audit' && (values.references || values.report)) + throw new Error('--references/--report 只用于 audit'); + const manifest = JSON.parse( + fs.readFileSync(path.join(repoRoot, 'packages/vchart/scripts/skill-metadata/metadata-sources.json'), 'utf8') + ); + const context = createContext(repoRoot, manifest.sources, manifest); + if (command === 'audit') { + const report = auditReferences( + context, + manifest.sources, + values.references ? path.resolve(values.references) : references + ); + report.provenance = { + vchartVersion: context.version, + extensionVersion: context.extensionVersion, + typescriptVersion: context.ts.version, + sourceHash: context.sourceHash, + sourceRevision: context.sourceRevision + }; + if (values.report) fs.writeFileSync(values.report, JSON.stringify(report, null, 2) + '\n'); + console.log(JSON.stringify(report.summary)); + if (report.errors.length || report.changes.length) process.exitCode = 1; + return report; + } + const files = buildArtifacts(context, manifest.sources); + if (command === 'check') { + const changed = compareArtifacts(files, references); + const orphans = fs.readdirSync(path.join(references, 'type-meta')).filter(n => !files.has('type-meta/' + n)); + const audit = auditReferences(context, manifest.sources, references); + console.log(JSON.stringify({ files: files.size, changed, orphanMetadata: orphans, audit: audit.summary })); + if (changed.length || orphans.length || audit.errors.length || audit.changes.length) process.exitCode = 1; + return; + } + const directory = values.write ? references : path.resolve(values.output); + // 完整抽取成功后才写入；未知类型/缺依赖不产生一半的新元数据。 + for (const [name, content] of files) { + const file = path.join(directory, name); + fs.mkdirSync(path.dirname(file), { recursive: true }); + fs.writeFileSync(file, content); + } + console.log(JSON.stringify({ files: files.size, output: path.relative(repoRoot, directory) || '.' })); +} + +if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) { + try { + run(process.argv.slice(2)); + } catch (error) { + console.error(error.message); + process.exitCode = 1; + } +} diff --git a/packages/vchart/scripts/skill-metadata.test.mjs b/packages/vchart/scripts/skill-metadata.test.mjs new file mode 100644 index 0000000000..be08c1ca17 --- /dev/null +++ b/packages/vchart/scripts/skill-metadata.test.mjs @@ -0,0 +1,669 @@ +import assert from 'node:assert/strict'; +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { test } from 'node:test'; +import os from 'node:os'; +import { execFileSync, spawnSync } from 'node:child_process'; +import { createContext, extractChart, supplementalDetails, auditReferences } from './skill-metadata/extract.mjs'; +import { toDistributedMetadata } from './skill-metadata/distribution.mjs'; + +const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../..'); +const references = path.join(root, 'skills/vchart-development-assistant/references'); +const manifest = JSON.parse( + fs.readFileSync(path.join(root, 'packages/vchart/scripts/skill-metadata/metadata-sources.json'), 'utf8') +); +const context = createContext(root, manifest.sources, manifest); +const source = chart => manifest.sources.find(s => s.chart === chart); +const metadata = chart => extractChart(context, source(chart)); + +function withFixture(files, fn, detailReferences = {}) { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-navigation-')); + try { + for (const [name, text] of Object.entries(files)) { + const file = path.join(directory, name); + fs.mkdirSync(path.dirname(file), { recursive: true }); + fs.writeFileSync(file, text); + } + const item = { + chart: 'fixture', + typeName: 'Spec', + sourceFile: path.relative(root, path.join(directory, 'index.ts')), + package: '@visactor/vchart' + }; + const mapped = Object.fromEntries( + Object.entries(detailReferences).map(([name, target]) => { + const [file, symbol] = name.split('#'); + return [`${path.relative(root, path.join(directory, file)).split(path.sep).join('/')}#${symbol}`, target]; + }) + ); + const fixtureManifest = { ...manifest, detailReferences: mapped }; + return fn(createContext(root, [item], fixtureManifest), item, directory, fixtureManifest); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +} + +function section(details, definition) { + const start = details.indexOf(`id="${definition.anchor}"`); + assert(start >= 0, definition.id); + const end = details.indexOf(' { + const actual = metadata('bar').effectiveProperties.find(p => p.name === 'direction'); + assert.deepEqual(actual.literalValues.sort(), ['horizontal', 'vertical']); + const file = context.program.getSourceFile(path.join(root, 'packages/vchart/src/component/player/interface/spec.ts')); + const node = file.statements.find(n => n.name?.text === 'DirectionType'); + const type = context.checker.getTypeAtLocation(node); + assert.deepEqual(type.types.map(t => t.value).sort(), ['default', 'reverse']); +}); + +test('多层继承、映射类型和完整字段来自真实公开契约', () => { + for (const [chart, requiredNames] of [ + ['rangeArea', ['xField', 'yField', 'label', 'area', 'animationNormal']], + ['radar', ['categoryField', 'valueField', 'radiusField']], + ['bar', ['animationDisappear', 'animationState', 'large', 'progressiveStep']] + ]) { + const properties = metadata(chart).effectiveProperties; + for (const name of requiredNames) + assert( + properties.some(p => p.name === name), + `${chart}.${name}` + ); + } + const properties = metadata('bar').effectiveProperties; + assert.equal(properties.find(p => p.name === 'type').required, true); + assert.equal(properties.find(p => p.name === 'series').required, false); +}); + +test('审查拒绝错误枚举和伪造动画类型，而非仅比较生成文件', () => { + const bar = toDistributedMetadata(metadata('bar')); + const wrong = structuredClone(bar); + wrong.effectiveProperties.find(p => p.name === 'direction').type = "'default' | 'reverse'"; + wrong.effectiveProperties.find(p => p.name === 'animationAppear').type = "'grow' | IAnimationConfig"; + const report = auditReferences(context, [source('bar')], references, new Map([['bar', wrong]])); + assert(report.errors.some(e => e.property === 'direction' && e.code === 'TYPE_MISMATCH')); + assert(report.errors.some(e => e.property === 'animationAppear' && e.code === 'TYPE_MISMATCH')); +}); + +test('分发审计拒绝维护字段、丢失配置语义和错误详情目标，诊断仍保留源码位置', () => { + const bar = toDistributedMetadata(metadata('bar')); + const cases = [ + ['PROPERTY_FIELD_MISMATCH', doc => delete doc.effectiveProperties.find(p => p.name === 'direction').dependencies], + ['PROPERTY_FIELD_MISMATCH', doc => delete doc.effectiveProperties.find(p => p.name === 'direction').description], + ['REQUIRED_MISMATCH', doc => delete doc.effectiveProperties.find(p => p.name === 'direction').required], + [ + 'UNEXPECTED_FIELD', + doc => { + doc.effectiveProperties[0].source = 'packages/fake.ts'; + } + ], + [ + 'UNEXPECTED_FIELD', + doc => { + doc.inheritanceTree = {}; + } + ], + [ + 'DETAIL_TARGET_MISMATCH', + doc => { + Object.values(doc.complexTypeDefinitions)[0].reference = 'missing.md'; + } + ], + [ + 'DEFINITION_MISMATCH', + doc => { + Object.values(doc.complexTypeDefinitions)[0].typeName = 'Wrong'; + } + ], + [ + 'METADATA_FIELD_MISMATCH', + doc => { + doc.vchartVersion = '0.0.0'; + } + ] + ]; + for (const [code, mutate] of cases) { + const wrong = structuredClone(bar); + mutate(wrong); + const report = auditReferences(context, [source('bar')], references, new Map([['bar', wrong]])); + assert( + report.errors.some(e => e.code === code), + `${code}: ${JSON.stringify(report.errors)}` + ); + } + const wrong = structuredClone(bar); + wrong.effectiveProperties.find(p => p.name === 'direction').type = "'reverse'"; + const report = auditReferences(context, [source('bar')], references, new Map([['bar', wrong]])); + assert( + report.errors.some( + e => e.code === 'TYPE_MISMATCH' && e.source === 'packages/vchart/src/chart/cartesian/interface.ts' + ) + ); + const extension = toDistributedMetadata(metadata('bar3d')); + delete extension.registration; + assert( + auditReferences(context, [source('bar3d')], references, new Map([['bar3d', extension]])).errors.some( + e => e.code === 'METADATA_FIELD_MISMATCH' && e.field === 'registration' + ) + ); +}); + +test('所有真实图型的分发属性和导航完整保留，只有维护信息被移除', () => { + const propertyKeys = [ + 'name', + 'description', + 'type', + 'required', + 'isSimple', + 'dependencies', + 'defaultValue', + 'since', + 'deprecated', + 'literalValues', + 'dependencyBindings' + ]; + for (const item of manifest.sources) { + const raw = extractChart(context, item); + const doc = toDistributedMetadata(raw); + assert.equal(doc.formatVersion, 3); + assert.deepEqual( + doc.effectiveProperties, + raw.effectiveProperties.map(p => + Object.fromEntries(propertyKeys.filter(k => Object.hasOwn(p, k)).map(k => [k, p[k]])) + ) + ); + assert.deepEqual(Object.keys(doc.complexTypeDefinitions), Object.keys(raw.complexTypeDefinitions)); + for (const [key, definition] of Object.entries(doc.complexTypeDefinitions)) { + assert.equal(definition.reference, raw.complexTypeDefinitions[key].reference); + assert.equal(definition.typeName, raw.complexTypeDefinitions[key].typeName); + assert(!Object.hasOwn(definition, 'filePath')); + } + } +}); + +test('明确的开放契约被记录，扩展来源与注册前提不被核心包替代', () => { + const pictogram = metadata('pictogram'); + assert(pictogram.openContract); + assert(pictogram.sourceFile.startsWith('packages/vchart-extension/src/')); + for (const chart of ['bar3d', 'pie3d', 'funnel3d', 'histogram3d', 'rangeColumn3d', 'wordCloud3d']) { + const meta = metadata(chart); + assert(meta.registration.length > 0); + assert(meta.extensionVersion); + assert.equal(meta.effectiveProperties.find(p => p.name === 'type').literalValues[0], chart); + } + const sequence = toDistributedMetadata(metadata('sequence')); + assert.equal(source('sequence').sourceFile, 'packages/vchart-extension/src/charts/sequence/interface.ts'); + assert.deepEqual(sequence.registration, ['registerSequenceChart']); + assert.equal(sequence.extensionVersion, context.extensionVersion); +}); + +test('相同输入重复抽取逐字节一致，输出没有个人路径或非法依赖名', () => { + for (const item of manifest.sources) { + const first = JSON.stringify(extractChart(context, item)); + assert.equal(first, JSON.stringify(extractChart(context, item))); + assert(!first.includes('/Users/')); + const meta = JSON.parse(first); + for (const prop of meta.effectiveProperties) + for (const dep of prop.dependencies) { + assert(/^[A-Za-z_$][\w$]*$/.test(dep), dep); + assert(meta.complexTypeDefinitions[dep], dep); + } + } +}); + +test('真实 TypeScript 拒绝错误写法，同时保留合法预设与 false', () => { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-contract-')); + const file = path.join(directory, 'cases.ts'); + try { + fs.writeFileSync( + file, + [ + `import type { IBarChartSpec } from '${root}/packages/vchart/src/chart/bar/interface';`, + `const badDirection: Pick = {direction:'reverse'};`, + `const correctDirection: Pick = {direction:'horizontal'};`, + `const badAnimation: Pick = {animationAppear:'grow'};`, + `const correctAnimation: Pick = {animationAppear:{preset:'grow'}};`, + `const disabled: Pick = {animationAppear:false};` + ].join('\n') + ); + const c = createContext(root, [...manifest.sources, { sourceFile: path.relative(root, file) }], manifest); + const diagnostics = c.program.getSemanticDiagnostics(c.program.getSourceFile(file)); + assert.deepEqual( + diagnostics.map(d => d.file.getLineAndCharacterOfPosition(d.start).line + 1), + [2, 4] + ); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +}); + +test('Omit 的图表展开不能冒充完整系列定义', () => { + const seriesFile = context.program.getSourceFile(path.join(root, 'packages/vchart/src/series/bar/interface.ts')); + const declaration = seriesFile.statements.find(n => n.name?.text === 'IBarSeriesSpec'); + const series = context.checker.getTypeAtLocation(declaration); + assert(context.checker.getPropertyOfType(series, 'data')); + assert(context.checker.getPropertyOfType(series, 'tooltip')); + const mapped = metadata('bar').inheritanceTree['IChartExtendsSeriesSpec'].ownProperties; + assert(!mapped.some(p => ['data', 'tooltip', 'morph', 'stackValue'].includes(p.name))); +}); + +test('缺少导入不能被 silently any 掩盖', () => { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-unresolved-')); + const file = path.join(directory, 'missing.ts'); + try { + fs.writeFileSync( + file, + "import type { MissingType } from '@vchart-test/missing-module';\nexport interface BrokenSpec {value: MissingType}\n" + ); + const item = { + chart: 'broken', + typeName: 'BrokenSpec', + sourceFile: path.relative(root, file), + package: '@visactor/vchart' + }; + const c = createContext(root, [item], manifest); + assert.throws(() => extractChart(c, item), /缺少依赖|无法解析导入类型/); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +}); + +test('全部现有入口的导航和作用域可核对', () => { + const result = auditReferences(context, manifest.sources, references); + assert.deepEqual(result.errors, []); + assert.deepEqual(result.changes, []); +}); + +test('check 运行真实 CLI 且不修改任何已生成文件', () => { + const files = [ + ...fs.readdirSync(path.join(references, 'type-meta')).map(f => `type-meta/${f}`), + 'type-details/AdditionalTypes-Type-Definition.md' + ]; + const before = files.map(f => fs.readFileSync(path.join(references, f), 'utf8')); + const result = spawnSync(process.execPath, [path.join(root, 'packages/vchart/scripts/skill-metadata.mjs'), 'check'], { + encoding: 'utf8' + }); + assert.equal(result.status, 0, result.stderr + result.stdout); + assert.deepEqual(JSON.parse(result.stdout).changed, []); + assert.deepEqual( + files.map(f => fs.readFileSync(path.join(references, f), 'utf8')), + before + ); +}); + +test('独立上下文以不同入口顺序解析，属性输出仍一致', () => { + const reversed = createContext(root, [...manifest.sources].reverse(), manifest); + for (const { chart } of manifest.sources) { + assert.deepEqual(extractChart(reversed, source(chart)), metadata(chart)); + } +}); + +test('JSON 中重复键不会因标准解析覆盖而被漏报', () => { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-duplicate-')); + try { + fs.mkdirSync(path.join(directory, 'topkey')); + fs.writeFileSync(path.join(directory, 'topkey/bar.json'), '{"type":{"key":"type"},"type":{"key":"type"}}'); + const result = auditReferences( + context, + [source('bar')], + directory, + new Map([['bar', toDistributedMetadata(metadata('bar'))]]) + ); + assert(result.errors.some(e => e.code === 'DUPLICATE_JSON_KEY' && e.property === 'type')); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +}); + +test('依赖导航：同一属性的同名类型与别名各自定位', () => { + withFixture( + { + 'index.ts': + "import type { Item as A } from './a'; import type { Item as B } from './b'; export interface Spec { value: A | B }", + 'a.ts': 'export interface Item { a: string }', + 'b.ts': 'export interface Item { b: number }' + }, + (c, item, directory, fixtureManifest) => { + const doc = extractChart(c, item); + const value = doc.effectiveProperties.find(p => p.name === 'value'); + assert.equal(value.dependencies.length, 2); + const targets = value.dependencies.map(key => doc.complexTypeDefinitions[key]); + assert.equal(new Set(targets.map(t => t.filePath)).size, 2); + assert(targets.every(t => t.typeName === 'Item')); + assert.notEqual(value.dependencyBindings.A, value.dependencyBindings.B); + assert(doc.complexTypeDefinitions[value.dependencyBindings.A].filePath.endsWith('/a.ts')); + assert(doc.complexTypeDefinitions[value.dependencyBindings.B].filePath.endsWith('/b.ts')); + assert(value.dependencies.every(k => /^Item__[a-f0-9]{12}$/.test(k))); + const refs = fixtureReferences(directory, supplementalDetails(c)); + assert.deepEqual(auditReferences(c, [item], refs, new Map([['fixture', toDistributedMetadata(doc)]])).errors, []); + const wrong = structuredClone(doc); + wrong.effectiveProperties.find(p => p.name === 'value').dependencyBindings.A = value.dependencyBindings.B; + assert( + auditReferences(c, [item], refs, new Map([['fixture', toDistributedMetadata(wrong)]])).errors.some( + e => e.code === 'DEPENDENCY_BINDING_MISMATCH' + ) + ); + fs.writeFileSync( + path.join(directory, 'index.ts'), + "import type { Item as B } from './b'; import type { Item as A } from './a'; export interface Spec { value: B | A }" + ); + const reversed = extractChart(createContext(root, [item], fixtureManifest), item); + assert.deepEqual(reversed.complexTypeDefinitions, doc.complexTypeDefinitions); + assert.deepEqual(reversed.effectiveProperties[0].dependencies, value.dependencies); + } + ); +}); + +test('依赖导航：同符号的两个别名去重且保持短键', () => { + withFixture( + { + 'index.ts': "import type { Item as A, Item as B } from './a'; export interface Spec { value: A | B }", + 'a.ts': 'export interface Item { a: string }' + }, + (c, item) => { + const doc = extractChart(c, item), + value = doc.effectiveProperties[0]; + assert.deepEqual(value.dependencies, ['Item']); + assert.deepEqual(value.dependencyBindings, { A: 'Item', B: 'Item' }); + } + ); +}); + +test('依赖导航：跨属性、泛型及同文件命名空间不覆盖', () => { + withFixture( + { + 'index.ts': + 'namespace A { export interface Item { a: string } }; namespace B { export interface Item { b: number } }; export interface Spec { first: A.Item; second: Record }' + }, + (c, item) => { + const doc = extractChart(c, item), + [first, second] = doc.effectiveProperties; + assert.equal(first.dependencies.length, 1); + assert.equal(second.dependencies.length, 2); + const targets = Object.values(doc.complexTypeDefinitions); + assert.equal(targets.length, 2); + assert.equal(new Set(targets.map(t => t.reference)).size, 2); + const details = supplementalDetails(c); + assert(details.includes('interface Item { a: string }')); + assert(details.includes('interface Item { b: number }')); + } + ); +}); + +test('依赖导航：补充父类型的同名符号链接分别保留', () => { + withFixture( + { + 'index.ts': "import type { Child } from './child'; export interface Spec { value: Child }", + 'child.ts': + "import type { Item as A } from './a'; import type { Item as B } from './b'; export interface Child extends A, B {}", + 'a.ts': 'export interface Item { a: string }', + 'b.ts': 'export interface Item { b: number }' + }, + (c, item) => { + extractChart(c, item); + const details = supplementalDetails(c); + const child = [...c.definitions.values()].find(d => d.symbol.name === 'Child'); + const parents = [...c.definitions.values()].filter(d => d.symbol.name === 'Item'); + assert.equal(parents.length, 2); + for (const parent of parents) assert(section(details, child).includes(`#${parent.anchor}`)); + } + ); +}); + +test('依赖导航：人工详情不能掩盖传递缺模块或缺导出', () => { + for (const missing of [true, false]) { + withFixture( + { + 'index.ts': "import type { Broken } from './middle'; export interface Spec { value: Broken }", + 'middle.ts': `import type { Missing } from './${ + missing ? 'absent' : 'present' + }'; export type Broken = Missing;`, + 'present.ts': 'export interface Other {}' + }, + (c, item) => { + assert.throws( + () => extractChart(c, item), + error => { + assert.match(error.message, /Missing/); + assert.match(error.message, /value/); + assert.match(error.message, /Broken/); + assert.match(error.message, /middle.ts/); + assert.match(error.message, missing ? /absent/ : /present/); + return true; + } + ); + }, + { 'middle.ts#Broken': 'type-details/IData-Type-Definition.md' } + ); + } +}); + +test('依赖导航：无关缺失导入不阻断，显式 any 与循环契约保留', () => { + withFixture( + { + 'index.ts': + "import type { Unused } from './absent'; import type { Valid } from './middle'; interface Cycle { next?: Cycle }; export interface Spec { value: Valid; open: any; dictionary: {[key: string]: any}; cycle: Cycle }", + 'middle.ts': "import type { Unused } from './also-absent'; export type Valid = string;" + }, + (c, item) => { + const doc = extractChart(c, item); + assert.equal(doc.effectiveProperties.find(p => p.name === 'value').type, 'string'); + assert.equal(doc.effectiveProperties.find(p => p.name === 'open').type, 'any'); + assert(doc.effectiveProperties.some(p => p.name === 'cycle')); + }, + { 'middle.ts#Valid': 'type-details/IData-Type-Definition.md' } + ); +}); + +test('依赖导航：typeof 本地枚举具有定义、相关链接及 audit 反例', () => { + withFixture( + { + 'index.ts': + "enum AxisDirection { horizontal = 'horizontal', vertical = 'vertical' }; type Direction = keyof typeof AxisDirection; export interface Spec { config: { direction: Direction } }" + }, + (c, item, directory) => { + const doc = extractChart(c, item), + details = supplementalDetails(c); + const alias = [...c.definitions.values()].find(d => d.symbol.name === 'Direction'); + const enumeration = [...c.definitions.values()].find(d => d.symbol.name === 'AxisDirection'); + assert(enumeration); + assert(section(details, alias).includes(`#${enumeration.anchor}`)); + assert(section(details, enumeration).includes("horizontal = 'horizontal'")); + const refs = fixtureReferences(directory, details); + assert.deepEqual(auditReferences(c, [item], refs, new Map([['fixture', toDistributedMetadata(doc)]])).errors, []); + fs.writeFileSync( + path.join(refs, 'type-details/AdditionalTypes-Type-Definition.md'), + details.replace(`id="${enumeration.anchor}"`, 'id="removed"') + ); + assert( + auditReferences(c, [item], refs, new Map([['fixture', toDistributedMetadata(doc)]])).errors.some( + e => e.code === 'MISSING_DETAIL_ANCHOR' + ) + ); + } + ); +}); + +test('依赖导航：typeof 导入、限定成员、同名值和常量对象不串来源', () => { + withFixture( + { + 'index.ts': + "import { Mode as A } from './a'; import { Mode as B } from './b'; import * as Namespace from './b'; const Values = { alpha: 'alpha', beta: 'beta' } as const; type First = keyof typeof A; type Second = keyof typeof Namespace.Mode; type Member = typeof B.beta; type Keys = keyof typeof Values; export interface Spec { config: { first: First; second: Second; member: Member; keys: Keys } }", + 'a.ts': "export enum Mode { alpha = 'alpha' }", + 'b.ts': "export enum Mode { beta = 'beta' }" + }, + (c, item) => { + extractChart(c, item); + const details = supplementalDetails(c); + const definitions = [...c.definitions.values()]; + const modes = definitions.filter(d => d.symbol.name === 'Mode'); + assert.equal(modes.length, 2); + const first = definitions.find(d => d.symbol.name === 'First'); + assert(section(details, first).includes(`#${modes.find(d => d.filePath.endsWith('/a.ts')).anchor}`)); + const member = definitions.find(d => d.symbol.name === 'Member'); + const secondMode = modes.find(d => d.filePath.endsWith('/b.ts')); + assert(section(details, member).includes(`#${secondMode.anchor}`)); + assert(section(details, secondMode).includes('enum Mode')); + assert(definitions.some(d => d.symbol.name === 'Values')); + assert(details.includes("alpha: 'alpha'")); + } + ); +}); + +test('依赖导航：typeof 缺失导入被人工详情校验拒绝，循环类型查询不死循环', () => { + withFixture( + { + 'index.ts': "import type { Broken } from './middle'; export interface Spec { value: Broken }", + 'middle.ts': "import { Missing } from './absent'; export type Broken = keyof typeof Missing;" + }, + (c, item) => assert.throws(() => extractChart(c, item), /Missing/), + { + 'middle.ts#Broken': 'type-details/IData-Type-Definition.md' + } + ); + withFixture( + { + 'index.ts': + 'declare const current: Config; interface Config { next?: typeof current }; export interface Spec { config: Config }' + }, + (c, item) => assert(extractChart(c, item).effectiveProperties.some(p => p.name === 'config')) + ); +}); + +test('依赖导航：真实 Direction 和 RenderMode 枚举来自正确模块', () => { + for (const item of manifest.sources) extractChart(context, item); + const details = supplementalDetails(context); + for (const [aliasName, targetName, expectedSource] of [ + ['DirectionType', 'Direction', 'packages/vchart/src/typings/space.ts'], + ['RenderMode', 'RenderModeEnum', 'packages/vchart/src/typings/spec/common.ts'] + ]) { + const definitions = [...context.definitions.values()]; + const alias = definitions.find(d => d.symbol.name === aliasName && d.filePath === expectedSource); + const enumeration = definitions.find(d => d.symbol.name === targetName && d.filePath === expectedSource); + assert(enumeration, targetName); + assert(section(details, alias).includes(`#${enumeration.anchor}`)); + if (targetName === 'Direction') { + assert(section(details, enumeration).includes("horizontal = 'horizontal'")); + assert(!section(details, enumeration).includes("reverse = 'reverse'")); + } + } +}); + +test('依赖导航：generate 在传递依赖错误时不写部分文件', () => { + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-cli-')); + const write = (name, text) => { + const file = path.join(directory, name); + fs.mkdirSync(path.dirname(file), { recursive: true }); + fs.writeFileSync(file, text); + }; + try { + for (const name of ['skill-metadata.mjs', 'skill-metadata/extract.mjs', 'skill-metadata/distribution.mjs']) + write(`packages/vchart/scripts/${name}`, fs.readFileSync(path.join(root, 'packages/vchart/scripts', name))); + for (const name of [ + 'packages/vchart/package.json', + 'packages/vchart/tsconfig.json', + 'packages/vchart-extension/package.json' + ]) + write(name, fs.readFileSync(path.join(root, name))); + fs.symlinkSync( + path.join(root, 'packages/vchart/node_modules'), + path.join(directory, 'packages/vchart/node_modules'), + 'dir' + ); + const gitDir = execFileSync('git', ['rev-parse', '--absolute-git-dir'], { cwd: root, encoding: 'utf8' }).trim(); + write('.git', `gitdir: ${gitDir}\n`); + write( + 'packages/vchart/src/index.ts', + "import type { Broken } from './middle'; export interface Spec { value: Broken }" + ); + write('packages/vchart/src/good.ts', 'export interface GoodSpec { value: string }'); + write('packages/vchart/src/middle.ts', "import type { Missing } from './absent'; export type Broken = Missing;"); + write( + 'packages/vchart/scripts/skill-metadata/metadata-sources.json', + JSON.stringify({ + sources: [ + { + chart: 'good', + typeName: 'GoodSpec', + sourceFile: 'packages/vchart/src/good.ts', + package: '@visactor/vchart' + }, + { + chart: 'fixture', + typeName: 'Spec', + sourceFile: 'packages/vchart/src/index.ts', + package: '@visactor/vchart' + } + ], + detailReferences: { 'packages/vchart/src/middle.ts#Broken': 'type-details/IData-Type-Definition.md' } + }) + ); + write( + 'skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md', + fs.readFileSync(path.join(references, 'type-details/IData-Type-Definition.md')) + ); + const output = path.join(directory, 'output'); + write('output/sentinel.txt', 'keep'); + const result = spawnSync( + process.execPath, + [ + fs.realpathSync(path.join(directory, 'packages/vchart/scripts/skill-metadata.mjs')), + 'generate', + '--output', + output + ], + { encoding: 'utf8' } + ); + assert.notEqual(result.status, 0, result.stdout); + assert.match(result.stderr, /Missing|absent/); + assert.match(result.stderr, /value/); + assert.equal(fs.readFileSync(path.join(output, 'sentinel.txt'), 'utf8'), 'keep'); + assert.deepEqual(fs.readdirSync(output), ['sentinel.txt']); + } finally { + fs.rmSync(directory, { recursive: true, force: true }); + } +}); + +test('依赖导航：跨模块属性与嵌套泛型使用各自同名目标', () => { + withFixture( + { + 'index.ts': + "import type { Item as A } from './a'; import type { Item as B } from './b'; export interface Spec { first: A; second: B; nested: Record }", + 'a.ts': 'export interface Item { a: string }', + 'b.ts': 'export interface Item { b: number }' + }, + (c, item) => { + const doc = extractChart(c, item); + const prop = name => doc.effectiveProperties.find(p => p.name === name); + assert.notDeepEqual(prop('first').dependencies, prop('second').dependencies); + assert.equal(prop('nested').dependencies.length, 2); + assert.equal(prop('nested').dependencyBindings.A, prop('first').dependencies[0]); + assert.equal(prop('nested').dependencyBindings.B, prop('second').dependencies[0]); + } + ); +}); + +test('依赖导航：循环链校验失败后不会缓存部分成功状态', () => { + withFixture( + { + 'index.ts': + "import type { Missing } from './absent'; interface A { b: B; c: C }; interface B { a: A }; interface C { missing: Missing }; export interface Spec { value: A }; export interface SecondSpec { value: B }" + }, + (c, item) => { + assert.throws(() => extractChart(c, item), /Missing/); + assert.throws(() => extractChart(c, { ...item, typeName: 'SecondSpec' }), /Missing/); + } + ); +}); diff --git a/packages/vchart/scripts/skill-metadata/distribution.mjs b/packages/vchart/scripts/skill-metadata/distribution.mjs new file mode 100644 index 0000000000..4ca04c4b6a --- /dev/null +++ b/packages/vchart/scripts/skill-metadata/distribution.mjs @@ -0,0 +1,46 @@ +export const metadataFields = [ + 'typeName', + 'formatVersion', + 'vchartVersion', + 'extensionVersion', + 'effectiveProperties', + 'complexTypeDefinitions', + 'registration', + 'registrationNote', + 'initializationIncludes', + 'openContract', + 'contractNotes' +]; +export const propertyFields = [ + 'name', + 'description', + 'type', + 'required', + 'isSimple', + 'dependencies', + 'defaultValue', + 'since', + 'deprecated', + 'literalValues', + 'dependencyBindings' +]; +export const definitionFields = ['typeName', 'reference', 'package', 'version']; +export const contractNoteFields = ['description', 'example']; + +const pick = (value, fields) => + Object.fromEntries(fields.filter(key => Object.hasOwn(value, key)).map(key => [key, value[key]])); + +/** 内部抽取模型保留来源和继承过程；技能只分发配置知识和导航。 */ +export function toDistributedMetadata(metadata) { + return { + ...pick(metadata, metadataFields), + formatVersion: 3, + effectiveProperties: metadata.effectiveProperties.map(property => pick(property, propertyFields)), + complexTypeDefinitions: Object.fromEntries( + Object.entries(metadata.complexTypeDefinitions).map(([key, value]) => [key, pick(value, definitionFields)]) + ), + ...(metadata.contractNotes + ? { contractNotes: metadata.contractNotes.map(note => pick(note, contractNoteFields)) } + : {}) + }; +} diff --git a/packages/vchart/scripts/skill-metadata/distribution.test.mjs b/packages/vchart/scripts/skill-metadata/distribution.test.mjs new file mode 100644 index 0000000000..afca4ea8e4 --- /dev/null +++ b/packages/vchart/scripts/skill-metadata/distribution.test.mjs @@ -0,0 +1,101 @@ +import assert from 'node:assert/strict'; +import { test } from 'node:test'; +import { toDistributedMetadata } from './distribution.mjs'; + +test('分发保留配置语义和合法空值，不携带维护字段或修改输入', () => { + const raw = { + typeName: 'Spec', + formatVersion: 2, + vchartVersion: '2.1.7', + sourceHash: 'maintenance-only', + inheritanceTree: {}, + effectiveProperties: [ + { + name: 'enabled', + description: '是否启用', + type: 'boolean | undefined', + originalType: 'boolean', + required: false, + isSimple: true, + dependencies: [], + defaultValue: false, + since: '1.11.2 支持百分比字符串', + deprecated: false, + source: 'packages/example.ts', + inheritedFrom: 'Spec', + category: '未分类' + } + ], + complexTypeDefinitions: {} + }; + const before = structuredClone(raw); + const published = toDistributedMetadata(raw); + assert.deepEqual(published, { + typeName: 'Spec', + formatVersion: 3, + vchartVersion: '2.1.7', + effectiveProperties: [ + { + name: 'enabled', + description: '是否启用', + type: 'boolean | undefined', + required: false, + isSimple: true, + dependencies: [], + defaultValue: false, + since: '1.11.2 支持百分比字符串', + deprecated: false + } + ], + complexTypeDefinitions: {} + }); + assert.deepEqual(raw, before); + assert.deepEqual(toDistributedMetadata(raw), published); + for (const value of [0, '', null]) { + raw.effectiveProperties[0].defaultValue = value; + assert.equal(toDistributedMetadata(raw).effectiveProperties[0].defaultValue, value); + } +}); + +test('分发保留同名导航、别名绑定、外部版本和扩展行为约束', () => { + const raw = { + typeName: 'Spec', + vchartVersion: '2.1.7', + extensionVersion: '2.1.7', + registration: ['registerChart'], + registrationNote: '由宿主注册', + initializationIncludes: ['register3DPlugin'], + openContract: '开放契约', + contractNotes: [{ description: '真实行为差异', sourceFile: 'example.ts', example: { width: 20 } }], + effectiveProperties: [ + { + name: 'value', + description: '配置', + type: 'A | B', + required: true, + isSimple: false, + dependencies: ['Item_a', 'Item_b'], + dependencyBindings: { A: 'Item_a', B: 'Item_b' } + } + ], + complexTypeDefinitions: { + Item_a: { typeName: 'Item', filePath: 'a.ts', reference: 'details.md#a' }, + Item_b: { + typeName: 'Item', + filePath: 'b.ts', + reference: 'details.md#b', + package: '@example/pkg', + version: '1.2.3' + } + } + }; + const doc = toDistributedMetadata(raw); + assert.deepEqual(doc.effectiveProperties, raw.effectiveProperties); + assert.deepEqual(doc.complexTypeDefinitions, { + Item_a: { typeName: 'Item', reference: 'details.md#a' }, + Item_b: { typeName: 'Item', reference: 'details.md#b', package: '@example/pkg', version: '1.2.3' } + }); + assert.deepEqual(doc.contractNotes, [{ description: '真实行为差异', example: { width: 20 } }]); + for (const key of ['registration', 'registrationNote', 'initializationIncludes', 'openContract', 'extensionVersion']) + assert.deepEqual(doc[key], raw[key]); +}); diff --git a/packages/vchart/scripts/skill-metadata/extract.mjs b/packages/vchart/scripts/skill-metadata/extract.mjs new file mode 100644 index 0000000000..2a302c615b --- /dev/null +++ b/packages/vchart/scripts/skill-metadata/extract.mjs @@ -0,0 +1,720 @@ +import fs from 'node:fs'; +import path from 'node:path'; +import { createRequire } from 'node:module'; +import { createHash } from 'node:crypto'; +import { execFileSync } from 'node:child_process'; +import { isDeepStrictEqual } from 'node:util'; +import { toDistributedMetadata, metadataFields, propertyFields, definitionFields } from './distribution.mjs'; + +const json = file => JSON.parse(fs.readFileSync(file, 'utf8')); +const hash = text => createHash('sha256').update(text).digest('hex'); +const ordered = items => [...items].sort((a, b) => a.localeCompare(b, 'en')); + +/** 维护工具只使用本仓库依赖；核心包的两个导入入口始终解析到同一源码。 */ +export function createContext(repoRoot, sources, manifest = {}) { + const require = createRequire(path.join(repoRoot, 'packages/vchart/package.json')); + const ts = require('typescript'); + const config = ts.readConfigFile(path.join(repoRoot, 'packages/vchart/tsconfig.json'), ts.sys.readFile); + if (config.error) throw new Error(ts.flattenDiagnosticMessageText(config.error.messageText, '\n')); + const parsed = ts.parseJsonConfigFileContent(config.config, ts.sys, path.join(repoRoot, 'packages/vchart')); + if (parsed.errors.length) throw new Error(ts.flattenDiagnosticMessageText(parsed.errors[0].messageText, '\n')); + const options = { ...parsed.options, noEmit: true, composite: false, strictNullChecks: true, types: [] }; + const host = ts.createCompilerHost(options); + const unresolved = []; + host.resolveModuleNames = (names, containingFile) => + names.map(name => { + if (name === '@visactor/vchart' || name.startsWith('@visactor/vchart/esm/')) { + const subpath = name === '@visactor/vchart' ? 'index' : name.slice('@visactor/vchart/esm/'.length); + const base = path.join(repoRoot, 'packages/vchart/src', subpath); + const file = [base + '.ts', path.join(base, 'index.ts')].find(fs.existsSync); + if (file) return { resolvedFileName: file, extension: ts.Extension.Ts, isExternalLibraryImport: false }; + } + const resolved = ts.resolveModuleName(name, containingFile, options, ts.sys).resolvedModule; + if (!resolved) unresolved.push({ file: containingFile, module: name }); + return resolved; + }); + const program = ts.createProgram( + sources.map(s => path.join(repoRoot, s.sourceFile)), + options, + host + ); + const checker = program.getTypeChecker(); + const context = { + repoRoot, + sources, + manifest, + ts, + program, + checker, + unresolved, + referencesRoot: path.join(repoRoot, 'skills/vchart-development-assistant/references'), + definitions: new Map(), + version: json(path.join(repoRoot, 'packages/vchart/package.json')).version, + extensionVersion: json(path.join(repoRoot, 'packages/vchart-extension/package.json')).version + }; + // 包版本与实际读取的文件内容决定指纹；不把当前时间和无关文档的 HEAD 算作输入。 + const input = program.getSourceFiles().filter(f => !program.isSourceFileDefaultLibrary(f)); + const noteSources = sources.flatMap(s => + (s.contractNotes || []).map(n => `${n.sourceFile}\0${hash(fs.readFileSync(path.join(repoRoot, n.sourceFile)))}`) + ); + context.sourceHash = hash( + JSON.stringify({ + typescript: ts.version, + vchart: context.version, + extension: context.extensionVersion, + manifest, + files: ordered([...input.map(f => `${location(context, f).filePath}\0${hash(f.text)}`), ...noteSources]) + }) + ); + context.sourceRevision = execFileSync( + 'git', + [ + 'log', + '-1', + '--format=%H', + '--', + 'packages/vchart/src', + 'packages/vchart-extension/src', + 'packages/vchart/package.json', + 'packages/vchart-extension/package.json' + ], + { cwd: repoRoot, encoding: 'utf8' } + ).trim(); + return context; +} + +function location(context, declaration) { + const file = declaration.getSourceFile ? declaration.getSourceFile().fileName : declaration.fileName; + const real = fs.realpathSync(file); + if (!real.includes(`${path.sep}node_modules${path.sep}`)) + return { filePath: path.relative(context.repoRoot, file).split(path.sep).join('/') }; + let directory = path.dirname(real); + while (!fs.existsSync(path.join(directory, 'package.json'))) { + const parent = path.dirname(directory); + if (parent === directory) throw new Error(`外部类型缺少包来源：${file}`); + directory = parent; + } + const pkg = json(path.join(directory, 'package.json')); + return { + filePath: `${pkg.name}/${path.relative(directory, real).split(path.sep).join('/')}`, + package: pkg.name, + version: pkg.version + }; +} + +function resolveSymbol(context, node) { + const { ts, checker } = context; + let symbol = checker.getSymbolAtLocation(node); + const imported = symbol?.declarations?.[0]; + let importDeclaration = imported; + while (importDeclaration && !ts.isImportDeclaration(importDeclaration) && !ts.isExportDeclaration(importDeclaration)) + importDeclaration = importDeclaration.parent; + const module = importDeclaration?.moduleSpecifier?.text; + if (symbol?.flags & ts.SymbolFlags.Alias) symbol = checker.getAliasedSymbol(symbol); + if (!symbol?.declarations?.length || symbol.name === 'unknown') + throw new Error( + `无法解析导入类型：${node.getText()}${module ? `，模块 ${module}` : ''} (${location(context, node).filePath})` + ); + return symbol; +} + +function identity(context, symbol) { + context.identities ||= new Map(); + if (!context.identities.has(symbol)) { + const declaration = symbol.declarations[0]; + const names = [symbol.name]; + for (let parent = declaration.parent; parent; parent = parent.parent) + if ( + (context.ts.isModuleDeclaration(parent) || + context.ts.isClassDeclaration(parent) || + context.ts.isInterfaceDeclaration(parent) || + context.ts.isEnumDeclaration(parent)) && + parent.name + ) + names.unshift(parent.name.getText()); + context.identities.set(symbol, `${location(context, declaration).filePath}#${names.join('.')}`); + } + return context.identities.get(symbol); +} + +function addEdge(context, found, symbol, expression) { + const { ts, program } = context; + const declaration = symbol.declarations?.[0]; + if ( + !declaration || + ts.isTypeParameterDeclaration(declaration) || + program.isSourceFileDefaultLibrary(declaration.getSourceFile()) + ) + return; + const id = identity(context, symbol); + let edge = found.get(id); + if (!edge) found.set(id, (edge = { id, symbol, expressions: new Set() })); + if (expression) edge.expressions.add(expression); +} + +function mergeEdges(...maps) { + const result = new Map(); + for (const map of maps) + for (const [id, edge] of map) { + const previous = result.get(id); + if (previous) for (const expression of edge.expressions) previous.expressions.add(expression); + else result.set(id, { ...edge, expressions: new Set(edge.expressions) }); + } + return result; +} + +/** 只读取声明中的类型位置；不访问函数体或无关导入。 */ +function dependencies(context, declaration) { + context.dependencyNodes ||= new Map(); + if (context.dependencyNodes.has(declaration)) return context.dependencyNodes.get(declaration); + const { ts } = context; + const result = new Map(); + function visit(node) { + if (ts.isBlock(node)) return; + if (ts.isTypeReferenceNode(node) || ts.isExpressionWithTypeArguments(node)) { + const name = node.typeName || node.expression; + addEdge(context, result, resolveSymbol(context, name), name.getText()); + } else if (ts.isTypeQueryNode(node)) { + let symbol = resolveSymbol(context, node.exprName); + const target = symbol.declarations[0]; + // 枚举成员必须连同所属枚举展示，不能摘录为无上下文的孤立成员。 + if (ts.isEnumMember(target)) symbol = resolveSymbol(context, target.parent.name); + addEdge(context, result, symbol, node.exprName.getText()); + } + ts.forEachChild(node, visit); + } + if (declaration?.type) visit(declaration.type); + for (const heritage of declaration?.heritageClauses || []) visit(heritage); + for (const member of declaration?.members || []) visit(member); + for (const parameter of declaration?.parameters || []) if (parameter.type) visit(parameter.type); + for (const parameter of declaration?.typeParameters || []) { + if (parameter.constraint) visit(parameter.constraint); + if (parameter.default) visit(parameter.default); + } + context.dependencyNodes.set(declaration, result); + return result; +} + +/** 展示入口不能决定校验范围；成功完成整条类型链后才提交缓存。 */ +function validateReachableDependencies(context, declaration, trace) { + context.validatedDeclarations ||= new Set(); + const visiting = new Set(), + completed = new Set(); + function validate(node, chain) { + if (context.validatedDeclarations.has(node) || visiting.has(node) || completed.has(node)) return; + visiting.add(node); + try { + for (const edge of dependencies(context, node).values()) + for (const child of edge.symbol.declarations) validate(child, [...chain, edge.symbol.name]); + completed.add(node); + } catch (error) { + if (!error.metadataTrace) { + error.message = `类型依赖解析失败：${chain.join(' → ')}：${error.message}`; + error.metadataTrace = true; + } + throw error; + } finally { + visiting.delete(node); + } + } + validate(declaration, trace); + for (const node of completed) context.validatedDeclarations.add(node); +} + +function describe(context, type, declaration, expand = false) { + const { ts, checker } = context; + const text = checker.typeToString( + type, + declaration, + ts.TypeFormatFlags.NoTruncation | + ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope | + (expand ? ts.TypeFormatFlags.InTypeAlias : 0) + ); + return canonicalType(context, text); +} + +function canonicalType(context, text, optional = false) { + const { ts } = context; + const key = `${optional}\0${text}`; + context.typeText ||= new Map(); + if (context.typeText.has(key)) return context.typeText.get(key); + // TS 会按首次查询时的类型缓存排列联合成员。按语法节点规范化，保持无关查询后的稳定输出。 + const source = ts.createSourceFile('metadata-type.ts', `type Result = ${text};`, ts.ScriptTarget.Latest, true); + if (source.parseDiagnostics.length) throw new Error(`无法序列化真实类型：${text}`); + const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed, removeComments: true }); + let original = source.statements[0].type; + if (optional && ts.isUnionTypeNode(original)) + original = ts.factory.updateUnionTypeNode( + original, + original.types.filter(t => t.kind !== ts.SyntaxKind.UndefinedKeyword) + ); + const transformed = ts.transform(original, [ + transform => { + const visit = node => { + node = ts.visitEachChild(node, visit, transform); + if (ts.isStringLiteral(node)) return ts.factory.createStringLiteral(node.text); + if (ts.isUnionTypeNode(node)) + return ts.factory.updateUnionTypeNode( + node, + [...node.types].sort((a, b) => + printer + .printNode(ts.EmitHint.Unspecified, a, source) + .localeCompare(printer.printNode(ts.EmitHint.Unspecified, b, source), 'en') + ) + ); + return node; + }; + return node => ts.visitNode(node, visit); + } + ]); + try { + const result = printer.printNode(ts.EmitHint.Unspecified, transformed.transformed[0], source); + context.typeText.set(key, result); + return result; + } finally { + transformed.dispose(); + } +} + +function boundDependencies(context, type, found = new Map(), visited = new Set()) { + if (visited.has(type)) return found; + visited.add(type); + const { ts, checker } = context; + const symbol = type.aliasSymbol || type.symbol; + const declaration = symbol?.declarations?.[0]; + if (declaration && !symbol.name.startsWith('__')) addEdge(context, found, symbol); + for (const argument of type.aliasTypeArguments || []) boundDependencies(context, argument, found, visited); + if (type.aliasSymbol) return found; + for (const child of type.types || []) boundDependencies(context, child, found, visited); + if (type.objectFlags & ts.ObjectFlags.Reference) + for (const argument of checker.getTypeArguments(type)) boundDependencies(context, argument, found, visited); + return found; +} + +function simple(context, type) { + const { ts } = context; + if (type.isUnion()) return type.types.every(t => simple(context, t)); + return !!( + type.flags & + (ts.TypeFlags.StringLike | + ts.TypeFlags.NumberLike | + ts.TypeFlags.BooleanLike | + ts.TypeFlags.Null | + ts.TypeFlags.Undefined | + ts.TypeFlags.Never) + ); +} + +function addDefinition(context, symbol) { + const declaration = symbol.declarations[0]; + const source = location(context, declaration); + const id = identity(context, symbol); + if (!context.definitions.has(id)) { + const anchor = `type-${hash(id).slice(0, 12)}`; + const reference = + context.manifest.detailReferences?.[id] || `type-details/AdditionalTypes-Type-Definition.md#${anchor}`; + context.definitions.set(id, { id, symbol, declaration, anchor, reference, ...source }); + // 没有人工详情时补真实声明及必要父类型；已有详情不展开成整个依赖手册。 + if (reference.includes('AdditionalTypes-') && !source.package) { + for (const dependency of dependencies(context, declaration).values()) + if (dependency.symbol !== symbol) addDefinition(context, dependency.symbol); + } + } + const item = context.definitions.get(id); + return { + typeName: symbol.name, + filePath: item.filePath, + reference: item.reference, + ...(item.package ? { package: item.package, version: item.version } : {}) + }; +} + +function property(context, symbol, owner, trace) { + const { ts, checker } = context; + const declaration = symbol.declarations?.[0]; + if (!declaration) throw new Error(`属性缺少真实声明：${symbol.name}`); + validateReachableDependencies(context, declaration, trace); + const type = checker.getTypeOfSymbolAtLocation(symbol, owner); + const isSimple = simple(context, type); + const edges = isSimple ? new Map() : mergeEdges(dependencies(context, declaration), boundDependencies(context, type)); + const definitions = new Map(); + for (const [id, edge] of edges) definitions.set(id, addDefinition(context, edge.symbol)); + const raw = declaration.type?.getText() || describe(context, type, declaration); + const result = { + name: symbol.name, + description: ts.displayPartsToString(symbol.getDocumentationComment(checker)) || `${symbol.name} 配置`, + type: describe(context, type, declaration, simple(context, type)), + originalType: raw, + required: !(symbol.flags & ts.SymbolFlags.Optional), + category: '未分类', + isSimple, + dependencies: [], + source: location(context, declaration).filePath, + ...(declaration.parent?.name ? { inheritedFrom: declaration.parent.name.getText() } : {}) + }; + const tags = symbol.getJsDocTags(checker); + for (const [tag, key] of [ + ['default', 'defaultValue'], + ['since', 'since'], + ['deprecated', 'deprecated'] + ]) { + const found = tags.find(t => t.name === tag); + if (found) result[key] = ts.displayPartsToString(found.text || []) || true; + } + const parts = type.isUnion() ? type.types : [type]; + const literals = parts + .filter(t => t.flags & (ts.TypeFlags.StringLiteral | ts.TypeFlags.NumberLiteral)) + .map(t => t.value); + if (literals.length) + result.literalValues = [...new Set(literals)].sort((a, b) => String(a).localeCompare(String(b), 'en')); + return { result, definitions, edges }; +} + +export function extractChart(context, source) { + const { checker, ts, program } = context; + const file = program.getSourceFile(path.join(context.repoRoot, source.sourceFile)); + const node = file?.statements.find(s => s.name?.text === source.typeName); + if (!node) throw new Error(`入口缺少公开声明：${source.sourceFile}#${source.typeName}`); + const root = checker.getTypeAtLocation(node); + const tree = {}, + definitions = new Map(), + pending = []; + const visited = new Set(); + function properties(type, owner) { + return checker + .getPropertiesOfType(type) + .map(symbol => { + const { result, definitions: found, edges } = property(context, symbol, owner, [source.chart, symbol.name]); + for (const [id, target] of found) definitions.set(id, target); + pending.push({ result, edges }); + return result; + }) + .sort((a, b) => a.name.localeCompare(b.name, 'en')); + } + function walk(type, label, owner) { + if (visited.has(type)) return; + visited.add(type); + const symbol = type.aliasSymbol || type.symbol; + const declaration = symbol?.declarations?.[0] || owner; + const bases = type.getBaseTypes?.() || []; + const hasMembers = !!declaration.members; + const all = properties(type, owner); + const own = hasMembers + ? all.filter(p => checker.getPropertyOfType(type, p.name)?.declarations?.some(d => d.parent === declaration)) + : all; + tree[label] = { + description: `${label} 的真实类型声明`, + directExtends: bases.map(b => describe(context, b, owner)), + ownProperties: own, + ...(!hasMembers ? { resolvedMapping: true } : {}) + }; + for (const base of bases) walk(base, describe(context, base, owner), owner); + } + walk(root, source.typeName, node); + const effectiveProperties = properties(root, node); + const groups = new Map(), + keys = new Map(), + usedKeys = new Set(); + for (const [id, target] of definitions) { + const group = groups.get(target.typeName) || []; + group.push(id); + groups.set(target.typeName, group); + } + for (const [name, ids] of groups) + for (const id of ids) { + const key = ids.length === 1 ? name : `${name}__${hash(id).slice(0, 12)}`; + if (usedKeys.has(key)) throw new Error(`类型导航键冲突：${key}`); + usedKeys.add(key); + keys.set(id, key); + } + for (const { result, edges } of pending) { + result.dependencies = ordered([...edges.keys()].map(id => keys.get(id))); + const bindings = new Map(); + for (const [id, edge] of edges) + for (const expression of edge.expressions) { + if (expression === keys.get(id)) continue; + if (bindings.has(expression) && bindings.get(expression) !== keys.get(id)) + throw new Error(`同一声明的类型拼写无法区分：${source.chart}.${result.name}.${expression}`); + bindings.set(expression, keys.get(id)); + } + if (bindings.size) + result.dependencyBindings = Object.fromEntries(ordered(bindings.keys()).map(k => [k, bindings.get(k)])); + } + const doc = { + typeName: source.typeName, + description: `${source.typeName} 公开配置类型`, + inheritanceTree: tree, + effectiveProperties, + formatVersion: 2, + version: '2.0.0', + vchartVersion: context.version, + typescriptVersion: ts.version, + ...(source.package === '@visactor/vchart-extension' ? { extensionVersion: context.extensionVersion } : {}), + sourceFile: source.sourceFile, + sourceHash: context.sourceHash, + sourceRevision: context.sourceRevision, + ...(source.registration + ? { + registration: source.registration, + registrationNote: source.registrationNote || '由宿主注册扩展图型，注册代码不属于 spec。' + } + : {}), + ...(source.initializationIncludes ? { initializationIncludes: source.initializationIncludes } : {}), + ...(source.openContract ? { openContract: source.openContract } : {}), + ...(source.contractNotes ? { contractNotes: source.contractNotes } : {}), + complexTypeDefinitions: Object.fromEntries( + [...definitions].map(([id, target]) => [keys.get(id), target]).sort(([a], [b]) => a.localeCompare(b, 'en')) + ), + statistics: { + totalInterfaces: Object.keys(tree).length, + totalProperties: Object.values(tree).reduce((n, t) => n + t.ownProperties.length, 0), + effectiveProperties: effectiveProperties.length, + complexTypes: definitions.size + } + }; + if (JSON.stringify(doc).includes(context.repoRoot)) throw new Error(`类型序列化泄漏绝对路径：${source.chart}`); + return doc; +} + +export function supplementalDetails(context) { + const lines = [ + '# 补充公开类型声明', + '', + '本文件由维护工具按实际符号生成，保留类型与继承，不代替已有人工说明。外部声明注明包及版本；类型参数按各调用处实例化。', + '' + ]; + const items = [...context.definitions.values()] + .filter(i => i.reference.includes('AdditionalTypes-')) + .sort((a, b) => a.id.localeCompare(b.id, 'en')); + lines.push('## 类型索引', '', ...items.map(i => `- [${i.symbol.name}](#${i.anchor})`), ''); + for (const item of items) { + lines.push( + ``, + `## ${item.symbol.name}`, + '', + `来源：\`${item.filePath}\`${item.package ? `，${item.package}@${item.version}` : `，VChart ${context.version}`}`, + '', + '```typescript', + item.declaration.getText(), + '```', + '' + ); + if (item.package) + lines.push( + '这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。', + '' + ); + const related = item.package + ? [] + : [...dependencies(context, item.declaration).values()].filter(edge => edge.symbol !== item.symbol); + if (related.length) + lines.push( + '相关定义：' + + related + .map(edge => { + const target = addDefinition(context, edge.symbol); + const label = ordered(edge.expressions).join(' / ') || edge.symbol.name; + return `[${label}](${path.posix.relative('type-details', target.reference.split('#')[0])}${ + target.reference.includes('#') ? '#' + target.reference.split('#')[1] : '' + })`; + }) + .join('、'), + '' + ); + } + return lines.join('\n'); +} + +export function auditReferences(context, sources, referencesRoot, supplied = new Map()) { + const errors = [], + changes = [], + boundaries = []; + function readDocument(file, chart) { + const text = fs.readFileSync(file, 'utf8'); + const parsed = context.ts.parseJsonText(file, text); + function visit(node) { + if (context.ts.isObjectLiteralExpression(node)) { + const names = new Set(); + for (const property of node.properties) { + const name = property.name?.text; + if (names.has(name)) errors.push({ chart, code: 'DUPLICATE_JSON_KEY', property: name }); + names.add(name); + } + } + context.ts.forEachChild(node, visit); + } + visit(parsed); + return JSON.parse(text); + } + const extracted = new Map(sources.map(source => [source.chart, extractChart(context, source)])); + const allProperties = new Set([...extracted.values()].flatMap(d => d.effectiveProperties.map(p => p.name))); + for (const source of sources) { + const expectedRaw = extracted.get(source.chart); + const expected = toDistributedMetadata(expectedRaw); + const filename = path.join(referencesRoot, 'type-meta', `${source.chart}.json`); + const actual = + supplied.get(source.chart) || (fs.existsSync(filename) ? readDocument(filename, source.chart) : null); + const emit = (code, extra = {}) => errors.push({ chart: source.chart, code, ...extra }); + if (!actual) { + emit('MISSING_METADATA'); + continue; + } + function checkFields(value, expectedValue, fields, code, extra = {}, skip = []) { + for (const field of Object.keys(value)) + if (!fields.includes(field)) emit('UNEXPECTED_FIELD', { ...extra, field }); + for (const field of fields) + if ( + Object.hasOwn(value, field) !== Object.hasOwn(expectedValue, field) || + (!skip.includes(field) && !isDeepStrictEqual(value[field], expectedValue[field])) + ) + emit(code, { ...extra, field, metadata: value[field], actual: expectedValue[field] }); + } + checkFields(actual, expected, metadataFields, 'METADATA_FIELD_MISMATCH', {}, [ + 'effectiveProperties', + 'complexTypeDefinitions' + ]); + if (actual.formatVersion !== 3 || !Array.isArray(actual.effectiveProperties)) { + emit('INVALID_METADATA_FORMAT'); + continue; + } + const recorded = actual.effectiveProperties; + const byName = new Map(recorded.map(p => [p.name, p])); + if (byName.size !== recorded.length) emit('DUPLICATE_METADATA_PROPERTY'); + const rawByName = new Map(expectedRaw.effectiveProperties.map(p => [p.name, p])); + const knownNames = new Set(expected.effectiveProperties.map(p => p.name)); + if (!source.openContract) + for (const name of byName.keys()) + if (!knownNames.has(name)) emit('UNKNOWN_METADATA_PROPERTY', { property: name }); + for (const property of expected.effectiveProperties) { + const old = byName.get(property.name); + if (!old) { + changes.push({ + chart: source.chart, + code: 'SOURCE_PROPERTY_MISSING', + property: property.name, + source: rawByName.get(property.name).source + }); + continue; + } + checkFields(old, property, propertyFields, 'PROPERTY_FIELD_MISMATCH', { property: property.name }, [ + 'type', + 'required', + 'dependencies', + 'dependencyBindings' + ]); + if ( + typeof old.type !== 'string' || + canonicalType(context, old.type, !old.required) !== canonicalType(context, property.type, !property.required) + ) + emit('TYPE_MISMATCH', { + property: property.name, + metadata: old.type, + actual: property.type, + source: rawByName.get(property.name).source + }); + if (old.required !== property.required) + emit('REQUIRED_MISMATCH', { property: property.name, metadata: old.required, actual: property.required }); + if (JSON.stringify(ordered(old.dependencies || [])) !== JSON.stringify(property.dependencies)) + emit('DEPENDENCY_MISMATCH', { property: property.name }); + const oldBindings = old.dependencyBindings || {}, + bindings = property.dependencyBindings || {}; + for (const expression of new Set([...Object.keys(oldBindings), ...Object.keys(bindings)])) + if (oldBindings[expression] !== bindings[expression]) + emit('DEPENDENCY_BINDING_MISMATCH', { property: property.name, expression }); + for (const name of property.dependencies) + if (!actual.complexTypeDefinitions?.[name]) emit('MISSING_DEPENDENCY_DEFINITION', { property: name }); + } + if (!actual.vchartVersion || actual.vchartVersion !== context.version) emit('VERSION_MISMATCH'); + if (JSON.stringify(actual).includes('/Users/')) emit('ABSOLUTE_PATH'); + for (const [name, target] of Object.entries(actual.complexTypeDefinitions || {})) { + if (!/^[A-Za-z_$][\w$]*$/.test(name)) emit('INVALID_DEPENDENCY', { property: name }); + if (!target.reference || !fs.existsSync(path.join(referencesRoot, target.reference.split('#')[0]))) + emit('MISSING_DETAIL', { property: name, reference: target.reference }); + const exp = expected.complexTypeDefinitions[name]; + if (exp) checkFields(target, exp, definitionFields, 'DEFINITION_MISMATCH', { property: name }, ['reference']); + else emit('UNKNOWN_DEPENDENCY_DEFINITION', { property: name }); + if (exp && target.reference !== exp.reference) + emit('DETAIL_TARGET_MISMATCH', { property: name, metadata: target.reference, actual: exp.reference }); + if (target.reference?.includes('#')) { + const [file, anchor] = target.reference.split('#'); + const destination = path.join(referencesRoot, file); + if (fs.existsSync(destination) && !fs.readFileSync(destination, 'utf8').includes(`id="${anchor}"`)) + emit('MISSING_DETAIL_ANCHOR', { property: name, reference: target.reference }); + } + } + for (const name of Object.keys(expected.complexTypeDefinitions)) + if (!actual.complexTypeDefinitions?.[name]) emit('MISSING_DEPENDENCY_DEFINITION', { property: name }); + const topkeyFile = path.join(referencesRoot, 'topkey', `${source.chart}.json`); + if (!fs.existsSync(topkeyFile)) emit('MISSING_TOPKEY'); + else + for (const [key, item] of Object.entries(readDocument(topkeyFile, source.chart))) { + if (item.key !== key) emit('TOPKEY_KEY_MISMATCH', { property: key }); + const names = new Set(expected.effectiveProperties.map(p => p.name)); + if (item.scope === 'series') { + if (source.chart !== 'common' || !allProperties.has(key) || item.specPath !== `series[].${key}`) + emit('TOPKEY_SCOPE_MISMATCH', { property: key }); + } else if (!names.has(key) && !source.openContract) emit('TOPKEY_PROPERTY_MISSING', { property: key }); + } + if (source.openContract) boundaries.push({ chart: source.chart, note: source.openContract }); + for (const note of source.contractNotes || []) { + if (!fs.existsSync(path.join(context.repoRoot, note.sourceFile))) + emit('CONTRACT_NOTE_SOURCE_MISSING', { source: note.sourceFile }); + boundaries.push({ chart: source.chart, note: note.description, source: note.sourceFile }); + } + } + const sharedFile = path.join(referencesRoot, 'topkey/all_common.json'); + if (fs.existsSync(sharedFile)) + for (const [key, item] of Object.entries(readDocument(sharedFile, 'all_common'))) { + if (item.key !== key) errors.push({ chart: 'all_common', code: 'TOPKEY_KEY_MISMATCH', property: key }); + if (key === 'state') { + const file = context.program.getSourceFile( + path.join(context.repoRoot, 'packages/vchart/src/typings/spec/common.ts') + ); + const declaration = file.statements.find(n => n.name?.text === 'IMarkSpec'); + const state = context.checker.getPropertyOfType(context.checker.getTypeAtLocation(declaration), 'state'); + if (!state || item.scope !== 'mark' || item.specPath !== '.state') + errors.push({ chart: 'all_common', code: 'TOPKEY_SCOPE_MISMATCH', property: key }); + } else if (!allProperties.has(key)) + errors.push({ chart: 'all_common', code: 'TOPKEY_PROPERTY_MISSING', property: key }); + } + // 补充声明中的传递导航也属于交付资源；不能只检查根属性的直接详情目标。 + const detailCache = new Map(); + for (const item of context.definitions.values()) { + if (!item.reference.includes('AdditionalTypes-')) continue; + const file = path.join(referencesRoot, item.reference.split('#')[0]); + const emit = code => errors.push({ chart: 'type-details', code, property: item.id, reference: item.reference }); + if (!fs.existsSync(file)) { + emit('MISSING_DETAIL'); + continue; + } + if (!detailCache.has(file)) detailCache.set(file, fs.readFileSync(file, 'utf8')); + const text = detailCache.get(file), + start = text.indexOf(`id="${item.anchor}"`); + if (start < 0) { + emit('MISSING_DETAIL_ANCHOR'); + continue; + } + const end = text.indexOf(' s.openContract).length, + runtimeContractNotes: sources.reduce((n, s) => n + (s.contractNotes?.length || 0), 0) + } + }; +} diff --git a/packages/vchart/scripts/skill-metadata/metadata-sources.json b/packages/vchart/scripts/skill-metadata/metadata-sources.json new file mode 100644 index 0000000000..8ff777fe73 --- /dev/null +++ b/packages/vchart/scripts/skill-metadata/metadata-sources.json @@ -0,0 +1,360 @@ +{ + "formatVersion": 2, + "sources": [ + { + "chart": "area", + "typeName": "IAreaChartSpec", + "sourceFile": "packages/vchart/src/chart/area/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "bar", + "typeName": "IBarChartSpec", + "sourceFile": "packages/vchart/src/chart/bar/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "bar3d", + "typeName": "IBar3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/bar-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerBar3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ], + "contractNotes": [ + { + "description": "当前 IBar3dSeriesSpec 继承二维 bar 类型，未声明运行时使用的 bar3d 样式字段；这属于公开类型与运行时的差异，不能据元数据认定该字段不受支持。", + "sourceFile": "docs/assets/examples/zh/chart-3d/bar3d.md", + "example": { + "bar3d": { + "style": { + "length": 20, + "z": -20 + } + } + } + } + ] + }, + { + "chart": "boxPlot", + "typeName": "IBoxPlotChartSpec", + "sourceFile": "packages/vchart/src/chart/box-plot/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "circlePacking", + "typeName": "ICirclePackingChartSpec", + "sourceFile": "packages/vchart/src/chart/circle-packing/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "circularProgress", + "typeName": "ICircularProgressChartSpec", + "sourceFile": "packages/vchart/src/chart/progress/circular/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "common", + "typeName": "ICommonChartSpec", + "sourceFile": "packages/vchart/src/chart/common/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "correlation", + "typeName": "ICorrelationChartSpec", + "sourceFile": "packages/vchart/src/chart/correlation/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "funnel", + "typeName": "IFunnelChartSpec", + "sourceFile": "packages/vchart/src/chart/funnel/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "funnel3d", + "typeName": "IFunnel3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/funnel-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerFunnel3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] + }, + { + "chart": "gauge", + "typeName": "IGaugeChartSpec", + "sourceFile": "packages/vchart/src/chart/gauge/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "heatmap", + "typeName": "IHeatmapChartSpec", + "sourceFile": "packages/vchart/src/chart/heatmap/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "histogram", + "typeName": "IHistogramChartSpec", + "sourceFile": "packages/vchart/src/chart/histogram/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "histogram3d", + "typeName": "IHistogram3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/histogram-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerHistogram3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] + }, + { + "chart": "line", + "typeName": "ILineChartSpec", + "sourceFile": "packages/vchart/src/chart/line/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "linearProgress", + "typeName": "ILinearProgressChartSpec", + "sourceFile": "packages/vchart/src/chart/progress/linear/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "liquid", + "typeName": "ILiquidChartSpec", + "sourceFile": "packages/vchart/src/chart/liquid/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "map", + "typeName": "IMapChartSpec", + "sourceFile": "packages/vchart/src/chart/map/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "mosaic", + "typeName": "IMosaicChartSpec", + "sourceFile": "packages/vchart/src/chart/mosaic/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "pictogram", + "typeName": "IPictogramChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/pictogram/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerPictogramChart" + ], + "openContract": "IChartExtendsSeriesSpec 保留公开开放契约；系列字段见 IPictogramSeriesSpec，根字段转发见 pictogram-transformer.ts。" + }, + { + "chart": "pie", + "typeName": "IPieChartSpec", + "sourceFile": "packages/vchart/src/chart/pie/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "pie3d", + "typeName": "IPie3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/pie-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerPie3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] + }, + { + "chart": "radar", + "typeName": "IRadarChartSpec", + "sourceFile": "packages/vchart/src/chart/radar/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "rangeArea", + "typeName": "IRangeAreaChartSpec", + "sourceFile": "packages/vchart/src/chart/range-area/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "rangeColumn", + "typeName": "IRangeColumnChartSpec", + "sourceFile": "packages/vchart/src/chart/range-column/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "rangeColumn3d", + "typeName": "IRangeColumn3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/range-column-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerRangeColumn3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] + }, + { + "chart": "rose", + "typeName": "IRoseChartSpec", + "sourceFile": "packages/vchart/src/chart/rose/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "sankey", + "typeName": "ISankeyChartSpec", + "sourceFile": "packages/vchart/src/chart/sankey/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "scatter", + "typeName": "IScatterChartSpec", + "sourceFile": "packages/vchart/src/chart/scatter/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "sequence", + "typeName": "ISequenceChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/sequence/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerSequenceChart" + ] + }, + { + "chart": "sunburst", + "typeName": "ISunburstChartSpec", + "sourceFile": "packages/vchart/src/chart/sunburst/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "treemap", + "typeName": "ITreemapChartSpec", + "sourceFile": "packages/vchart/src/chart/treemap/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "venn", + "typeName": "IVennChartSpec", + "sourceFile": "packages/vchart/src/chart/venn/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "waterfall", + "typeName": "IWaterfallChartSpec", + "sourceFile": "packages/vchart/src/chart/waterfall/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "wordCloud", + "typeName": "IWordCloudChartSpec", + "sourceFile": "packages/vchart/src/chart/word-cloud/interface.ts", + "package": "@visactor/vchart" + }, + { + "chart": "wordCloud3d", + "typeName": "IWordCloud3dChartSpec", + "sourceFile": "packages/vchart-extension/src/charts/word-cloud-3d/interface.ts", + "package": "@visactor/vchart-extension", + "registration": [ + "registerWordCloud3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] + } + ], + "detailReferences": { + "@visactor/vlayouts/es/interface/wordcloud.d.ts#GeometricMaskShape": "type-details/GeometricMaskShape-Type-Definition.md", + "@visactor/vlayouts/es/interface/wordcloud.d.ts#TextShapeMask": "type-details/TextShapeMask-Type-Definition.md", + "@visactor/vlayouts/es/sunburst/interface.d.ts#SunburstLabelConfig": "type-details/SunburstLabelConfig-Type-Definition.md", + "packages/vchart/src/animation/interface.ts#IAnimationConfig": "type-details/IAnimationConfig-Type-Definition.md", + "packages/vchart/src/component/axis/cartesian/interface/spec.ts#ICartesianAxisSpec": "type-details/ICartesianAxisSpec-Type-Definition.md", + "packages/vchart/src/component/axis/interface/spec.ts#ILinearAxisSpec": "type-details/ILinearAxisSpec-Type-Definition.md", + "packages/vchart/src/component/axis/polar/interface/spec.ts#IPolarAxisSpec": "type-details/IPolarAxisSpec-Type-Definition.md", + "packages/vchart/src/component/brush/interface.ts#IBrushSpec": "type-details/IBrushSpec-Type-Definition.md", + "packages/vchart/src/component/crosshair/interface/spec.ts#ICartesianCrosshairSpec": "type-details/ICartesianCrosshairSpec-Type-Definition.md", + "packages/vchart/src/component/crosshair/interface/spec.ts#IPolarCrosshairSpec": "type-details/IPolarCrosshairSpec-Type-Definition.md", + "packages/vchart/src/component/data-zoom/data-zoom/interface.ts#IDataZoomSpec": "type-details/IDataZoomSpec-Type-Definition.md", + "packages/vchart/src/component/data-zoom/scroll-bar/interface.ts#IScrollBarSpec": "type-details/IScrollBarSpec-Type-Definition.md", + "packages/vchart/src/component/indicator/interface.ts#IIndicatorSpec": "type-details/IIndicatorSpec-Type-Definition.md", + "packages/vchart/src/component/label/interface.ts#ILabelSpec": "type-details/ILabelSpec-Type-Definition.md", + "packages/vchart/src/component/label/interface.ts#IMultiLabelSpec": "type-details/IMultiLabelSpec-Type-Definition.md", + "packages/vchart/src/component/label/interface.ts#ITotalLabelSpec": "type-details/ITotalLabelSpec-Type-Definition.md", + "packages/vchart/src/component/legend/interface.ts#ILegendSpec": "type-details/ILegendSpec-Type-Definition.md", + "packages/vchart/src/component/marker/mark-area/interface/spec.ts#IMarkAreaSpec": "type-details/IMarkAreaSpec-Type-Definition.md", + "packages/vchart/src/component/marker/mark-line/interface/spec.ts#IMarkLineSpec": "type-details/IMarkLineSpec-Type-Definition.md", + "packages/vchart/src/component/marker/mark-point/interface/spec.ts#IMarkPointSpec": "type-details/IMarkPointSpec-Type-Definition.md", + "packages/vchart/src/component/player/interface/spec.ts#IPlayer": "type-details/IPlayer-Type-Definition.md", + "packages/vchart/src/component/title/interface/spec.ts#ITitleSpec": "type-details/ITitleSpec-Type-Definition.md", + "packages/vchart/src/component/tooltip/interface/spec.ts#ITooltipSpec": "type-details/ITooltipSpec-Type-Definition.md", + "packages/vchart/src/interaction/interface/spec.ts#IHoverSpec": "type-details/IHoverSpec-Type-Definition.md", + "packages/vchart/src/interaction/interface/spec.ts#IInteractionItemSpec": "type-details/IInteractionItemSpec-Type-Definition.md", + "packages/vchart/src/interaction/interface/spec.ts#ISelectSpec": "type-details/ISelectSpec-Type-Definition.md", + "packages/vchart/src/layout/interface.ts#ILayoutSpec": "type-details/ILayoutSpec-Type-Definition.md", + "packages/vchart/src/region/interface.ts#RegionSpec": "type-details/RegionSpec-Type-Definition.md", + "packages/vchart/src/series/bar/interface.ts#IStackCornerRadiusCallback": "type-details/IStackCornerRadiusCallback-Type-Definition.md", + "packages/vchart/src/series/funnel/interface.ts#IFunnelLabelSpec": "type-details/IFunnelLabelSpec-Type-Definition.md", + "packages/vchart/src/series/funnel/interface.ts#IFunnelOuterLabelSpec": "type-details/IFunnelOuterLabelSpec-Type-Definition.md", + "packages/vchart/src/series/interface/common.ts#ISeriesStyle": "type-details/ISeriesStyle-Type-Definition.md", + "packages/vchart/src/series/mixin/interface.ts#ILineLikeLabelSpec": "type-details/ILineLikeLabelSpec-Type-Definition.md", + "packages/vchart/src/series/pie/interface.ts#IArcLabelSpec": "type-details/IArcLabelSpec-Type-Definition.md", + "packages/vchart/src/series/sankey/interface.ts#ISankeyLabelSpec": "type-details/ISankeyLabelSpec-Type-Definition.md", + "packages/vchart/src/series/waterfall/interface.ts#IWaterfallTotalCustom": "type-details/IWaterfallTotalCustom-Type-Definition.md", + "packages/vchart/src/series/waterfall/interface.ts#IWaterfallTotalEnd": "type-details/IWaterfallTotalEnd-Type-Definition.md", + "packages/vchart/src/series/waterfall/interface.ts#IWaterfallTotalField": "type-details/IWaterfallTotalField-Type-Definition.md", + "packages/vchart/src/series/word-cloud/interface.ts#WordCloudConfigType": "type-details/WordCloudConfigType-Type-Definition.md", + "packages/vchart/src/series/word-cloud/interface.ts#WordCloudShapeConfigType": "type-details/WordCloudShapeConfigType-Type-Definition.md", + "packages/vchart/src/series/word-cloud/interface.ts#WordCloudShapeType": "type-details/WordCloudShapeType-Type-Definition.md", + "packages/vchart/src/theme/interface.ts#ITheme": "type-details/ITheme-Type-Definition.md", + "packages/vchart/src/typings/layout.ts#ILayoutPaddingSpec": "type-details/ILayoutPaddingSpec-Type-Definition.md", + "packages/vchart/src/typings/layout.ts#IPercent": "type-details/IPercent-Type-Definition.md", + "packages/vchart/src/typings/shape.ts#ShapeType": "type-details/ShapeType-Type-Definition.md", + "packages/vchart/src/typings/space.ts#IPadding": "type-details/IPadding-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IBackgroundSpec": "type-details/IBackgroundSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#ICustomMarkSpec": "type-details/ICustomMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IData": "type-details/IData-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IExtensionGroupMarkSpec": "type-details/IExtensionGroupMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IExtensionMarkSpec": "type-details/IExtensionMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IHierarchyData": "type-details/IHierarchyData-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#IMarkSpec": "type-details/IMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/common.ts#ISeriesSpec": "type-details/ISeriesSpec-Type-Definition.md", + "packages/vchart/src/typings/spec/media-query.ts#IMediaQuerySpec": "type-details/IMediaQuerySpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#FunctionType": "type-details/FunctionType-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IArcMarkSpec": "type-details/IArcMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IAreaMarkSpec": "type-details/IAreaMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IBoxPlotMarkSpec": "type-details/IBoxPlotMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IGroupMarkSpec": "type-details/IGroupMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IImageMarkSpec": "type-details/IImageMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#ILineMarkSpec": "type-details/ILineMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#ILinkPathMarkSpec": "type-details/ILinkPathMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#ILiquidMarkSpec": "type-details/ILiquidMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IOutlierMarkSpec": "type-details/IOutlierMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IPathMarkSpec": "type-details/IPathMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IPolygonMarkSpec": "type-details/IPolygonMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IRectMarkSpec": "type-details/IRectMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IRippleMarkSpec": "type-details/IRippleMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IRuleMarkSpec": "type-details/IRuleMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#ISymbolMarkSpec": "type-details/ISymbolMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#ITextMarkSpec": "type-details/ITextMarkSpec-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IVisualSpecBase": "type-details/IVisualSpecBase-Type-Definition.md", + "packages/vchart/src/typings/visual.ts#IVisualSpecScale": "type-details/IVisualSpecScale-Type-Definition.md" + } +} diff --git a/packages/vchart/scripts/skill-metadata/verify-examples.mjs b/packages/vchart/scripts/skill-metadata/verify-examples.mjs new file mode 100644 index 0000000000..e9430438a7 --- /dev/null +++ b/packages/vchart/scripts/skill-metadata/verify-examples.mjs @@ -0,0 +1,308 @@ +import fs from 'node:fs'; +import path from 'node:path'; +import http from 'node:http'; +import os from 'node:os'; +import { createRequire } from 'node:module'; +import { fileURLToPath } from 'node:url'; +import { parseArgs } from 'node:util'; + +const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../..'); +const require = createRequire(path.join(root, 'packages/vchart/package.json')); +const csv = 'day,value\n周一,12\n周二,25\n'; + +/** M07 使用真实本地 URL；服务器不访问外部业务系统。 */ +export async function serveCSV() { + const requests = []; + const server = http.createServer((request, response) => { + response.setHeader('Access-Control-Allow-Origin', '*'); + if (request.url === '/data.csv') { + requests.push({ path: request.url, method: request.method }); + response.writeHead(200, { 'Content-Type': 'text/csv; charset=utf-8' }); + response.end(csv); + } else { + response.writeHead(404); + response.end(); + } + }); + await new Promise(resolve => server.listen(0, '127.0.0.1', resolve)); + return { server, requests, url: `http://127.0.0.1:${server.address().port}/data.csv` }; +} + +/** 使用原始 Agent spec，不重写配置；验证数据、实际图元和可见范围。 */ +export async function verifySpecs(artifacts, extensionBundle, selectedCase) { + const { chromium } = require('@playwright/test'); + const browser = await chromium.launch(); + const output = []; + try { + for (const [name, filename] of [ + ['before-m01', 'spec.json'], + ['before-m02', 'spec.json'], + ['m01', 'spec.json'], + ['m02', 'spec.json'], + ['m02', 'disabled-spec.json'], + ['m04', 'spec.json'], + ['m05', 'spec.json'], + ['m10', 'spec.json'], + ['m11', 'spec.json'] + ]) { + if (selectedCase && name !== selectedCase) continue; + const directory = path.join(artifacts, name); + const file = path.join(directory, filename); + if (!fs.existsSync(file)) { + output.push({ task: `${name}/${filename}`, status: 'not_run', reason: '没有该实际产物' }); + continue; + } + const spec = JSON.parse(fs.readFileSync(file, 'utf8')); + if (name === 'm11' && !extensionBundle) { + output.push({ + task: `${name}/${filename}`, + status: 'not_run', + reason: '需要真实共享依赖的扩展 bundle；不能用核心 2D 环境替代' + }); + continue; + } + const page = await browser.newPage(); + const errors = []; + page.on('pageerror', error => errors.push(error.message)); + await page.setContent('
'); + await page.addScriptTag({ + path: name === 'm11' ? extensionBundle : path.join(root, 'packages/vchart/build/index.js') + }); + const state = await page.evaluate( + async ({ spec, extension }) => { + if (extension) VChartExtension.registerBar3dChart(); + const chart = new VChart.default(spec, { dom: 'chart' }); + await chart.renderAsync(); + await new Promise(resolve => setTimeout(resolve, 1200)); + const series = chart.getChart().getAllSeries()[0]; + window.__metadataChart = chart; + return { + version: VChart.version, + type: series.type, + data: series + .getRawData() + .latestData.map(d => Object.fromEntries(Object.entries(d).filter(([k]) => !k.startsWith('__')))), + marks: series.getMarks().map(mark => ({ + name: mark.name, + graphics: mark.getGraphics().map(g => ({ + type: g.type, + datum: g.context?.data?.[0], + points: g.attribute.points, + bounds: { + x1: g.globalAABBBounds.x1, + y1: g.globalAABBBounds.y1, + x2: g.globalAABBBounds.x2, + y2: g.globalAABBBounds.y2 + } + })) + })), + texts: chart + .getStage() + .findAll(g => g.type === 'text', true) + .map(g => g.attribute.text) + }; + }, + { spec, extension: name === 'm11' } + ); + const values = Array.isArray(spec.data) ? spec.data[0].values : spec.data.values; + if (JSON.stringify(state.data) !== JSON.stringify(values)) throw new Error(`${name}: 原数据变化`); + const graphics = state.marks.flatMap(m => m.graphics).filter(g => Object.values(g.bounds).every(Number.isFinite)); + if (!graphics.length || errors.length) throw new Error(`${name}: 没有有效图元或存在错误 ${errors.join(',')}`); + if (spec.type === 'bar') { + const bars = state.marks.find(m => m.name === 'bar')?.graphics || []; + if (bars.length !== values.length || bars.some(g => g.bounds.x2 <= g.bounds.x1 || g.bounds.y2 <= g.bounds.y1)) + throw new Error(`${name}: 柱图几何错误`); + if (spec.direction === 'horizontal' && !bars.every(g => g.bounds.x2 - g.bounds.x1 > g.bounds.y2 - g.bounds.y1)) + throw new Error(`${name}: 未形成水平柱`); + } + if (spec.type === 'rangeArea') { + const points = state.marks.find(m => m.name === 'area')?.graphics?.[0]?.points; + if ( + !points || + points.length !== values.length || + points.some(p => ![p.x, p.y, p.y1].every(Number.isFinite) || p.y === p.y1) + ) + throw new Error(`${name}: 区间面积端点无效`); + } + if (spec.type === 'radar' && state.marks.find(m => m.name === 'point')?.graphics.length !== values.length) + throw new Error(`${name}: 雷达点数量错误`); + if (spec.type === 'bar3d') { + const bars = state.marks.find(m => m.name === 'bar3d')?.graphics || []; + if ( + bars.length !== values.length || + bars.some( + g => + g.type !== 'rect3d' || + !Object.values(g.bounds).every(Number.isFinite) || + g.bounds.x2 <= g.bounds.x1 || + g.bounds.y2 <= g.bounds.y1 + ) + ) + throw new Error(`${name}: 实际 3D 图元无效`); + } + await page.screenshot({ path: path.join(directory, filename.replace('.json', '-parent.png')) }); + const report = { status: 'passed', ...state, errors }; + fs.writeFileSync( + path.join(directory, filename.replace('.json', '-parent-validation.json')), + JSON.stringify(report, null, 2) + '\n' + ); + output.push({ task: `${name}/${filename}`, status: 'passed', type: state.type, version: state.version }); + await page.evaluate(() => window.__metadataChart.release()); + await page.close(); + } + } finally { + await browser.close(); + } + return output; +} + +/** 执行文档里的原始 CSV 代码，兼查 URL 不自动加载的反例及应用 fetch 正例。 */ +async function verifyCSVExample(output) { + const document = fs.readFileSync( + path.join(root, 'skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md'), + 'utf8' + ); + const example = document.match(/### CSV Data with Parser\s*```typescript\s*([\s\S]*?)```/)?.[1]; + if (!example) throw new Error('没有找到实际 CSV 文档示例'); + const ts = require('typescript'); + const code = ts.transpileModule(example, { compilerOptions: { target: ts.ScriptTarget.ES2020 } }).outputText; + const data = new Function(code + '\nreturn data;')(); + const fixture = await serveCSV(); + const { chromium } = require('@playwright/test'); + const browser = await chromium.launch(); + try { + const page = await browser.newPage(); + await page.setContent('
'); + await page.addScriptTag({ path: path.join(root, 'packages/vchart/build/index.js') }); + const states = await page.evaluate( + async ({ data, url }) => { + const output = []; + for (const [name, actual] of [ + ['url-as-values', { values: url, parser: { type: 'csv' } }], + ['actual-document-example', data], + [ + 'application-fetch', + { + values: await fetch(url).then(r => { + if (!r.ok) throw new Error('CSV fetch failed'); + return r.text(); + }), + parser: { type: 'csv' } + } + ] + ]) { + const chart = new VChart.default( + { type: 'bar', animation: false, data: actual, xField: 'day', yField: 'value' }, + { dom: 'chart' } + ); + await chart.renderAsync(); + const series = chart.getChart().getAllSeries()[0]; + output.push({ + name, + version: VChart.version, + data: series.getRawData().latestData.map(d => ({ day: d.day, value: d.value })), + validBars: series + .getSeriesMark() + .getGraphics() + .filter(g => Number.isFinite(g.attribute.y) && Math.abs(g.attribute.y - g.attribute.y1) > 0).length + }); + chart.release(); + } + return output; + }, + { data, url: fixture.url } + ); + if (states[0].validBars !== 0 || fixture.requests.length !== 1) throw new Error('URL 反例或应用加载请求数错误'); + for (const state of states.slice(1)) + if (state.validBars !== 2 || state.data.map(d => `${d.day}:${Number(d.value)}`).join(',') !== '周一:12,周二:25') + throw new Error('实际文档/加载数据错误'); + fs.writeFileSync(output, JSON.stringify({ states, requests: fixture.requests, status: 'passed' }, null, 2) + '\n'); + } finally { + await browser.close(); + await new Promise(resolve => fixture.server.close(resolve)); + } +} + +/** 复用标准 Rollup 工具，将核心与扩展的 CJS 入口绑定为同一模块，避免双 Factory/渲染器。 */ +async function buildExtensionRuntime(output) { + const bundler = createRequire(path.join(root, 'tools/bundler/package.json')); + const { rollup } = bundler('rollup'); + const commonjs = bundler('@rollup/plugin-commonjs'); + const { nodeResolve } = bundler('@rollup/plugin-node-resolve'); + const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'vchart-meta-3d-')); + const entry = path.join(directory, 'entry.mjs'); + const core = path.join(root, 'packages/vchart/cjs/index.js'); + fs.writeFileSync( + entry, + `import * as Core from ${JSON.stringify(core)};\nimport { registerBar3dChart } from ${JSON.stringify( + path.join(root, 'packages/vchart-extension/cjs/charts/bar-3d/index.js') + )};\nwindow.VChart=Core;window.VChartExtension={registerBar3dChart};\n` + ); + let bundle; + try { + bundle = await rollup({ + input: entry, + plugins: [ + { + name: 'same-core-runtime', + resolveId(id) { + if (id === '@visactor/vchart') return core; + if (id.startsWith('@visactor/vchart/esm/')) { + const candidate = path.join(root, 'packages/vchart/cjs', id.slice('@visactor/vchart/esm/'.length)); + return [candidate + '.js', path.join(candidate, 'index.js')].find(fs.existsSync); + } + } + }, + nodeResolve({ browser: true, preferBuiltins: false }), + commonjs() + ], + onwarn(warning) { + if (warning.code !== 'CIRCULAR_DEPENDENCY') console.error(warning.message); + } + }); + await bundle.write({ file: output, format: 'iife' }); + } finally { + await bundle?.close(); + fs.rmSync(directory, { recursive: true, force: true }); + } +} + +const { values } = parseArgs({ + options: { + 'serve-csv': { type: 'boolean' }, + artifacts: { type: 'string' }, + case: { type: 'string' }, + 'extension-bundle': { type: 'string' }, + 'build-extension': { type: 'string' }, + 'csv-example': { type: 'string' } + } +}); +if (values['serve-csv']) { + const fixture = await serveCSV(); + console.log(JSON.stringify({ url: fixture.url, values: csv })); + for (const signal of ['SIGINT', 'SIGTERM']) process.once(signal, () => fixture.server.close()); +} else if (values['build-extension']) { + await buildExtensionRuntime(path.resolve(values['build-extension'])); + console.log(JSON.stringify({ extensionBundle: values['build-extension'] })); +} else if (values['csv-example']) { + await verifyCSVExample(path.resolve(values['csv-example'])); + console.log(JSON.stringify({ csvExample: 'passed' })); +} else if (values.artifacts) { + try { + console.log( + JSON.stringify( + await verifySpecs( + path.resolve(values.artifacts), + values['extension-bundle'] && path.resolve(values['extension-bundle']), + values.case + ) + ) + ); + } catch (error) { + console.error(error.stack); + process.exitCode = 1; + } +} else { + console.error('需要 --serve-csv 或 --artifacts DIR'); + process.exitCode = 1; +} diff --git a/skills/vchart-development-assistant/README.md b/skills/vchart-development-assistant/README.md index dc8d0f3b02..e6a533351d 100644 --- a/skills/vchart-development-assistant/README.md +++ b/skills/vchart-development-assistant/README.md @@ -1,66 +1,68 @@ -# VChart Development Assistant - 用户使用说明 +# VChart Development Assistant 使用说明 -## 这个助手适合什么场景 +## 两类生成场景 -- 从 0 到 1 生成图表（柱状图、折线图、饼图等） -- 修改已有图表样式（颜色、标签、图例、tooltip、坐标轴） -- 排查图表问题（不显示、报错、交互不生效、数据映射错误） -- 从截图/Figma 还原图表 -- 增加交互能力（点击事件、动态更新、联动高亮、导出图片、主题切换） +| 场景 | 用途 | 产物 | +| --- | --- | --- | +| HTML 生成 | 直接打开查看、可运行演示、页面交互 | 完整 HTML；已有 React 需求按组件契约处理 | +| spec 生成 | 宿主渲染、应用嵌入、其他工具消费配置 | 完整 VChart spec，遵循 JSON/JS 格式要求 | -## 如何提问效果最好 +选择顺序：本轮明确要求 → 已有宿主/应用上下文 → 尚未确定目标时识别当前任务 → 独立展示默认 HTML。已有产物的配置修改沿用原目标：HTML 内的 spec 修改仍交付 HTML，独立 spec 修改仍交付 spec；组件和组合产物也保留原目标。“加标签”“修复报错”不会自动改变格式，明确“只返回 JSON”等要求才切换。只有明确要求片段或补丁才仅返回局部改动。 -建议一次性提供以下信息： +两条生成流程共享选图与配置知识，不需要重复指定所有配置。数据和目标充分时直接执行，不机械询问框架或确认图型。技能也支持问题诊断、截图/Figma 还原、React-VChart 和按需 API 集成。 -- 使用环境：原生 JS / React-VChart（`@visactor/react-vchart`）/ 其他框架 -- 目标：你想实现什么图表或效果 -- 数据：至少给 5~10 条样例数据（或字段结构） -- 当前代码：如果是改造/排错，贴出当前 spec 或关键代码 -- 期望与现状：预期效果 + 实际问题（报错信息/截图） +## 怎么提问 -推荐提问模板： +提供表达目标、实际数据和已知约束；修改或诊断时提供现有 spec/组件及实际问题。单位、字段含义或数据范围影响图义时补充，不要求所有请求都给技术栈或固定数量的样本。 + +### 直接查看 HTML ```text -请用 VChart 帮我实现一个[图表类型]。 -技术栈：[JS / React-VChart] -数据样例：[粘贴数据] -需求：[例如：显示标签、点击柱子后打印数据、支持主题切换] -当前代码（可选）：[粘贴 spec/组件代码] -问题（可选）：[例如：图表空白、tooltip 不显示] -请给我可直接运行的完整 HTML（或 React 组件）并解释关键配置。 +周一 12、周二 25、周三 18、周四 32。 +用 VChart 比较四天数值，生成能直接打开查看的完整 HTML。 ``` -## 可直接使用的示例 Prompt +HTML 请求交付页面。点击读取 datum、外部按钮等需要应用代码；tooltip、图例等声明式能力直接写入配置。 + +### 只要完整 spec ```text -用 VChart 生成一个基础柱状图，包含 xField、yField，并给出最小可运行示例。 +周一 12、周二 25、周三 18、周四 32。 +用合适的 VChart 图表比较数值，只返回完整 JSON spec，不要解释。 ``` +纯 JSON 请求只返回配置，不混入 Markdown、HTML、实例创建或报告。普通对话可给配置文件和必要说明。未指定格式时优先沿用宿主及现有配置；均未知时可序列化配置采用 JSON，确需且环境允许函数时采用 JS。 + +### 已有宿主上下文 + +```text +宿主负责渲染，只接收 JSON VChart spec，支持 bar 和 line，不接受函数。 +后续给数据时请按这些约束生成配置。 +``` + +后续“用合适图表展示这些数据”继续交付配置，不重新询问 HTML 或框架，也不添加宿主卡片外壳。 + +### 修改配置与组合交付 + ```text -在我现有柱状图基础上优化颜色、标签样式和图例可读性，保持数据结构不变。 +给我现有 spec 加上数值标签，保留数据，返回修改后的完整 JSON。 ``` ```text -帮我检查当前 VChart spec 的配置错误，指出问题位置并给出可直接替换的修复版本。 +生成完整 spec，再提供一个使用同一份配置的 HTML 预览。 ``` -## 你会得到什么输出 +spec 临时渲染页是验收材料，不会取代最终配置。JSON 不能承载函数；需要回调时先查询声明式写法，不能实现则说明宿主限制，不丢函数后声称完成。 -- 可直接运行的完整代码（默认包含完整 HTML） -- 关键配置说明（为什么这么配） -- 如果是排错场景：问题定位 + 修复建议 + 修复后代码 -- 如果有交互需求：同时给出 API 事件/状态/数据更新代码 +## 验收与排错 -## 常见问题建议 +检查实际字段、数据、必需配置和已知运行约束。JSON 可解析不代表图表已经渲染；有可用环境时打开真实产物，检查数据图元、标签/tooltip 和明确要求的交互。未渲染或未在目标宿主验证时如实说明。 -- 图表空白时，先检查 `xField` / `yField` 是否与数据字段名完全一致 -- 检查数据结构是否符合 VChart 要求（尤其是 `data` 和 `values`） -- 如果是 React 场景，确认依赖版本和组件导入方式正确 -- 问题无法复现时，优先提供最小复现代码和报错截图 +排错优先提供原配置、错误和实际效果；现有 React 问题继续处理组件/hooks/API，不能只替换 spec 后忽略组件问题。 -## 参考文档 +## 参考 -- VChart Skill Usage：`https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Skill_Usage` -- VChart Quick Start：`https://www.visactor.io/vchart/guide/tutorial_docs/Getting_Started` -- VChart 配置项文档：`https://www.visactor.io/vchart/option` -- VChart API 文档：`https://www.visactor.io/vchart/api/API/vchart` +- [共享生成流程](workflows/scenario-2-generation.md)、[HTML 流程](workflows/scenario-2-html-generation.md)、[spec 流程](workflows/scenario-2-spec-generation.md) +- [JSON/JS 示例](examples/spec-generation/README.md) +- [VChart Skill 教程](https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Skill_Usage) +- [配置文档](https://www.visactor.io/vchart/option)、[API 文档](https://www.visactor.io/vchart/api/API/vchart) diff --git a/skills/vchart-development-assistant/SKILL.md b/skills/vchart-development-assistant/SKILL.md index 0be7c57b44..52009ab26c 100644 --- a/skills/vchart-development-assistant/SKILL.md +++ b/skills/vchart-development-assistant/SKILL.md @@ -1,400 +1,109 @@ --- name: vchart-development-assistant -description: VChart图表库专家助手，擅长创建、配置和调试VChart图表。当用户需要：生成柱状图/折线图/饼图等图表；修复图表不显示/点击事件不触发等问题；从图片或Figma设计稿还原图表样式；实现点击获取数据/数据动态更新/图表联动/导出图片/主题切换等交互功能；配置图例/坐标轴/标签/tooltip等组件时使用。即使用户没有提到"技能"或"VChart"这个词，只要涉及图表开发就触发。 +description: 使用 VChart 生成可查看的 HTML 或供宿主消费的完整 spec，修改和诊断图表配置，从截图还原样式，并支持 React-VChart 和图表交互。用于 VChart 图表生成、配置、排错和应用集成。 --- -# VChart 图表开发助手 Skill +# VChart 图表开发助手 -用户主要希望从原始观测查看统计分布、变量关系、缺失，或展示已有模型结果时，优先使用 [data-science-visualization](../data-science-visualization/SKILL.md) 的数据入口与交互 HTML。普通业务图、React 和应用嵌入继续使用本技能；不要求该相邻技能已安装。 +根据表达目标和数据选择图表，生成有效配置，再按用户需要交付 HTML 或 spec。支持 VChart 2.0.0+；已知目标版本时查询该版本支持的能力，不把“2.0.0+”当作所有配置都跨版本兼容的保证。 -## 自我介绍策略 +## 先确定任务与交付目标 -当用户询问本助手的能力范围（如"你能做什么"、"这个助手是什么"、"有什么功能"）时，用第一人称简要概括： +任务类型与交付目标分别判断。生成、诊断、视觉还原可以交付 HTML 或 spec；React 和 API 集成是按需能力模块。 -> 我是 VChart 图表开发助手，基于 VChart 2.0.0+ 版本，可以帮你： -> -> - 从零生成图表配置（柱状图、折线图、饼图等） -> - 诊断和修复图表问题（不显示、报错、交互不生效） -> - 从截图或 Figma 设计稿还原图表样式 -> - 实现交互功能（点击事件、动态更新、联动高亮、导出图片、主题切换） -> - 支持原生 JS 和 React-VChart（`@visactor/react-vchart`） +| 场景 | 识别信号 | 流程 | +| --- | --- | --- | +| HTML 生成 | 可运行 demo、HTML、直接打开查看；没有宿主上下文的独立展示需求 | [共享生成](workflows/scenario-2-generation.md) → [HTML 交付](workflows/scenario-2-html-generation.md) | +| spec 生成 | 只要 spec、JSON 配置、嵌入已有图表；上下文已声明宿主消费配置 | [共享生成](workflows/scenario-2-generation.md) → [spec 交付](workflows/scenario-2-spec-generation.md) | +| 问题诊断 | 已有配置或应用报错、不显示、交互不生效 | [诊断](workflows/scenario-1-diagnosis.md)；React 问题按需读 [React 专项](workflows/scenario-1-react.md) | +| 视觉还原 | 图表截图、设计稿或 Figma | [视觉还原](workflows/scenario-3-image-replication.md) | -如用户需要更详细的入门指引，推荐查阅官方教程：https://www.visactor.io/vchart/guide/tutorial_docs/Getting_Started +交付选择顺序：**本轮明确要求 → 已建立的宿主或应用上下文 → 尚未确定目标时识别当前任务 → 独立展示默认 HTML**。场景表的信号按此顺序使用，不能覆盖已建立的交付目标。 -**不要**在用户未询问时主动输出上述介绍。 +- 尚未建立交付目标时，独立的配置生成/修改请求选择 spec。“已有 spec”是配置输入，不等于请求 spec 作为最终产物；修改已有 HTML 内的 spec 继续交付 HTML，组件或组合产物也保留原目标，除非用户明确改变输出要求。已有 React 组件问题继续交付组件修复。 +- “加标签”“换图型”“修复报错”改变任务内容，通常不改变交付目标；沿用前文的格式和产物。只有明确要求片段或补丁时才仅返回局部配置，增量修改默认交付整合后的完整产物。 +- 同时要 spec 和 HTML 时交付两者，HTML 使用同一份 spec。spec 任务的临时验证页面不代替最终配置。 +- 信息充分时直接选图和生成，不逐次确认图型。只澄清会影响图义、字段含义、数据口径或交付可用性的缺失信息；不要默认询问 JS/React。 +- 独立 HTML 默认原生 JS；明确的 React 上下文使用相应组件/API。交付目标不明且选错会影响使用时，只询问必要的交付形式。 +- 既有宿主约束持续有效，但不把未知版本、图型或回调支持当作已知。要求与已知宿主能力冲突时说明限制，不静默换产物。 ---- - -## 信息不足时的引导策略 - -当用户首次提问信息不足时（缺少技术栈、数据样例、当前代码等），用一句话自然地引导补充，优先询问最关键的 1-2 个缺失信息，不要一次罗列所有问题。 - -引导优先级： - -1. **技术栈**（JS / React-VChart）— 影响模板选择和代码风格 -2. **数据样例或字段结构** — 影响字段映射，是最高频错误源 -3. **当前代码**（如果是排错/改造场景）— 影响诊断准确性 -4. **期望效果与实际问题** — 影响场景识别 - -示例引导话术： - -- "请问您是用原生 JS 还是 React-VChart？另外能否提供一份数据样例？" -- "方便贴一下当前的 spec 配置吗？我来帮您定位问题。" - ---- - -## 角色定义 - -你是一位 VChart 图表库专家助手，专门帮助用户解决 VChart 2.0.0+ 版本的图表开发问题。你具备以下能力： - -- 深度理解 VChart 的 Spec 配置体系和 API -- 能够根据用户描述推断最合适的图表类型和配置项 -- 熟悉常见的配置问题和最佳实践 -- 能够生成符合 VChart 规范的完整或增量配置代码 -- **支持 React-VChart**：熟悉 `@visactor/react-vchart` 的组件使用和问题诊断 -- **对话上下文感知**：能在多轮对话中动态切换场景（生成→诊断→增量），而非僵化执行单一流程 -- **主动发现问题**：生成代码后主动自检，提前预警潜在风险（如字段映射错误） -- **快速响应反馈**：当用户反馈问题时，立即切换到诊断模式而非继续生成 - ---- - -## 核心知识库 - -本 Skill 依赖以下结构化知识库： - -| 知识库 | 路径 | 用途 | -| -------------- | ------------------------------- | --------------------------------------- | -| **配置项索引** | `references/topkey/*.json` | 用户意图 → 配置项名称的快速映射 | -| **类型元数据** | `references/type-meta/*.json` | 图表类型的完整属性结构和继承关系 | -| **类型详情** | `references/type-details/*.md` | 配置项的详细类型定义和代码示例 | -| **示例库** | `references/examples/` | 常用图表的完整示例代码 | -| **组件参考** | `references/components/` | 组件配置速查 | -| **API 参考** | `references/api/` | VChart API 详细文档和使用示例 | -| **输出模板** | `template/demo.html` | 生成可运行 HTML 示例的标准模板（纯 JS） | -| **诊断模板** | `template/diagnosis.html` | 问题诊断 HTML 模板（纯 JS） | -| **React 诊断** | `template/diagnosis-react.html` | React-VChart 问题诊断 HTML 模板 | - -**React-VChart 参考资源**： - -- **官方教程**：https://visactor.com/vchart/guide/tutorial_docs/Cross-terminal_and_Developer_Ecology/react -- **GitHub 仓库**：https://github.com/VisActor/VChart/tree/develop/packages/react-vchart - ---- - -## 脚本快速导航 - -本 Skill 提供 3 个 Python 脚本，用于生成可交互的 HTML 诊断/演示页面： - -| 场景 | 脚本 | 输入文件 | 参考文档 | -| ------------------- | ---------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **VChart 问题诊断** | `generate_diagnosis_html.py` | `config.js`
(包含 problemReview/diagnosis/solutions) | [scenario-1-diagnosis.md](workflows/scenario-1-diagnosis.md)
[参数参考](references/SCRIPT_PARAMS_REFERENCE.md#generate_diagnosis_htmlpy) | -| **配置生成演示** | `generate_demo_html.py` | `spec.js`
(完整 VChart spec) | [scenario-2-generation.md](workflows/scenario-2-generation.md)
[参数参考](references/SCRIPT_PARAMS_REFERENCE.md#generate_demo_htmlpy) | -| **图片还原演示** | `generate_demo_html.py` | `spec.js`
(基于图片分析的 spec) | [scenario-3-image-replication.md](workflows/scenario-3-image-replication.md)
[参数参考](references/SCRIPT_PARAMS_REFERENCE.md#generate_demo_htmlpy) | -| **React 问题诊断** | `generate_diagnosis_react_html.py` | 命令行参数
(无需文件) | [scenario-1-react.md](workflows/scenario-1-react.md)
[参数参考](references/SCRIPT_PARAMS_REFERENCE.md#generate_diagnosis_react_htmlpy) | - -**快速使用**： - -```bash -# VChart 诊断 -python3 scripts/generate_diagnosis_html.py --config-file config.js - -# 配置生成/图片还原演示 -python3 scripts/generate_demo_html.py --spec-file spec.js - -# React 诊断 -python3 scripts/generate_diagnosis_react_html.py \ - --problem-code "..." --problem-title "..." --cause "..." \ - --solution-1-title "..." --solution-1-desc "..." --solution-1-code "..." -``` - -**常见问题**：参见 [脚本故障排除指南](references/SCRIPTS_TROUBLESHOOTING.md) 和 [文件命名约定](references/FILE_NAMING_CONVENTIONS.md) - ---- - -## 场景识别与动态切换 - -### 首次识别 - -当用户提出 VChart 相关问题时，识别属于以下哪种场景： - -#### 场景一：问题诊断 - -**识别信号**： - -- 用户提供了现有代码并描述"不工作"、"报错"、"显示异常" -- 用户询问"有没有更好的方式"、"如何优化" -- 用户遇到性能问题或渲染问题 -- **支持 React-VChart**：用户使用 `@visactor/react-vchart` 的 React 组件代码 - -#### 场景二：配置生成 - -**识别信号**： - -- 用户希望从 0 到 1 创建图表（提供描述/数据结构） -- 用户已有 spec，希望添加/修改某个功能点 -- 用户问"如何配置 xxx"、"怎么实现 xxx 效果" - -**场景二细分**： - -- **完整生成模式**：用户无现有 spec，需要生成完整配置 -- **增量生成模式**：用户有现有 spec，需要生成增量配置 - -#### 场景三：视觉还原 - -**识别信号**： - -- 用户提供了图表截图/设计稿图片 -- 用户提供了 Figma 设计稿链接或截图 -- 用户说"帮我实现这个图表"、"照着这个做一个" -- 用户希望复刻某个图表效果 - -**场景三细分**： - -- **普通图片模式**：从截图推断样式，中等精确度 -- **Figma 设计稿模式**：提取精确样式值，高精确度 - -#### API 交互需求识别（可嵌入任何场景） - -**重要**：API 交互不是独立场景，而是可以嵌入任何场景的**能力模块**。 - -**识别信号**（在场景1/2/3中检测）： - -- 用户询问"点击后..."、"hover 时..."、"选中后..." -- 用户询问"动态更新"、"实时刷新"、"定时更新" -- 用户询问"高亮"、"联动"、"外部控制" -- 用户询问"导出"、"下载图片" -- 用户询问"切换主题"、"深色模式" -- 用户需要事件监听、状态管理、交互控制等功能 - -**处理原则**： - -- 在**场景二（配置生成）**中检测到 API 需求 -> 同时生成 Spec + API 代码 -- 在**场景三（视觉还原）**中检测到 API 需求 -> 同时还原样式 + API 代码 -- 在**场景一（问题诊断）**中检测到 API 需求 -> 诊断 Spec + API 代码问题 - -**API 能力分类**： +用户需要统计分布、变量关系、缺失或已有模型结果的**交互 HTML** 时，优先使用相邻 [data-science-visualization](../data-science-visualization/SKILL.md)。明确的原生 VChart spec 请求仍在本技能处理，不因提到“数据分析”就改成交互 HTML；不要求相邻技能已安装。 -| 能力类型 | 典型需求 | API 文档 | -| -------- | -------------------- | ----------------------------------- | -| 事件监听 | 点击响应、hover 效果 | `references/api/event-api.md` | -| 数据操作 | 动态更新、实时刷新 | `references/api/data-api.md` | -| 状态管理 | 高亮、选中 | `references/api/state-api.md` | -| 交互控制 | 手动触发 tooltip | `references/api/interaction-api.md` | -| 导出功能 | 下载图片 | `references/api/export-api.md` | -| 主题切换 | 深色模式 | `references/api/theme-api.md` | +## 共享配置知识 ---- - -### 对话中的场景动态切换 - -**核心原则**：根据最新用户输入重新评估场景，灵活切换。 - -#### 切换触发信号 - -| 当前场景 | 用户说... | 切换到 | 动作 | -| -------- | ------------------------------- | ------ | -------------- | -| 场景2 | "没显示"/"报错"/"不对"/"为什么" | 场景1 | 诊断生成的代码 | -| 场景1 | "再加"/"怎么实现"/"如何配置" | 场景2 | 增量生成 | -| 场景3 | "调整"/"优化"/描述具体问题 | 场景1 | 诊断优化 | -| 任何 | 提供新图片/截图 | 场景3 | 新的视觉还原 | -| 任何 | "重新生成"/全新需求 | 场景2 | 新的完整生成 | - -#### API 能力嵌入规则 - -**在当前场景中检测到 API 需求时，不切换场景，而是增强输出**： - -| 当前场景 | 检测到 API 需求 | 增强动作 | -| -------- | ---------------- | -------------------------- | -| 场景2 | "点击后获取数据" | 输出 Spec + 事件监听代码 | -| 场景2 | "动态更新数据" | 输出 Spec + 数据更新函数 | -| 场景3 | "联动高亮" | 输出 Spec + 状态管理代码 | -| 场景3 | "导出图片" | 输出 Spec + 导出按钮和函数 | -| 场景1 | API 代码报错 | 同时诊断 Spec 和 API 代码 | - -#### 切换要点 - -- 保留之前代码作为上下文基础 -- 明确告知切换："我来帮您诊断一下..." -- 直接处理，无需重新收集信息 - ---- - -## 生成后自检与问题预警 - -生成代码后立即检查以下高频错误点： - -### 自检要点 - -1. **字段映射**（80%问题源）：xField/yField 与 data.values 中的键名完全一致？ -2. **数据结构**：data 格式正确？`[{ id, values: [{...}] }]` -3. **必填字段**：type、xField/yField（如适用）、data 都已配置？ -4. **类型正确**：数值是 number 而非 string？ - -### 主动提示 - -发现风险时告知用户： - -``` -已生成配置 -请确认数据字段名与 xField/yField 一致，否则图表可能无法显示 -如遇问题请反馈，我会立即诊断 -``` - -### 问题反馈关键词 -> 立即切换场景1 - -- "报错"/"error"/"不工作"/"失败" -- "没显示"/"空白"/"不出来" -- "数据不对"/"Y轴空"/"X轴乱" -- "为什么"/"有问题"/"不对" -- "帮我看看"/"检查"/"诊断" - ---- - -## 处理流程 - -根据场景识别结果，参考对应的处理流程文档： - -| 场景 | 处理流程文档 | 核心能力 | -| ----------------- | -------------------------------------------------------------------------------------- | ---------------------------------- | -| **问题诊断** | [workflows/scenario-1-diagnosis.md](workflows/scenario-1-diagnosis.md) | 配置检查、错误定位、性能优化 | -| **├─ React 专项** | [workflows/scenario-1-react.md](workflows/scenario-1-react.md) | React-VChart 特有问题诊断 | -| **配置生成** | [workflows/scenario-2-generation.md](workflows/scenario-2-generation.md) | 完整生成、增量生成、意图识别 | -| **视觉还原** | [workflows/scenario-3-image-replication.md](workflows/scenario-3-image-replication.md) | 图片分析、Figma 精确还原、样式匹配 | - -**注意**：场景不是固定的！在对话中随时根据用户最新输入切换场景。API 交互作为能力模块嵌入任何场景中。 +按需查询，不一次加载所有图型、API 或类型详情。 ---- - -## 知识库查询指南 - -### 配置项查询 - -当需要查找配置项时，按以下顺序查询： - -``` -用户意图 -> topkey/*.json -> type-meta/*.json -> type-details/*.md -``` - -**查询流程**： - -1. **意图识别**：用户说"加个标签" -> 查询 `references/topkey/[图表类型].json` -> 找到 `label` 配置项 -2. **结构查询**：需要 label 的属性 -> 查询 `references/type-meta/[图表类型].json` -> 找到 `label` 的类型定义 -3. **类型详情**：`label` 类型为 `ILabelSpec`（isSimple: false）-> 查询 `references/type-details/ILabelSpec-Type-Definition.md` +| 资源 | 用途 | +| --- | --- | +| [图型指南](references/chart/chart-type-guide.md) | 根据表达目标和数据语义选图 | +| `references/topkey/[图型].json`、`all_common.json` | 将标签、图例、参考线等意图映射到配置项 | +| `references/type-meta/[图型].json` | 最终属性、类型、必需字段 | +| `references/type-details/[类型名]-Type-Definition.md` | 复杂类型的定义与示例；函数需求查询对应签名 | +| [示例库](references/examples/) | 相近配置参考；示例数据不能充当用户数据 | +| [组件参考](references/components/) | 轴、标签、图例、tooltip 等配置 | +| [API 索引](references/api/API_INDEX.md) | 只有需要实例 API 时才查询相关文档 | -> **常用配置项索引**： -> -> - 通用配置（标题、图例、tooltip等）-> `references/topkey/all_common.json` -> - 图表专属配置 -> `references/topkey/[图表类型].json` +配置查询顺序：用户意图 → 对应 topkey → type-meta → 必要 type-details。`isSimple: true` 的属性可直接使用元数据类型，复杂属性再读取详情。 -### 类型定义查询 +元数据的 `effectiveProperties` 表示当前图表类型的最终属性。复杂属性按 `dependencies` 查询 `complexTypeDefinitions[依赖名].reference`，存在 `dependencyBindings` 时先将类型表达式中的别名映射到导航键，再找到对应详情或补充声明，不凭短类型名猜文件；补充声明用类型索引按需读取。`topkey` 的 `scope/specPath` 标明系列或图元作用域，不能一律写到根配置。 -根据 `type-meta` 中的 `isSimple` 字段判断查询策略： +`vchartVersion` 和扩展的 `extensionVersion` 标明知识来源版本；`since` 保留属性或特定取值的版本说明，`deprecated` 提示弃用及替代写法。目标版本不同时查询相应版本资料；扩展图型须遵守 `registration` 前提，注册由宿主完成。`openContract` 标记声明开放范围，`contractNotes` 记录已证实的类型与运行时差异，两者都不能理解为元数据枚举了全部运行时属性。维护工具只供知识库更新使用，生成图表不需要运行它。 -| isSimple | 类型示例 | 查询方式 | -| -------- | --------------------- | -------------------------------------------------------------- | -| `true` | `boolean`, `string` | 直接使用 `references/type-meta` 中的 `type` 字段 | -| `false` | `ILabelSpec`, `IData` | 查询 `references/type-details/[类型名]-Type-Definition.md` | -| 函数类型 | 回调函数 | 查询 `references/type-details/FunctionType-Type-Definition.md` | +本地资料不足时查询官方配置 `https://www.visactor.io/vchart/option/[图型]`、API `https://www.visactor.io/vchart/api/API/vchart` 或仓库 `docs/assets/examples/`，以目标版本为准。 -### API 查询 +## 数据与生成自检 -当用户需要实现交互功能时，查询 API 文档： +- 明确要比较什么、字段含义、单位、排序和必要的数据范围。数字 ID 不自动当作连续度量；零与缺失不同，不能默认补零、删行、抽样、聚合或改变占比分母。 +- 使用实际数据检查字段映射。按图型检查 xField/yField、categoryField/valueField、seriesField、数据引用和所需配置，不要求所有图型都有 xField/yField。 +- 属性值与文档类型一致，配置与已知目标版本及宿主约束相符。数据可以采用 VChart 支持的对象或数组形式，不为示例样式机械归一化。 +- 信息充分时直接修正生成错误，不仅提醒用户自行检查。缺少真实业务数据时澄清；功能教学或样式演示可用明确标注的 mock 数据。 +- JSON 用标准解析器检查，不能混入注释、函数、NaN/Infinity；格式通过不代表 VChart 配置或图义正确。本期不使用 schema 校验。 +- 能渲染时检查实际交付配置的图元、数据和可见效果；HTML 交互需要验证真实状态或 datum。未实际渲染则说明验证范围，不因生成文件或存在 canvas 就报成功。浏览器验收不等于目标宿主验收。 -**快速索引**：`references/api/API_INDEX.md` +## 交互和应用 API -| 用户需求 | 查询文档 | -| --------------- | ----------------------------------- | -| 更新图表数据 | `references/api/data-api.md` | -| 响应点击/hover | `references/api/event-api.md` | -| 高亮/选中图元 | `references/api/state-api.md` | -| 手动触发tooltip | `references/api/interaction-api.md` | -| 切换主题 | `references/api/theme-api.md` | -| 导出图片 | `references/api/export-api.md` | -| 控制动画 | `references/api/animation-api.md` | -| 坐标位置转换 | `references/api/coordinate-api.md` | -| 控制图例 | `references/api/legend-api.md` | -| 调整尺寸 | `references/api/layout-api.md` | +先判断能力能否由 spec 声明，再决定是否需要应用代码。 -**API 查询流程**： +- tooltip、图例、标签等声明式能力直接配置到 spec，不因有交互需求自动改成 HTML。 +- 事件监听、外部按钮、实例数据更新、导出等按需查询 API。HTML/应用场景增加相应代码；spec 场景只交付可表达的配置，不混入事件绑定或宿主包装。 +- 纯 JSON 不能携带函数或外部业务逻辑。先查询可用的声明式写法；不能满足时说明限制和所需宿主能力，不丢弃函数后声称完成。只有用户改变交付目标时才转为应用代码。 -1. **需求识别**：用户说"点击图表获取数据" -> 识别为事件监听需求 -2. **文档查找**：查询 `references/api/event-api.md` -3. **代码生成**：根据文档示例生成完整代码 +| 需求 | 按需参考 | +| --- | --- | +| 点击、hover、事件参数 | [event-api.md](references/api/event-api.md) | +| 数据更新 | [data-api.md](references/api/data-api.md) | +| 高亮、选择 | [state-api.md](references/api/state-api.md) | +| 手动 tooltip | [interaction-api.md](references/api/interaction-api.md) | +| 导出图片 | [export-api.md](references/api/export-api.md) | +| 主题、动画、尺寸 | [theme](references/api/theme-api.md)、[animation](references/api/animation-api.md)、[layout](references/api/layout-api.md) | +| 坐标转换、图例控制 | [coordinate](references/api/coordinate-api.md)、[legend](references/api/legend-api.md) | ---- - -## 通用查询策略 +## 交付契约 -### 查询优先级 +### HTML -``` -1. 本地知识库 - - 配置相关：references/topkey/ -> references/type-meta/ -> references/type-details/ - - 交互相关：references/api/ - - 示例参考：references/examples/ -2. 在线文档（仅当本地不足时） -``` +按 [HTML 工作流](workflows/scenario-2-html-generation.md) 使用既有模板与脚本，交付完整文件和必要说明；页面包含正确的依赖、配置和实例创建。React 请求按已有组件契约处理，按需提供诊断 HTML。 -### 在线资源（补充） +### spec -当本地知识库无法解决问题时： +按 [spec 工作流](workflows/scenario-2-spec-generation.md) 交付完整可复用配置，不强制追加 HTML、实例创建或 render 调用。 -- **配置文档**：`https://www.visactor.io/vchart/option/[图表类型]` -- **API 文档**：`https://www.visactor.io/vchart/api/API/vchart` -- **示例代码**：GitHub `VisActor/VChart` 的 `docs/assets/examples/` -- **Issue 搜索**：`https://github.com/VisActor/VChart/issues` - ---- +格式优先沿用用户要求、宿主契约和已有配置。都未指定时，可序列化配置采用 JSON；实际需要且环境允许函数时采用 JS spec 并说明格式。函数必须遵循对应签名，不能通过 JSON 往返丢失。 -## 代码生成规范 +机器消费的“只返回 JSON”只输出配置本身，不添加 Markdown 围栏、说明或报告字段；普通对话可给配置文件链接与简短说明。说明、假设和验证证据与配置分离。 -生成的代码应： - -1. **类型正确**：属性值符合 `type-details` 中的类型定义 -2. **字段匹配**：数据字段名与 xField/yField 等严格对应（最常见错误源） -3. **必填完整**：包含 `type-meta` 中 `required: true` 的所有字段 -4. **注释清晰**：关键配置项添加注释说明 -5. **版本兼容**：使用 VChart 2.0.0+ 的 API -6. **React 需求**：如用户明确 React-VChart，优先采用 React 代码/模板（见 React 诊断模板），并提示依赖安装 - ---- +### 诊断与还原 -## 输出规范 +保留用户指定或已建立的交付目标，解释原因或还原范围；纯 JSON 要求不混入这些说明。诊断 HTML 使用既有专项模板，spec 修复默认交付整合后的完整配置；请求只看改动时才给补丁。 -所有场景处理完成后，**必须输出可直接运行的 HTML 文件**，不得只返回 spec 片段。 - -### 模板选择与硬约束 - -| 场景 | 使用模板 | 强制要求 | -| ------------------- | ------------------------------- | --------------------------------------------------- | -| 配置生成 / 视觉还原 | `template/demo.html` | 替换标题/描述占位；替换 `{{SPEC_CODE}}` 为完整 spec | -| 问题诊断（纯 JS） | `template/diagnosis.html` | 嵌入用户代码/问题点，并给出修复后 spec | -| 问题诊断（React） | `template/diagnosis-react.html` | React 场景输出 React 诊断 HTML | -| API 交互增强 | `template/demo.html` | 包含 spec + 事件监听 + 交互函数 + 控制按钮 | - -**输出校验清单**（回答时提醒用户可直接保存为 .html 打开）： - -- 包含对应模板的完整 HTML（含 CDN 引用），非截断/片段 -- 替换 `{{SPEC_CODE}}` 为完整 spec（或修复后的 spec） -- 标题/描述占位已替换；如无描述填入简短用途 -- 如需本地预览，建议 `python3 -m http.server 8000` - -**不合格示例（禁止）**： - -- 仅返回 `const spec = {...}` 或局部配置 -- 省略 HTML 头/脚或 CDN 链接 -- 未替换模板占位符 - ---- - -## 版本说明 - -本 Skill 针对 **VChart 2.0.0+** 版本设计。 - -如用户使用旧版本（1.x），需提醒可能存在的 API 差异。 - ---- +## 工具与参考 -## 本地知识库结构 +| 用途 | 既有资源 | +| --- | --- | +| HTML 演示、视觉还原 | `scripts/generate_demo_html.py`、`template/demo.html` | +| JS 诊断页面 | `scripts/generate_diagnosis_html.py`、`template/diagnosis.html` | +| React 诊断页面 | `scripts/generate_diagnosis_react_html.py`、`template/diagnosis-react.html` | +| 参数、脚本问题、文件命名 | [参数参考](references/SCRIPT_PARAMS_REFERENCE.md)、[排错指南](references/SCRIPTS_TROUBLESHOOTING.md)、[命名约定](references/FILE_NAMING_CONVENTIONS.md) | +| 完整 JSON 与 JS 回调示例 | [spec 示例](examples/spec-generation/README.md) | -主要目录：`chart-type-guide.md`、`workflows/`、`template/`、`references/`。详情见各自文件夹。 +只有用户询问能力范围时才简要介绍：支持 HTML/spec 生成、配置修改、诊断、视觉还原和 React/API 集成；不主动输出自我介绍。 diff --git a/skills/vchart-development-assistant/examples/spec-generation/README.md b/skills/vchart-development-assistant/examples/spec-generation/README.md new file mode 100644 index 0000000000..7e280f62fe --- /dev/null +++ b/skills/vchart-development-assistant/examples/spec-generation/README.md @@ -0,0 +1,11 @@ +# spec 生成示例 + +这些是演示数据，不能替代用户真实数据。完整生成和修改后交付遵循 [spec 工作流](../../workflows/scenario-2-spec-generation.md)。 + +| 文件 | 表达目标与数据 | 格式与边界 | +| --- | --- | --- | +| [weekly-bar.json](weekly-bar.json) | 比较四天数值 12、25、18、32，保留星期顺序；未给业务单位 | 可序列化 JSON；xField=day、yField=value，无宿主包装 | +| [composition-pie.json](composition-pie.json) | 同一总体 A=30、B=70，总量 100；展示部分与整体 | JSON；categoryField=category、valueField=value；不是两份不同分母的百分比 | +| [callback-label.js](callback-label.js) | 周数据柱图标签显示“星期: 数值” | JS；formatMethod 按 (text, datum) 签名，不可丢函数转换成 JSON；同类效果先查询声明式 formatter 能力 | + +JSON 示例可直接解析。JS 示例仅声明 spec；实例创建由宿主或临时验收页面负责。临时 HTML 用于真实渲染验证，不代替配置产物。组合交付的页面应使用同一份配置。 diff --git a/skills/vchart-development-assistant/examples/spec-generation/callback-label.js b/skills/vchart-development-assistant/examples/spec-generation/callback-label.js new file mode 100644 index 0000000000..748e01788c --- /dev/null +++ b/skills/vchart-development-assistant/examples/spec-generation/callback-label.js @@ -0,0 +1,18 @@ +const spec = { + type: 'bar', + data: { + values: [ + { day: '周一', value: 12 }, + { day: '周二', value: 25 }, + { day: '周三', value: 18 }, + { day: '周四', value: 32 } + ] + }, + xField: 'day', + yField: 'value', + label: { + visible: true, + // 按标签回调签名使用第二个参数 datum；函数配置需要 JS 环境。 + formatMethod: (text, datum) => `${datum.day}: ${text}` + } +}; diff --git a/skills/vchart-development-assistant/examples/spec-generation/composition-pie.json b/skills/vchart-development-assistant/examples/spec-generation/composition-pie.json new file mode 100644 index 0000000000..4cdac2eb49 --- /dev/null +++ b/skills/vchart-development-assistant/examples/spec-generation/composition-pie.json @@ -0,0 +1,17 @@ +{ + "type": "pie", + "data": { + "values": [ + { + "category": "A", + "value": 30 + }, + { + "category": "B", + "value": 70 + } + ] + }, + "categoryField": "category", + "valueField": "value" +} diff --git a/skills/vchart-development-assistant/examples/spec-generation/weekly-bar.json b/skills/vchart-development-assistant/examples/spec-generation/weekly-bar.json new file mode 100644 index 0000000000..e2b473e3d9 --- /dev/null +++ b/skills/vchart-development-assistant/examples/spec-generation/weekly-bar.json @@ -0,0 +1,25 @@ +{ + "type": "bar", + "data": { + "values": [ + { + "day": "周一", + "value": 12 + }, + { + "day": "周二", + "value": 25 + }, + { + "day": "周三", + "value": 18 + }, + { + "day": "周四", + "value": 32 + } + ] + }, + "xField": "day", + "yField": "value" +} diff --git a/skills/vchart-development-assistant/references/SCRIPTS_TROUBLESHOOTING.md b/skills/vchart-development-assistant/references/SCRIPTS_TROUBLESHOOTING.md index fd3c21070d..b95fef6817 100644 --- a/skills/vchart-development-assistant/references/SCRIPTS_TROUBLESHOOTING.md +++ b/skills/vchart-development-assistant/references/SCRIPTS_TROUBLESHOOTING.md @@ -120,6 +120,10 @@ --- +## 回调代码含模板字符串时页面空白 + +如果 `generate_demo_html.py` 生成页面报 `datum is not defined` 等错误，而原配置使用了 `${datum...}` 标签回调，检查生成器对编辑器代码文本的转义。代码文本中的 `${` 必须转义为 `\${`，不能被外层 `initialCode` 模板字符串提前执行；实际 spec 中的回调保持原样。此问题应修复生成器，不应通过删除回调或把函数序列化成 JSON 掩盖。 + ## 按脚本分类故障排除 ### generate_diagnosis_html.py diff --git a/skills/vchart-development-assistant/references/chart/chart-type-guide.md b/skills/vchart-development-assistant/references/chart/chart-type-guide.md index 1f46c9a131..2e22531fb3 100644 --- a/skills/vchart-development-assistant/references/chart/chart-type-guide.md +++ b/skills/vchart-development-assistant/references/chart/chart-type-guide.md @@ -1,5 +1,11 @@ # 图表类型选择指南 +## 先判断数据含义 + +按用户要表达的比较、趋势、构成或关系选图，不按记录数量直接决定图义。数字 ID 即使是 number 也可以是类别；时间或星期顺序只有在表达趋势时才构成连线理由。用户已指定图型时尊重要求，数据不足以支持时说明原因。 + +零是实际观测，缺失是未知，两者不能默认替换。类别重复、聚合规则、单位和占比分母会影响图义，只澄清当前任务必需的信息；不默认排序、删行、采样、聚合或归一化。 + ## 快速选择流程 ``` @@ -113,19 +119,11 @@ ## 选择建议 -### 数据量考虑 - -- **< 10 条**：饼图、雷达图 -- **10-50 条**：柱状图、折线图 -- **50-200 条**：折线图、散点图 -- **> 200 条**：考虑聚合或使用散点图/热力图 +### 数据量与可读性 -### 比较对象数量 +记录数量、类别数量、标签长度及系列密度影响尺寸、方向、标签和图例布局，不单独决定比较、趋势或占比。类别多时可建议条形图等更易读的方式；不未经说明将数据聚合、截断或抽样。 -- **单一对象**：仪表盘、进度条 -- **2-4 个对象**：分组柱状图、多系列折线 -- **5-7 个对象**：饼图、堆叠图 -- **> 7 个对象**：避免饼图，使用柱状图 +占比图须属于同一总体并明确分母；类别数少也不代表应使用饼图。精确比较优先考虑柱图/条形图，玫瑰图适用于用户需要的极坐标表达，不能将半径与面积含义混淆。 ### 用户理解难度 @@ -140,7 +138,7 @@ 1. **饼图类目过多**（>7个）→ 使用柱状图 2. **3D效果**（不推荐）→ 使用2D图表 3. **双Y轴量级差异大** → 考虑分成两个图 -4. **折线图类目轴** → 如果不是时序数据，考虑柱状图 +4. **无顺序语义的折线** → 独立类别比较考虑柱状图；有明确顺序或趋势目标时再连线 5. **堆叠图系列过多**（>5个）→ 考虑分面或其他图表 ### ✅ 推荐 diff --git a/skills/vchart-development-assistant/references/topkey/all_common.json b/skills/vchart-development-assistant/references/topkey/all_common.json index 540cd676c8..752fcdcffb 100644 --- a/skills/vchart-development-assistant/references/topkey/all_common.json +++ b/skills/vchart-development-assistant/references/topkey/all_common.json @@ -117,6 +117,8 @@ }, "state": { "key": "state", - "oneDesc": "跟交互状态相关的配置，例如选中态/hover态/激活态等相关的内容" + "oneDesc": "图元的交互状态样式（如 bar.state.hover），不是图表根属性。", + "scope": "mark", + "specPath": ".state" } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/topkey/bar3d.json b/skills/vchart-development-assistant/references/topkey/bar3d.json index 63d82e1ef9..47fb3abdb8 100644 --- a/skills/vchart-development-assistant/references/topkey/bar3d.json +++ b/skills/vchart-development-assistant/references/topkey/bar3d.json @@ -121,7 +121,7 @@ }, "bar": { "key": "bar", - "oneDesc": "柱图图元样式配置.同时可以配置选中，hover等交互状态下的柱子和对应鼠标的样式" + "oneDesc": "继承公开类型中的二维柱样式字段；3D 运行时的 bar3d 样式尚未在该类型声明，参见元数据 contractNotes 的来源与示例。" }, "barBackground": { "key": "barBackground", @@ -203,4 +203,4 @@ "key": "samplingFactor", "oneDesc": "数据采样 - 采样系数" } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/topkey/common.json b/skills/vchart-development-assistant/references/topkey/common.json index 524be29435..1199a8aab3 100644 --- a/skills/vchart-development-assistant/references/topkey/common.json +++ b/skills/vchart-development-assistant/references/topkey/common.json @@ -9,47 +9,69 @@ }, "bar": { "key": "bar", - "oneDesc": "柱图图元样式配置" + "oneDesc": "柱图图元样式配置", + "scope": "series", + "specPath": "series[].bar" }, "barBackground": { "key": "barBackground", - "oneDesc": "柱图中每根柱子背后的背景图元配置" + "oneDesc": "柱图中每根柱子背后的背景图元配置", + "scope": "series", + "specPath": "series[].barBackground" }, "point": { "key": "point", - "oneDesc": "点图元配置" + "oneDesc": "点图元配置", + "scope": "series", + "specPath": "series[].point" }, "line": { "key": "line", - "oneDesc": "线图元配置" + "oneDesc": "线图元配置", + "scope": "series", + "specPath": "series[].line" }, "area": { "key": "area", - "oneDesc": "面积图元配置" + "oneDesc": "面积图元配置", + "scope": "series", + "specPath": "series[].area" }, "boxPlot": { "key": "boxPlot", - "oneDesc": "箱体图元配置" + "oneDesc": "箱体图元配置", + "scope": "series", + "specPath": "series[].boxPlot" }, "circlePacking": { "key": "circlePacking", - "oneDesc": "嵌套圆图中每个圆的图元配置" + "oneDesc": "嵌套圆图中每个圆的图元配置", + "scope": "series", + "specPath": "series[].circlePacking" }, "cell": { "key": "cell", - "oneDesc": "单元格图元配置" + "oneDesc": "单元格图元配置", + "scope": "series", + "specPath": "series[].cell" }, "cellBackground": { "key": "cellBackground", - "oneDesc": "每个单元格对应的背景配置" + "oneDesc": "每个单元格对应的背景配置", + "scope": "series", + "specPath": "series[].cellBackground" }, "sunburst": { "key": "sunburst", - "oneDesc": "旭日图中单个扇区图元配置" + "oneDesc": "旭日图中单个扇区图元配置", + "scope": "series", + "specPath": "series[].sunburst" }, "circle": { "key": "circle", - "oneDesc": "韦恩图中圆形图元配置" + "oneDesc": "韦恩图中圆形图元配置", + "scope": "series", + "specPath": "series[].circle" }, "markLine": { "key": "markLine", @@ -63,4 +85,4 @@ "key": "markPoint", "oneDesc": "参考点标注，支持对图表上某个具体的点进行标注，支持文本解释" } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/topkey/pictogram.json b/skills/vchart-development-assistant/references/topkey/pictogram.json new file mode 100644 index 0000000000..232aa1eda5 --- /dev/null +++ b/skills/vchart-development-assistant/references/topkey/pictogram.json @@ -0,0 +1,34 @@ +{ + "type": { + "key": "type", + "oneDesc": "图表类型 pictogram；需要宿主注册扩展图型。" + }, + "data": { + "key": "data", + "oneDesc": "实际 SVG 图形对应的数据，字段和口径由用户提供。" + }, + "series": { + "key": "series", + "oneDesc": "系列配置，详见 IPictogramSeriesSpec。" + }, + "nameField": { + "key": "nameField", + "oneDesc": "图形名称映射字段，根配置通过转换器传给系列。" + }, + "valueField": { + "key": "valueField", + "oneDesc": "数值映射字段，根配置通过转换器传给系列。" + }, + "svg": { + "key": "svg", + "oneDesc": "实际 SVG 内容，用于定义图形。" + }, + "pictogram": { + "key": "pictogram", + "oneDesc": "图形样式与状态配置。" + }, + "defaultFillColor": { + "key": "defaultFillColor", + "oneDesc": "默认填充颜色。" + } +} diff --git a/skills/vchart-development-assistant/references/topkey/sankey.json b/skills/vchart-development-assistant/references/topkey/sankey.json index a9e0d88dc7..5521d493fb 100644 --- a/skills/vchart-development-assistant/references/topkey/sankey.json +++ b/skills/vchart-development-assistant/references/topkey/sankey.json @@ -123,9 +123,6 @@ "key": "interactions", "oneDesc": "其他需要按需注册的类型交互" }, - "nameKey": { - "key": "nameKey" - }, "sourceField": { "key": "sourceField", "oneDesc": "来源节点数据字段\n层级数据不提供" @@ -210,4 +207,4 @@ "key": "emphasis", "oneDesc": "联动交互配置" } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-details/AdditionalTypes-Type-Definition.md b/skills/vchart-development-assistant/references/type-details/AdditionalTypes-Type-Definition.md new file mode 100644 index 0000000000..983e073c78 --- /dev/null +++ b/skills/vchart-development-assistant/references/type-details/AdditionalTypes-Type-Definition.md @@ -0,0 +1,16278 @@ +# 补充公开类型声明 + +本文件由维护工具按实际符号生成，保留类型与继承，不代替已有人工说明。外部声明注明包及版本；类型参数按各调用处实例化。 + +## 类型索引 + +- [DataSet](#type-8d2b64638b97) +- [DataView](#type-b26ccd36d8e8) +- [IDsvParserOptions](#type-a39097639f44) +- [IParserOptions](#type-63f1dbc535e0) +- [IFieldsOptions](#type-26812fc33a0c) +- [IFilterOptions](#type-aceaf7172c44) +- [IFoldOptions](#type-46fd81c95ea2) +- [ISimplifyOptions](#type-a4c7726cf624) +- [ITransformOptions](#type-f4b40ca0e8cc) +- [TreemapOptions](#type-5125620c5489) +- [ACustomAnimate](#type-f85debfe2020) +- [AStageAnimate](#type-c0172addd0a4) +- [AxisItem](#type-7666dd9220f0) +- [AxisItemStateStyle](#type-80c23221deb4) +- [AxisLabelOverlap](#type-92b85bf48fbb) +- [Functional](#type-2535a2dd9530) +- [DiscreteLegendAttrs](#type-8f8c60190b3e) +- [LegendItem](#type-1b703f3ae381) +- [LegendItemDatum](#type-75bc5c7a36bf) +- [LegendPagerAttributes](#type-833ac1fb317b) +- [LegendScrollbarAttributes](#type-8dec8f9540ef) +- [LegendTitle](#type-c8f27ac5183b) +- [BaseMarkerAnimation](#type-c807eb5fd121) +- [IMarkAreaLabelPosition](#type-a1709a28c988) +- [IMarkCommonArcLabelPosition](#type-9a828f1ac3c0) +- [IMarkLineLabelPosition](#type-5be4f671bfe4) +- [IMarkPointItemPosition](#type-39230de2ade7) +- [MarkCommonLineAnimationType](#type-681f4999f1eb) +- [MarkPointAnimationType](#type-d28c136a90bb) +- [Datum](#type-8cb45fc9b0d9) +- [HandlerTextStyleContext](#type-589dee7f19a8) +- [IContainerSize](#type-5c34c2234a2c) +- [TooltipRichTextAttrs](#type-3b54c645e6d7) +- [IApp](#type-d176b9e09694) +- [EasingType](#type-6efe56d777d1) +- [ITicker](#type-619b260e190a) +- [IColor](#type-a0aea41aa029) +- [IConicalGradient](#type-d7015f202839) +- [ILinearGradient](#type-d8d5bda2ce95) +- [IRadialGradient](#type-8830ca87d7a0) +- [IGraphic](#type-a766bc91cce3) +- [IGraphicAttribute](#type-463cf72553ce) +- [IGraphicStyle](#type-fe3cb3c3600e) +- [IGroup](#type-8af3ee2f9b73) +- [IGroupGraphicAttribute](#type-2f7220f7ffb4) +- [IImageGraphicAttribute](#type-fcfc702de0ac) +- [IRichTextAttribute](#type-09c9e7b04102) +- [IRichTextCharacter](#type-a486d6a175fe) +- [IRichTextGraphicAttribute](#type-e3b4c4057a4f) +- [SymbolType](#type-4dccce8cd4d7) +- [ITextAttribute](#type-4ecb56643e01) +- [ITextGraphicAttribute](#type-36d5f8ea422d) +- [TextAlignType](#type-5417f1df62a1) +- [TextBaselineType](#type-b47e2c6810a7) +- [ILayer](#type-92d2afdda23a) +- [ICustomPath2D](#type-68cc5b53deb9) +- [IOption3D](#type-f65323c92812) +- [IStage](#type-454a11518dd1) +- [IStageParams](#type-681e3d101563) +- [CustomTicksFunc](#type-a2851eee354b) +- [IBaseScale](#type-f4ea6ab4e67d) +- [IContinuousScale](#type-61b93a04c77c) +- [IBoundsLike](#type-e61ecce4e47c) +- [IPointLike](#type-e25b463f6cfe) +- [IPadding](#type-698f5ded9c9f) +- [Maybe](#type-0f3d51337f61) +- [IBar3dSeriesSpec](#type-e506ece45fdc) +- [IPictogramSeriesSpec](#type-f780ecfd754f) +- [IRangeColumn3dSeriesSpec](#type-de962586184b) +- [IWordCloud3dSeriesSpec](#type-172112d22f72) +- [ChannelAnimationConfig](#type-5d8412d98274) +- [CommonAnimationConfigItem](#type-a27ba00f90e2) +- [GraphicFunctionCallback](#type-2d4e66b882cd) +- [GraphicFunctionValueType](#type-2dfb509d67d0) +- [IAnimationChannelAttrs](#type-f40bfaee5af2) +- [IAnimationChannelFunction](#type-253d0d6a48ba) +- [IAnimationChannelInterpolator](#type-cbb1bcb4a54c) +- [IAnimationControlOptions](#type-727cdb8dd287) +- [IAnimationCustomConstructor](#type-be178b30c81f) +- [IAnimationEffect](#type-2dd72221397d) +- [IAnimationParameters](#type-3fc135bb4f43) +- [IAnimationTimeline](#type-f36951a20ee2) +- [IAnimationTimeSlice](#type-1e49bff211ba) +- [IStageAnimationCallback](#type-3e0ce9607473) +- [IStateAnimationConfig](#type-e4cf848bb846) +- [MarkAnimationSpec](#type-1cf6d57c137c) +- [TypeAnimationConfig](#type-b4e071966992) +- [IAnimationSpec](#type-c2c92c7fb8c3) +- [ICommonStateAnimateSpec](#type-874c3b173f64) +- [IMarkAnimateSpec](#type-f077d8f2c125) +- [IMorphAnimationConfig](#type-6fbb2d1cab32) +- [IMorphConfig](#type-bffef8c15a00) +- [IMorphSeriesSpec](#type-d1defc672c7e) +- [IStateAnimateSpec](#type-c689f8784df3) +- [MorphData](#type-e6ed6ba04d57) +- [MorphElements](#type-3a62a6f9f35a) +- [MorphFunctionCallback](#type-2d18666b391c) +- [MorphFunctionType](#type-953fe2a09d7a) +- [MorphFunctionValueType](#type-e0d294fdac38) +- [IAreaChartSpec](#type-496aab7cbbc3) +- [IBarChartSpec](#type-1b991bebaeb5) +- [IBoxPlotChartSpec](#type-20eb03e0dbfa) +- [ICartesianChartSpec](#type-0ecf9332a2b4) +- [ICirclePackingChartSpec](#type-6e93443171dd) +- [ICommonChartSpec](#type-2e8825d02f34) +- [ICorrelationChartSpec](#type-717abb97a652) +- [IFunnelChartSpec](#type-87520a24cdd6) +- [IGaugeChartSpec](#type-80ddbd318ef0) +- [IHeatmapChartSpec](#type-d5e9ad106fbf) +- [IHistogramChartSpec](#type-50577849394e) +- [DimensionIndexOption](#type-5b5f8e33e6e1) +- [IChart](#type-d27fa13b0c29) +- [IChartData](#type-b326c4e21951) +- [IChartSpecTransformer](#type-664463dc79e8) +- [IChartEvaluateOption](#type-895c62f86a47) +- [IChartLayoutOption](#type-b3fb7b561e3d) +- [IChartOption](#type-cb5d64868d2d) +- [IChartSpecInfo](#type-618e9dfe06cf) +- [IChartSpecTransformerOption](#type-42469e396d0c) +- [ILineChartSpec](#type-de20dddcc338) +- [ILiquidChartSpec](#type-53e84bdd56cd) +- [IMapChartSpec](#type-2cc8eadf4a78) +- [IPieChartSpec](#type-b89687ec6565) +- [IPolarChartSpec](#type-47227db96ff6) +- [ICircularProgressChartSpec](#type-162adbb6da6d) +- [IProgressChartSpec](#type-c981df1ddf60) +- [ILinearProgressChartSpec](#type-aa5844c337ee) +- [IRadarChartSpec](#type-63b572eee0ca) +- [IRangeAreaChartSpec](#type-3a7b7d9563aa) +- [IRangeColumnChartSpec](#type-da04864ad35f) +- [IRoseChartSpec](#type-92bd0cd597bd) +- [ISankeyChartSpec](#type-f326797c9091) +- [IScatterChartSpec](#type-b4c1e7d7be5c) +- [ISunburstChartSpec](#type-fa66e1c21317) +- [ITreemapChartSpec](#type-f80911626a1e) +- [IWaterfallChartSpec](#type-8f8a21509020) +- [IWordCloudChartSpec](#type-5e23d784e4af) +- [ICompilableData](#type-bac9ca204677) +- [CompilerListenerParameters](#type-9760c8c7fdef) +- [GrammarItemCompileOption](#type-13afff202962) +- [ICompilable](#type-590d0c32ce42) +- [ICompilableInitOption](#type-f33e72c56cee) +- [ICompiler](#type-cbf1a5d7de9b) +- [IGrammarItem](#type-96b4a08944c0) +- [ITransformSpec](#type-e91ac41860ff) +- [StateValueMap](#type-8cab308b2bc7) +- [GestureConfig](#type-6ae14ac920fd) +- [IOptimizeType](#type-4a85608bd0f1) +- [IRenderOption](#type-0f4236fc8d55) +- [LayoutState](#type-4a8b32cef03c) +- [ICompilableMark](#type-fb1ce8327f06) +- [IMarkCompileOption](#type-4c11a0696204) +- [IMarkConfig](#type-589e28ffc9d8) +- [IMarkStateManager](#type-ee48e6df46c2) +- [IModelMarkAttributeContext](#type-b137387c3a9b) +- [ISeriesMarkAttributeContext](#type-57ff7f1e0f2e) +- [IStateInfo](#type-88e39c561dcb) +- [STATE_CUSTOM](#type-77e45e91e9ef) +- [STATE_HOVER](#type-988d7ec528f6) +- [STATE_HOVER_REVERSE](#type-b2903000e622) +- [STATE_NORMAL](#type-d571794e99de) +- [STATE_VALUE_ENUM](#type-05b8969d76ad) +- [StateValue](#type-0848cecfdc96) +- [StateValueNot](#type-166ca5507a1b) +- [StateValueType](#type-17574edeab90) +- [IAxisHelper](#type-a26561e1568e) +- [AxisType](#type-3271a928e402) +- [IAxis](#type-9cbd2aefe72d) +- [IAxisItem](#type-a4970733eae3) +- [IAxisLocationCfg](#type-a2ddebc5e9d7) +- [IBandAxisLayer](#type-840e25edaed7) +- [ITickCalculationCfg](#type-d35c784ee3a7) +- [ITickCallbackOption](#type-41696b783ff0) +- [StyleCallback](#type-9266636e13da) +- [IBandAxisSpec](#type-63185662c008) +- [ICommonAxisSpec](#type-500cf18886a4) +- [IDomainLine](#type-89c12f9d6546) +- [IGrid](#type-1de217f01390) +- [ILabel](#type-f22047f767c3) +- [ISubTick](#type-8a597b4f0966) +- [ITick](#type-ffc51285024b) +- [ITitle](#type-d18262dc39a4) +- [IPolarAxisHelper](#type-2617700989c6) +- [IPolarGrid](#type-9dc0e97c311d) +- [IPolarAxisCommonSpec](#type-b43b48bb37ff) +- [IPolarAxisLabel](#type-fc89a697d2d9) +- [IPolarBandAxisSpec](#type-3621aa2a35eb) +- [IPolarLinearAxisSpec](#type-1ee0a50d0f01) +- [IComponentSpec](#type-d23c51c12154) +- [ICrosshairSpec](#type-2c1a18c2e6b2) +- [IGeoCoordinateHelper](#type-73cca056070b) +- [IComponent](#type-5d7fe81ad96c) +- [IComponentConstructor](#type-897b853a0458) +- [IComponentOption](#type-3aea69e255fe) +- [ComponentTypeEnum](#type-da1c88fe2ca8) +- [ILabelInfo](#type-c5e997daff79) +- [TransformedLabelSpec](#type-cc4522eb0b63) +- [ContinuousLegendTextStyle](#type-002e36355ca4) +- [ContinuousLegendTextStyleCallback](#type-9281e10d6686) +- [HandlerTextAttribute](#type-a72bb8927b69) +- [IColorLegendSpec](#type-8565dc89d142) +- [IContinuousLegendSpec](#type-178043e98fbb) +- [ISizeLegendSpec](#type-19c6d929a8de) +- [Text](#type-960aad16c272) +- [TextAttribute](#type-2a9351a6ae07) +- [DiscreteLegendArrangeCount](#type-fba860215816) +- [formatterCallback](#type-38a35ad3a73f) +- [IDiscreteLegendArrangeContext](#type-b2a5329df03f) +- [IDiscreteLegendPagerCallbackContext](#type-c58e01a94725) +- [IDiscreteLegendSpec](#type-0db130a1ae74) +- [IItem](#type-57549774cd09) +- [ILegendScrollbar](#type-d1127d0675cd) +- [IPager](#type-f566fb09d5b0) +- [LegendItemStyle](#type-643f46f185c3) +- [LegendItemStyleValue](#type-4f178926a3e4) +- [LegendPagerLayout](#type-a73f71981dd9) +- [LegendPagerPosition](#type-f597fa365630) +- [ILegend](#type-a385f1cab926) +- [ILegendCommonSpec](#type-2ad671a416ad) +- [ITitle](#type-22ab2af9147f) +- [NoVisibleMarkStyle](#type-bf107a034542) +- [IAggrType](#type-952d359c9b51) +- [IDataPointSpec](#type-f2db44670f10) +- [IDataPos](#type-4e110ff2986a) +- [IDataPosCallback](#type-1379fa4fc2bc) +- [IMarkerAttributeContext](#type-2598f79dce37) +- [IMarkerCrossSeriesSpec](#type-88cab1c9cdbd) +- [IMarkerLabelSpec](#type-2d979381ccd7) +- [IMarkerLabelWithoutRefSpec](#type-253fe6ea4b96) +- [IMarkerPositionsSpec](#type-53a3e8a64bc1) +- [IMarkerRef](#type-542373c2f97e) +- [IMarkerState](#type-1839dc4b258a) +- [IMarkerSupportSeries](#type-cee3d7685723) +- [IMarkerSymbol](#type-3acb04a4042d) +- [MarkerPositionPoint](#type-99fde6736e73) +- [MarkerStateCallback](#type-6718d706fea0) +- [MarkerStateValue](#type-c42b3a87f060) +- [MarkerStyleCallback](#type-88db8cbea942) +- [OffsetPoint](#type-7815e4367a31) +- [IMarkAreaAngleRadiusSpec](#type-b2457805e643) +- [IMarkAreaAngleSpec](#type-4eea11d6bf8d) +- [IMarkAreaCoordinateSpec](#type-99ea0813e616) +- [IMarkAreaRadiusSpec](#type-d96016d9da72) +- [IMarkAreaXSpec](#type-ed2c343ef812) +- [IMarkAreaXYSpec](#type-23ed00b3b201) +- [IMarkAreaYSpec](#type-19f94791c9c6) +- [IRegressType](#type-0d292ecf19f3) +- [IMarkAreaLabel](#type-4079709b8a02) +- [IMarkAreaTheme](#type-7880c31abf52) +- [IMarkLineAngleSpec](#type-cbf79085c0de) +- [IMarkLineAngRadRad1Spec](#type-3df3d54de17a) +- [IMarkLineAngRadSpec](#type-1818f2e34d58) +- [IMarkLineCoordinateSpec](#type-25e80ef7b42b) +- [IMarkLineRadAngAng1Spec](#type-604e38ee5301) +- [IMarkLineRadiusSpec](#type-a2d55cb80bac) +- [IMarkLineXSpec](#type-7ce1823090a0) +- [IMarkLineXYSpec](#type-f50693a23ba0) +- [IMarkLineXYY1Spec](#type-72d0df8a5295) +- [IMarkLineYSpec](#type-d5755e40af1e) +- [IMarkLineYXX1Spec](#type-9fa06e53cb0e) +- [IMarkLineLabel](#type-e04a2517c735) +- [IMarkLineTheme](#type-1ca140194889) +- [IMarkPointAngleRadiusSpec](#type-0acfdd5b8e06) +- [IMarkPointCoordinateSpec](#type-8c827e1a43c9) +- [IMarkPointGeoNameSpec](#type-fd30b323288a) +- [IMarkPointPositionsSpec](#type-78d1410fa542) +- [IMarkPointXYSpec](#type-c38f0b023570) +- [IItemContent](#type-8262891f07ed) +- [IItemContentStyle](#type-364c9501578d) +- [IItemLine](#type-8dd1e2b302ff) +- [IMarkPointTheme](#type-a26d3a0701c1) +- [IOffsetCallback](#type-db4f6fc17505) +- [ITitleSpecWithoutText](#type-6d4657ffd0d7) +- [ITooltip](#type-b713b3be426c) +- [TooltipHandlerParams](#type-82517d84c2af) +- [TooltipResult](#type-34c5550c97cd) +- [TooltipEventParams](#type-e5c2cb9ed465) +- [ITooltipHandlerSpec](#type-9ead2353606b) +- [ITooltipTextTheme](#type-6f8c16b9dce7) +- [ChartEvent](#type-4c68f24bfcad) +- [Event_Bubble_Level](#type-c7b3d3b6b38f) +- [Event_Source_Type](#type-e0819375e8e5) +- [HOOK_EVENT](#type-f58080efc74b) +- [DataLinkAxis](#type-803024406435) +- [DataLinkSeries](#type-84a00f86d855) +- [IVChart](#type-f6dc633e5201) +- [IVChartRenderOption](#type-88e49d0ebe2f) +- [VChartRenderActionSource](#type-3bb499134256) +- [StatisticOperations](#type-d92fd69b2371) +- [DimensionEventParams](#type-15e7376683b8) +- [IDimensionData](#type-5b72dbd75644) +- [IDimensionInfo](#type-06b8a10af7b9) +- [BaseEventParams](#type-5ccfcc25894f) +- [ComponentType](#type-30b50e7b9294) +- [EventBubbleLevel](#type-3e4576b7a2a4) +- [EventCallback](#type-bc53e0f9fdb2) +- [EventFilter](#type-b46fb265f1d7) +- [EventHandler](#type-9dde9b52a754) +- [EventParams](#type-d0b5c8774949) +- [EventParamsDefinition](#type-bb8c7f815cf1) +- [EventQuery](#type-61ce50950087) +- [EventSourceType](#type-1c63b5fdb81d) +- [EventTargetType](#type-5c354e2dcaad) +- [EventType](#type-a71637b330ab) +- [ExtendEventParam](#type-577e7fff4950) +- [IComposedEvent](#type-4860a71f1f46) +- [IEvent](#type-17583cb7e08d) +- [IEventDispatcher](#type-e3c12fa8de7f) +- [InteractionEventParam](#type-27175d2429ec) +- [LayoutEventParam](#type-e80f4120aa8f) +- [PanEventParam](#type-fd27c5f76824) +- [SuperEvent](#type-6c02331b393a) +- [ZoomEventParam](#type-e212628531e0) +- [IInteraction](#type-8a888a648496) +- [IBaseTriggerOptions](#type-f51a72b7d484) +- [ITrigger](#type-4cc357381c0a) +- [ITriggerEventHandler](#type-f4836a1e3d12) +- [ElementSpec](#type-6b92034e666e) +- [IBaseLayoutSpec](#type-5de1760225a6) +- [IGridLayoutSpec](#type-8c0cc65dc7ab) +- [ILayoutItem](#type-a23ec9ff5239) +- [ILayoutItemSpec](#type-31e5f8b69a13) +- [ILayoutSpecBase](#type-a40f94687b59) +- [LayoutCallBack](#type-0bf7cec9094c) +- [AnimationStateValues](#type-0460768bb02c) +- [DiffStateValues](#type-1352ed6c1d81) +- [IAttrConfig](#type-597b323ab9ea) +- [IAttrs](#type-26f957d91e5c) +- [IDataSamping](#type-e33013d66ce5) +- [IGraphicContext](#type-ff3da46fbc1c) +- [IMark](#type-50aedeb586cf) +- [IMarkGraphic](#type-6b98396ffcb3) +- [IMarkOverlap](#type-bed88451c0c6) +- [IMarkProgressiveConfig](#type-059a3e6127d2) +- [IMarkRaw](#type-8245181df7c4) +- [IMarkStateStyle](#type-103f402e7251) +- [IMarkStyle](#type-574e4d23d491) +- [ISamplingMethod](#type-0ce27198f72d) +- [MarkInputStyle](#type-b04af6888dbd) +- [StyleConvert](#type-f616fecb91f8) +- [VisualScaleType](#type-a7e81495b9fc) +- [IComponentMark](#type-642b39fa286c) +- [IGroupMark](#type-8815337da68f) +- [ILabelMark](#type-e9520a36483b) +- [ISymbolMark](#type-dd0f2569fc22) +- [ITextMark](#type-fef57d2925f9) +- [MarkType](#type-15c62fdeb46b) +- [MarkTypeEnum](#type-f61b3242139b) +- [IBaseModelSpecTransformer](#type-d0389b7c19ac) +- [IBaseModelSpecTransformerOption](#type-a06278aae67d) +- [IBaseModelSpecTransformerResult](#type-9be6c667e373) +- [IEffect](#type-2ef752cff22f) +- [ILayoutModel](#type-b788a1bf7960) +- [IModel](#type-2854a5da67ea) +- [IModelConstructor](#type-b2886ff503c6) +- [IModelEvaluateOption](#type-680368166ca8) +- [IModelInitOption](#type-d5cf5deb27b7) +- [IModelMarkInfo](#type-c6d245a05c0a) +- [IModelOption](#type-f2d5e89f0268) +- [IModelSpec](#type-93f598dd1ef8) +- [IModelSpecInfo](#type-854f78cb6f0a) +- [ITooltipHelper](#type-47faea1d542e) +- [IUpdateSpecEffects](#type-ebdfb7b1febc) +- [IUpdateSpecResult](#type-646a207a21dd) +- [IRegion](#type-a83d28f54f24) +- [IRegionConstructor](#type-4ab33fce2070) +- [IRegionSpec](#type-de53416bbb15) +- [IRegionSpecInfo](#type-dacf9d61a878) +- [ISeriesFilter](#type-547a568e3f15) +- [IGlobalScale](#type-86e42efb33dd) +- [AreaAppearPreset](#type-1632d0cf5560) +- [AreaMarks](#type-6b16760e15b0) +- [IAreaSeriesSpec](#type-3c1aa405c767) +- [BarAppearPreset](#type-2a04d7b5d5bc) +- [BarMarks](#type-d2964854c2a3) +- [IBarBackgroundSpec](#type-659e249e0870) +- [IBarSeriesSpec](#type-e01baddbd8aa) +- [IBoxPlotSeriesSpec](#type-4f696616234f) +- [ICartesianSeriesSpec](#type-3814e1f2a8e7) +- [CirclePackingAppearPreset](#type-b9b1dad57548) +- [CirclePackingMark](#type-c5aa6f08af16) +- [ICirclePackingSeriesSpec](#type-bbcfdbd7ab2b) +- [CorrelationAppearPreset](#type-9e370720e4c3) +- [CorrelationMarks](#type-bdf6cade9a59) +- [ICorrelationSeriesSpec](#type-129af10992bf) +- [FunnelAppearPreset](#type-ca0d8e9e8ab0) +- [FunnelMarks](#type-c0065cc5144e) +- [IFunnelSeriesSpec](#type-0291e38eb55c) +- [GaugeMarks](#type-258bf98aa33b) +- [GaugePointerMarks](#type-1acef37a74c3) +- [IGaugeLabelSpec](#type-a11bb56c1a44) +- [IGaugePointerSeriesSpec](#type-9fdd71c680f3) +- [IGaugeSeriesSpec](#type-dfd9dde34e4c) +- [PinMarkSpec](#type-d46655d2cdbe) +- [PointerMarkSpec](#type-f4b734667103) +- [HeatmapAppearPreset](#type-a73edb9100ac) +- [HeatmapMarks](#type-5bfb84e5033a) +- [IHeatmapSeriesSpec](#type-6600af61a1ec) +- [ISeriesConstructor](#type-4d9d86b6e907) +- [ISeriesMarkInfo](#type-2d3d647d41bf) +- [ISeriesOption](#type-12b6b1d47870) +- [ISeriesSeriesInfo](#type-4d7144f1b638) +- [ISeriesSpecInfo](#type-94e8317ff02e) +- [ISeriesSpecTransformerResult](#type-bcafdba3ac92) +- [ISeriesStackData](#type-7770159e04bb) +- [ISeriesStackDataLeaf](#type-17aca4fa17c9) +- [ISeriesStackDataMeta](#type-9aad3a641385) +- [ISeriesStackDataNode](#type-234297d4a62a) +- [SeriesMarkMap](#type-90c30713a8c3) +- [ICartesianSeries](#type-80c7ff644ee5) +- [IGeoSeries](#type-7f5ce0113c45) +- [IPolarSeries](#type-6c82e34ce6af) +- [ISeries](#type-29ca9e871dc0) +- [SeriesTypeForThemeEnum](#type-5683fd6b700a) +- [ISeriesTooltipHelper](#type-bdf90758165d) +- [SeriesMarkNameEnum](#type-df86033a747f) +- [boxPlot](#type-3b9e5d5f1ab0) +- [progress](#type-a5db06e8dac0) +- [track](#type-3720a45bf7f9) +- [word](#type-dcab00960f46) +- [SeriesType](#type-43422e48d197) +- [SeriesTypeEnum](#type-11db701f3ba0) +- [ILineSeriesSpec](#type-c14fbe0b660f) +- [LineAppearPreset](#type-6966f849b7c7) +- [LineMarks](#type-da75180b071f) +- [ILiquidPadding](#type-bef15b2fe03b) +- [ILiquidPaddingSpec](#type-a2cf44bad013) +- [ILiquidSeriesSpec](#type-fbf087ad5565) +- [LiquidAppearPreset](#type-e2f6a6a53711) +- [LiquidMarks](#type-3527d2d11421) +- [LiquidShapeType](#type-02af83268c9f) +- [IMapSeriesSpec](#type-f28afaaaf021) +- [LineMarks](#type-7872a83a9a39) +- [IMosaicSeriesSpec](#type-1b11da6c8615) +- [IPieSeriesSpec](#type-71acefc8c120) +- [PieAppearPreset](#type-c560860d2a3d) +- [PieMarks](#type-b04753817bef) +- [IPolarSeriesSpec](#type-1ed415b7c25f) +- [IProgressLikeSeriesSpec](#type-d7ad84462ce9) +- [ITickMaskSpec](#type-ab1fc6a002d4) +- [ProgressLikeAppearPreset](#type-eb112c7e9a22) +- [IRoseLikeSeriesSpec](#type-9e858d8f5809) +- [CircularProgressMarks](#type-26e9a8fad3db) +- [ICircularProgressSeriesSpec](#type-30261f5b0d11) +- [IProgressSeriesSpec](#type-ea6a754e3de0) +- [ILinearProgressSeriesSpec](#type-a272f43e66ef) +- [LinearProgressAppearPreset](#type-1cff2ef63939) +- [IRadarSeriesSpec](#type-702f2f2e90b8) +- [RadarAppearPreset](#type-3ec398b9ec94) +- [RadarMarks](#type-44fb5d824dc0) +- [IRangeAreaSeriesSpec](#type-777c15c57cb1) +- [IRangeColumnSeriesSpec](#type-71611a6326b0) +- [minMaxPositionEnum](#type-e105bd77edce) +- [PositionEnum](#type-febd1be01553) +- [RangeColumnAppearPreset](#type-df0bef8e8bc4) +- [RangeColumnMarks](#type-d32ba1b05901) +- [IRoseSeriesSpec](#type-50a9d844112a) +- [RoseAppearPreset](#type-c671df1145cb) +- [RoseMarks](#type-a5a601985dc4) +- [ISankeySeriesSpec](#type-73ad288a6b3a) +- [SankeyAppearPreset](#type-6997583ca0c0) +- [SankeyLinkDatum](#type-5517b5c19b32) +- [SankeyLinkElement](#type-e49f605dc3e0) +- [SankeyMark](#type-2f12a706e2ad) +- [SankeyNodeDatum](#type-0e7c9dea40ba) +- [SankeyNodeElement](#type-1474c7d432e5) +- [IScatterSeriesSpec](#type-08a7bd218e9e) +- [ScatterAppearPreset](#type-76d1da4aa75e) +- [ScatterMarks](#type-fd1929cd17c5) +- [SunburstAppearPreset](#type-9821e1ad4f86) +- [SunburstMark](#type-97edc6635996) +- [ISunburstSeriesSpec](#type-42998a239bf0) +- [LabelAutoVisibleType](#type-e60547cde037) +- [ITreemapSeriesSpec](#type-6cdfbc0c0174) +- [TreemapAppearPreset](#type-24b5502879db) +- [TreemapMark](#type-a996892adf6f) +- [IVennSeriesSpec](#type-3b900b97c368) +- [VennAppearPreset](#type-1a92a41b84da) +- [VennMark](#type-d1fec4347076) +- [IWaterfallSeriesSpec](#type-312af991e7a8) +- [IWaterfallStackLabelPosition](#type-000580d95d76) +- [IWaterfallStackLabelValueType](#type-bc167196a113) +- [WaterfallAppearPreset](#type-8850f720f897) +- [WaterfallMarks](#type-bb1d273d83e6) +- [IWordCloudSeriesBaseSpec](#type-545e0cd34c67) +- [IWordCloudSeriesSpec](#type-472dc2c97d50) +- [WordcloudAppearPreset](#type-230d77f59707) +- [ColorScheme](#type-56ac75a33cd8) +- [ColorSchemeItem](#type-3b07bb001775) +- [DataSchemeItem](#type-14c76aab7e3f) +- [IColorKey](#type-a3c3eb9876a9) +- [IColorSchemeStruct](#type-aaa1ea372a28) +- [IProgressiveDataSchemeCase](#type-305e40988a2a) +- [IsProgressiveDataSchemeAvailableCallback](#type-759e0317b6ff) +- [IThemeColorScheme](#type-45344180023e) +- [ProgressiveDataScheme](#type-d334d5b74366) +- [ITokenKey](#type-cbbd743bf503) +- [Datum](#type-bf5eb9a79e61) +- [Maybe](#type-644c0bc1509c) +- [MaybeArray](#type-915c1abd7543) +- [StringOrNumber](#type-2f92a26f4727) +- [CoordinateType](#type-f14ee29f7b8b) +- [IPoint](#type-58fdfd9a6a7b) +- [IPolarPoint](#type-d403c828183d) +- [Cursor](#type-05ee2579711f) +- [IInvalidType](#type-5ea94ba3721c) +- [IGroup](#type-7066ab370b9d) +- [ILayoutNumber](#type-9638d3997297) +- [ILayoutOrientPadding](#type-b2bc0ee5203d) +- [ILayoutPoint](#type-6dd6ef1acef0) +- [ILayoutRect](#type-b4324e55ab6b) +- [ILayoutType](#type-7ececfbaa390) +- [IPercentOffset](#type-d014dbe57510) +- [IRegionQuerier](#type-a826f89dd07b) +- [IShowTooltipOption](#type-b4df769a6b46) +- [Direction](#type-0eaca977a05a) +- [DirectionType](#type-244d188586b9) +- [IOrientType](#type-1c1f18d62ff6) +- [IPolarOrientType](#type-ccede16adcb5) +- [IRect](#type-51a55b549762) +- [ChartSpecMap](#type-61e059a17d79) +- [ISpec](#type-c3727b86f632) +- [BuildInTransformOptions](#type-0ad7a402bbdf) +- [CommonParseOptions](#type-fdac4230815f) +- [DataKeyType](#type-4bea0f6c4d4f) +- [EnableMarkType](#type-1fa7d0f6abc4) +- [IBuildinMarkSpec](#type-1de36c1cfcb0) +- [IChartExtendsSeriesSpec](#type-0d38580aaf51) +- [IChartSpec](#type-57e06d38bf09) +- [IDataType](#type-3bf45e5ed347) +- [IDataValues](#type-218b08963b1d) +- [IFieldsMeta](#type-ad6958bb1a0b) +- [IFormatMethod](#type-6375b3333257) +- [IMarkStateFilter](#type-493dcf0721cf) +- [IMarkStateSpec](#type-4d46c5681360) +- [IPerformanceHook](#type-095e16af33ef) +- [IRichTextFormatMethod](#type-3b28c6257cf4) +- [ITextFormatMethod](#type-5a8994f84d7b) +- [RenderMode](#type-875ef0d8fcf4) +- [RenderModeEnum](#type-240f8a4ed23c) +- [SheetParseOptions](#type-dbdce91761d0) +- [TooltipContentCallback](#type-bb854deb9020) +- [TooltipUpdateCallback](#type-58900beb05b3) +- [ITooltipHandler](#type-73b5fb837aea) +- [TooltipActiveType](#type-990c112f10af) +- [TooltipData](#type-2020c8fc6cbe) +- [ITooltipLabelActual](#type-c308b976acfb) +- [ITooltipLineActual](#type-50e4fd39a41a) +- [ITooltipPositionActual](#type-b07cdb853d88) +- [ITooltipShapeActual](#type-641241d7a7b9) +- [ITooltipActual](#type-b6803f56a729) +- [BackgroundMode](#type-335140a3e2b6) +- [BackgroundPosition](#type-79f8ce85abb1) +- [BackgroundPositionHorizontalKeyword](#type-31dac926518d) +- [BackgroundPositionKeyword](#type-d7d952da248e) +- [BackgroundPositionPercent](#type-81363cd19fe5) +- [BackgroundPositionPreset](#type-9b6ac71cd590) +- [BackgroundPositionValue](#type-da20797f386c) +- [BackgroundPositionVerticalKeyword](#type-1c3d2aa1fdc1) +- [BackgroundRepeatMode](#type-6fb8f4404334) +- [BackgroundSizingShorthand](#type-f5dcfb5b7d65) +- [ConvertToMarkStyleSpec](#type-3f4d44a2bad5) +- [GradientPropValue](#type-b9b2288b01f6) +- [GradientStop](#type-105bc3b38706) +- [IBorder](#type-c857646a1dda) +- [ICommonSpec](#type-642c420237a7) +- [IComposedTextMarkSpec](#type-3cdc9715d892) +- [IFillMarkSpec](#type-36e76424276b) +- [IGradient](#type-4cdfc5286411) +- [IGradientConical](#type-6564c798928d) +- [IGradientLinear](#type-a9d5ddd8d42f) +- [IGradientRadial](#type-7c5f562e4fc5) +- [IMarkHtmlSpec](#type-d9ef36a1c319) +- [IPositionedTextMarkSpec](#type-62ea327d0fc7) +- [IRichTextMarkSpec](#type-19e9483035ff) +- [IVisual](#type-9bb9b1b41b53) +- [IVisualScale](#type-d2a6fed8edde) +- [IVisualSpecStyle](#type-ae2e55448a0a) +- [TextAlign](#type-6b2c76bfb154) +- [TextBaseLine](#type-94a26edb6027) +- [TextureType](#type-7dd7d41922bc) +- [ValueType](#type-979efd9d6b47) +- [VisualType](#type-e295ec9bce6b) + + +## DataSet + +来源：`@visactor/vdataset/es/data-set.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export declare class DataSet { + options?: IDataSetOptions; + isDataSet: boolean; + /** + * 已注册的 Transform（key-value 对） + */ + transformMap: Record; + /** + * 已注册的 Parser(key-value 对） + */ + parserMap: Record; + /** + * 所有挂在数据集上的数据视图（key-value 对） + */ + dataViewMap: Record; + name: string; + /** + * 消息的监听与触发 + */ + target: any; + /** + * 多 DataView消息监听工具 + */ + _callMap: Map void>; + protected _logger: ILogger; + constructor(options?: IDataSetOptions); + setLogger(logger: Logger): void; + /** + * 根据name 获取 dataView + * @param name - name + */ + getDataView(name: string | number): DataView; + /** + * 设置 dataView + * @param name - 名称 + * @param dataView - data dataView + */ + setDataView(name: string | number, dataView: DataView): void; + /** + * 移除 dataview + * @param name + */ + removeDataView(name: string | number): void; + /** + * 注册一个数据解析器 + * @param name - 类型 + * @param parser - 解析逻辑 + */ + registerParser(name: string, parser: Parser): void; + /** + * 移除 parser + * @param name + */ + removeParser(name: string): void; + /** + * 根据名称获取数据解析器 + * @param name + * @returns + */ + getParser(name: string): Parser; + /** + * 注册一个数据处理函数 + * @param name + * @param transform + */ + registerTransform(name: string, transform: Transform): void; + /** + * 移除 transform + * @param name + */ + removeTransform(name: string): void; + /** + * 根据名称获取数据处理函数 + * @param name + * @returns + */ + getTransform(name?: string): Transform; + multipleDataViewAddListener(list: DataView[], event: string, call: Function): void; + allDataViewAddListener(event: string, call: () => void): void; + multipleDataViewRemoveListener(list: DataView[], event: string, call: Function): void; + multipleDataViewUpdateInParse(newData: { + name: string; + data: any; + options?: IParserOptions; + }[]): void; + multipleDataViewUpdateInRawData(newData: { + name: string; + data: any; + options?: IParserOptions; + }[]): void; + destroy(): void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## DataView + +来源：`@visactor/vdataset/es/data-view.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export declare class DataView { + dataSet: DataSet; + options?: IDataViewOptions; + isDataView: boolean; + type: DATAVIEW_TYPE; + name: string | number; + target: any; + /** + * 当前parser + */ + parseOption: IParserOptions; + /** + * 已应用的 transform + */ + transformsArr: Array; + /** + * 是否正在运行 parse 和 transform + */ + isRunning: boolean; + /** + * 原始数据 + */ + rawData: any; + history: boolean; + /** + * 中间态数据，默认 history false 不存储 + */ + historyData: any[]; + /** + * parser后的数据 + */ + parserData: any; + /** + * 最终数据 + */ + latestData: any; + /** + * 数据维度信息 + */ + protected _fields: IFields; + latestDataAUD: { + add: any; + update: any; + del: any; + }; + constructor(dataSet: DataSet, options?: IDataViewOptions); + /** + * 解析数据 + * todo: parse instanceof DataView + * todo: parse ['dataview1', 'dataview2'] + * @param data + * @param options + * @returns + */ + parse(data: any, options?: IParserOptions, emit?: boolean): DataView; + /** + * 执行数据处理数据 + * @param options + */ + transform(options: ITransformOptions, execute?: boolean): DataView; + sortTransform(): void; + private executeTransform; + private resetTransformData; + reRunAllTransform: (opt?: DataViewTransformOptions) => this; + private cloneParseData; + parseNewData(data: any, options?: IParserOptions): void; + updateRawData(data: any, options?: IParserOptions): void; + markRunning: () => void; + getFields(): any; + setFields(f: IFields, foreMerge?: boolean): void; + destroy(): void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IDsvParserOptions + +来源：`@visactor/vdataset/es/parser/dsv.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface IDsvParserOptions { + delimiter?: string; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IParserOptions + +来源：`@visactor/vdataset/es/parser/index.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface IParserOptions { + type: ParserName; + clone?: boolean; + options?: any; + layerType?: string; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IFieldsOptions + +来源：`@visactor/vdataset/es/transform/fields.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface IFieldsOptions { + fields: IFields; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IFilterOptions + +来源：`@visactor/vdataset/es/transform/filter.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface IFilterOptions { + callback?: (item: any) => boolean; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IFoldOptions + +来源：`@visactor/vdataset/es/transform/fold.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface IFoldOptions { + fields: string[]; + key: string; + value: string; + retains?: string[]; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ISimplifyOptions + +来源：`@visactor/vdataset/es/transform/geo/simplify.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface ISimplifyOptions { + tolerance?: number; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ITransformOptions + +来源：`@visactor/vdataset/es/transform/index.d.ts`，@visactor/vdataset@1.0.28 + +```typescript +export interface ITransformOptions { + type: TransformName; + options?: any; + level?: number; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## TreemapOptions + +来源：`@visactor/vlayouts/es/treemap/interface.d.ts`，@visactor/vlayouts@1.0.28 + +```typescript +export interface TreemapOptions { + /** + * The gap width between two nodes which has the same depth, two kinds of value are supported + * 1. number: set the gapWidth for nodes of every depth + * 2. number[]: number[i] means the gapWidth for node which depth = i; + */ + gapWidth?: number | number[]; + /** + * The padding width, two kinds of value are supported + * 1. number: set the padding for nodes of every depth + * 2. number[]: number[i] means the padding for node which depth = i; + */ + padding?: number | number[]; + /** + * the width / height ratio + */ + aspectRatio?: number; + /** + * The padding for non-leaf node, we can use this space to display a label + * This pading will only works when the node has enough space + */ + labelPadding?: number | number[]; + /** + * The position of label for non-leaf node + */ + labelPosition?: 'top' | 'bottom' | 'left' | 'right'; + /** + * the type of algorithm + */ + splitType?: 'binary' | 'dice' | 'slice' | 'sliceDice' | 'squarify'; + /** parse the key of node */ + nodeKey?: string | number | ((datum: TreemapDatum) => string | number); + /** + * the max depth to be showed, when the node has depth > maxDepth, the node won't be calculated + */ + maxDepth?: number; + /** + * when the area (this unit is px * px) of the node is smaller then this value, this node will be hide + */ + minVisibleArea?: number | number[]; + /** + * when the area (this unit is px * px) of the node is smaller then this value, this children of this node will be hide + */ + minChildrenVisibleArea?: number | number[]; + /** + * when the width or height of the node is smaller then this value, this node will be hide + */ + minChildrenVisibleSize?: number | number[]; + /** + * specify treemap node value field, defaults to `value` + */ + valueField?: string; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ACustomAnimate + +来源：`@visactor/vrender-animate/es/custom/custom-animate.d.ts`，@visactor/vrender-animate@1.1.12 + +```typescript +export declare abstract class ACustomAnimate extends Step implements ICustomAnimate { + type: IAnimateStepType; + customFrom: T; + params?: any; + props?: T; + from?: T; + to?: T; + constructor(customFrom: T, customTo: T, duration: number, easing: EasingType, params?: any); + update(end: boolean, ratio: number, out: Record): void; + protected setProps(props: T): void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## AStageAnimate + +来源：`@visactor/vrender-animate/es/custom/custom-animate.d.ts`，@visactor/vrender-animate@1.1.12 + +```typescript +export declare abstract class AStageAnimate extends ACustomAnimate { + willCallBeforeStageRender: boolean; + willCallAfterStageRender: boolean; + checkStatusAfterRender: boolean; + constructor(customFrom: T, customTo: T, duration: number, easing: EasingType, params?: any); + protected beforeStageRender(stage: IStage, canvas: HTMLCanvasElement): HTMLCanvasElement | void | null | false; + protected afterStageRender(stage: IStage, canvas: HTMLCanvasElement): HTMLCanvasElement | void | null | false; + onFirstRun(): void; + stop(): void; + onUpdate(end: boolean, ratio: number, out: Record): void; + protected _beforeStageRender: () => void; + protected _afterStageRender: () => void; + protected renderToStage(stage: IStage, canvas: HTMLCanvasElement): HTMLCanvasElement | void | null | false; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## AxisItem + +来源：`@visactor/vrender-components/es/axis/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type AxisItem = { + id?: string | number; + label: string | number; + value: number; + rawValue: any; + [key: string]: any; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## AxisItemStateStyle + +来源：`@visactor/vrender-components/es/axis/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type AxisItemStateStyle = { + hover?: T; + hover_reverse?: T; + selected?: T; + selected_reverse?: T; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## AxisLabelOverlap + +来源：`@visactor/vrender-components/es/axis/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export interface AxisLabelOverlap { + autoRotate?: boolean; + autoRotateAngle?: number[]; + autoHide?: boolean; + autoHideMethod?: 'parity' | 'greedy' | CustomMethod; + autoHideSeparation?: number; + autoLimit?: boolean; + limitEllipsis?: string; + overflowLimitLength?: number | { + left?: number; + right?: number; + }; + layoutFunc?: (labels: IText[], labelData: AxisItem[], layer: number, axis: IGroup) => void; + autoWrap?: boolean; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## Functional + +来源：`@visactor/vrender-components/es/label/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type Functional = T | ((data: any) => T); +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## DiscreteLegendAttrs + +来源：`@visactor/vrender-components/es/legend/discrete/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type DiscreteLegendAttrs = { + select?: boolean | { + trigger?: GraphicEventType; + }; + hover?: boolean | { + trigger?: GraphicEventType; + triggerOff?: GraphicEventType; + }; + items: LegendItemDatum[]; + defaultSelected?: (string | number)[]; + selectMode?: 'single' | 'multiple' | 'focus'; + allowAllCanceled?: boolean; + reversed?: boolean; + item?: LegendItem; + maxWidth?: number; + maxHeight?: number; + maxRow?: number; + maxCol?: number; + lazyload?: boolean; + autoPage?: boolean; + pager?: LegendPagerAttributes | LegendScrollbarAttributes; +} & LegendBaseAttributes; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## LegendItem + +来源：`@visactor/vrender-components/es/legend/discrete/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type LegendItem = { + visible?: boolean; + spaceCol?: number; + spaceRow?: number; + maxWidth?: number; + width?: number; + height?: number; + padding?: Padding; + background?: { + visible?: boolean; + } & BaseGraphicAttributes | StyleCallback>>; + shape?: { + visible?: boolean; + space?: number; + } & BaseGraphicAttributes | StyleCallback>>; + autoEllipsisStrategy?: 'labelFirst' | 'valueFirst' | 'none'; + label?: { + widthRatio?: number; + space?: number; + formatMethod?: formatterCallback; + } & BaseGraphicAttributes | StyleCallback>>; + value?: { + widthRatio?: number; + space?: number; + alignRight?: boolean; + formatMethod?: formatterCallback; + } & BaseGraphicAttributes | StyleCallback>>; + focus?: boolean; + focusIconStyle?: Partial; + align?: 'left' | 'right'; + verticalAlign?: 'top' | 'middle' | 'bottom'; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## LegendItemDatum + +来源：`@visactor/vrender-components/es/legend/discrete/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type LegendItemDatum = { + id?: string; + label: string; + value?: string | number; + shape: { + symbolType?: string; + fill?: string; + stroke?: string; + }; + [key: string]: any; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## LegendPagerAttributes + +来源：`@visactor/vrender-components/es/legend/discrete/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type LegendPagerAttributes = Omit & LegendSwitchComponentAttributes & { + position?: 'start' | 'middle' | 'end'; + hugContent?: boolean; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## LegendScrollbarAttributes + +来源：`@visactor/vrender-components/es/legend/discrete/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type LegendScrollbarAttributes = Omit & LegendSwitchComponentAttributes & { + type: 'scrollbar'; + scrollByPosition?: boolean; + roamScroll?: boolean; + visible?: boolean; + scrollMask?: { + visible?: boolean; + gradientLength?: number; + gradientStops: ILinearGradient['stops']; + }; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## LegendTitle + +来源：`@visactor/vrender-components/es/legend/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type LegendTitle = { + visible?: boolean; + align?: 'start' | 'center' | 'end'; + space?: number; + padding?: Padding; + text?: string | string[] | number | number[] | TextContent['text']; + textStyle?: Partial; + shape?: { + visible?: boolean; + space?: number; + style?: Omit, 'visible'>; + }; + background?: { + visible?: boolean; + style?: Omit, 'visible' | 'width' | 'height'>; + }; + minWidth?: number; + maxWidth?: number; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## BaseMarkerAnimation + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type BaseMarkerAnimation = { + animation?: MarkerAnimation | boolean; + animationEnter?: MarkerUpdateAnimation; + animationUpdate?: MarkerUpdateAnimation; + animationExit?: MarkerExitAnimation; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IMarkAreaLabelPosition + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export declare enum IMarkAreaLabelPosition { + left = "left", + right = "right", + top = "top", + bottom = "bottom", + topLeft = "topLeft", + topRight = "topRight", + bottomLeft = "bottomLeft", + bottomRight = "bottomRight", + middle = "middle", + insideLeft = "insideLeft", + insideRight = "insideRight", + insideTop = "insideTop", + insideBottom = "insideBottom", + insideTopLeft = "insideTopLeft", + insideTopRight = "insideTopRight", + insideBottomLeft = "insideBottomLeft", + insideBottomRight = "insideBottomRight" +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IMarkCommonArcLabelPosition + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export declare enum IMarkCommonArcLabelPosition { + arcInnerStart = "arcInnerStart", + arcInnerEnd = "arcInnerEnd", + arcInnerMiddle = "arcInnerMiddle", + arcOuterStart = "arcOuterStart", + arcOuterEnd = "arcOuterEnd", + arcOuterMiddle = "arcOuterMiddle", + center = "center" +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IMarkLineLabelPosition + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export declare enum IMarkLineLabelPosition { + start = "start", + startTop = "startTop", + startBottom = "startBottom", + insideStart = "insideStart", + insideStartTop = "insideStartTop", + insideStartBottom = "insideStartBottom", + middle = "middle", + insideMiddleTop = "insideMiddleTop", + insideMiddleBottom = "insideMiddleBottom", + end = "end", + endTop = "endTop", + endBottom = "endBottom", + insideEnd = "insideEnd", + insideEndTop = "insideEndTop", + insideEndBottom = "insideEndBottom" +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IMarkPointItemPosition + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export declare enum IMarkPointItemPosition { + top = "top", + bottom = "bottom", + middle = "middle", + insideTop = "insideTop", + insideBottom = "insideBottom", + insideMiddle = "insideMiddle" +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## MarkCommonLineAnimationType + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type MarkCommonLineAnimationType = 'clipIn' | 'fadeIn'; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## MarkPointAnimationType + +来源：`@visactor/vrender-components/es/marker/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type MarkPointAnimationType = 'callIn' | 'fadeIn'; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## Datum + +来源：`@visactor/vrender-components/es/player/type/base.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type Datum = any; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## HandlerTextStyleContext + +来源：`@visactor/vrender-components/es/slider/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type HandlerTextStyleContext = { + layout?: SliderLayout; + align?: SliderAlign; + railWidth: number; + railHeight: number; + handlerSize?: number; + slidable?: boolean; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IContainerSize + +来源：`@visactor/vrender-components/es/tooltip/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export interface IContainerSize { + width?: number; + height?: number; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## TooltipRichTextAttrs + +来源：`@visactor/vrender-components/es/tooltip/type.d.ts`，@visactor/vrender-components@1.1.12 + +```typescript +export type TooltipRichTextAttrs = { + type?: string; + text?: IRichTextCharacter[] | string; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IApp + +来源：`@visactor/vrender-core/es/entries/types.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IApp { + readonly context: IAppContext; + readonly registry: IAppContext['registry']; + readonly factory: IAppContext['factory']; + readonly released: boolean; + installPlugin: (plugin: IPlugin) => void; + installPlugins: (plugins: IPlugin[]) => void; + uninstallPlugin: (name: string) => void; + createStage: (params?: Partial) => IStage; + release: () => void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## EasingType + +来源：`@visactor/vrender-core/es/interface/animation/easing.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type EasingType = EasingTypeStr | EasingTypeFunc; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ITicker + +来源：`@visactor/vrender-core/es/interface/animation/ticker.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface ITicker extends EventEmitter { + setFPS?: (fps: number) => void; + setInterval?: (interval: number) => void; + getFPS?: () => number; + getInterval?: () => number; + tick: (interval: number) => void; + tickAt?: (time: number) => void; + pause: () => boolean; + resume: () => boolean; + start: (force?: boolean) => boolean; + stop: () => void; + addTimeline: (timeline: ITimeline) => void; + remTimeline: (timeline: ITimeline) => void; + trySyncTickStatus: () => void; + getTimelines: () => ITimeline[]; + release: () => void; + bindStage: (stage: IStage) => void; + autoStop: boolean; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IColor + +来源：`@visactor/vrender-core/es/interface/color.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IColor = string | ILinearGradient | IRadialGradient | IConicalGradient; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IConicalGradient + +来源：`@visactor/vrender-core/es/interface/color.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IConicalGradient { + gradient: 'conical'; + startAngle?: number; + endAngle?: number; + x?: number; + y?: number; + stops: IGradientStop[]; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ILinearGradient + +来源：`@visactor/vrender-core/es/interface/color.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface ILinearGradient { + gradient: 'linear'; + x0?: number; + y0?: number; + x1?: number; + y1?: number; + stops: IGradientStop[]; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IRadialGradient + +来源：`@visactor/vrender-core/es/interface/color.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IRadialGradient { + gradient: 'radial'; + x0?: number; + y0?: number; + x1?: number; + y1?: number; + r0?: number; + r1?: number; + stops: IGradientStop[]; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IGraphic + +来源：`@visactor/vrender-core/es/interface/graphic.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IGraphic = Partial> extends INode, IAnimateTarget { + type?: GraphicType; + numberType?: number; + stage?: IStage; + layer?: ILayer; + shadowRoot?: IShadowRoot; + glyphHost?: IGraphic; + backgroundImg?: boolean; + attachedThemeGraphic?: IGraphic; + context?: Record; + bindDom?: Map; + valid: boolean; + parent: IGroup | null; + isContainer?: boolean; + in3dMode?: boolean; + widthWithoutTransform?: number; + heightWithoutTransform?: number; + stamp?: number; + animationBackUps?: { + from: Record; + to: Record; + }; + attribute: Partial; + pathProxy?: ICustomPath2D | ((attrs: T) => ICustomPath2D); + incremental?: number; + incrementalAt?: number; + states?: StateDefinitionsInput; + effectiveStates?: string[]; + resolvedStatePatch?: Partial; + normalAttrs?: Partial; + baseAttributes?: Partial; + boundSharedStateScope?: SharedStateScope; + boundSharedStateRevision?: number; + sharedStateDirty?: boolean; + registeredActiveScopes?: Set>; + stateMergeMode?: StateMergeMode; + findFace?: () => IFace3d; + toggleState: (stateName: string, hasAnimation?: boolean) => void; + removeState: (stateName: string | string[], hasAnimation?: boolean) => void; + clearStates: (hasAnimation?: boolean) => void; + setStates: { + (states?: string[] | null, hasAnimation?: boolean): void; + (states?: string[] | null, options?: ISetStatesOptions): void; + }; + useStates: (states: string[], hasAnimation?: boolean) => void; + addState: (stateName: string, keepCurrentStates?: boolean, hasAnimation?: boolean) => void; + invalidateResolver: () => void; + hasState: (stateName?: string) => boolean; + getState: (stateName: string) => Partial | StateDefinition; + onBeforeAttributeUpdate?: (val: any, attributes: Partial, key: null | string | string[], context?: ISetAttributeContext) => T | undefined; + applyStateAttrs: (attrs: Partial, stateNames: string[], hasAnimation?: boolean, isClear?: boolean, animateConfig?: IAnimateConfig) => void; + updateNormalAttrs: (stateAttrs: Partial) => void; + readonly AABBBounds: IAABBBounds; + readonly OBBBounds: IOBBBounds; + readonly globalAABBBounds: IAABBBounds; + readonly transMatrix: IMatrix; + readonly globalTransMatrix: IMatrix; + getOffsetXY: (attr?: ITransform) => IPoint; + containsPoint: (x: number, y: number, mode?: IContainPointMode, picker?: IPickerService) => boolean; + setMode: (mode: '3d' | '2d') => void; + isValid: () => boolean; + getClipPath: () => ISymbolClass | null; + translate: (x: number, y: number) => this; + translateTo: (x: number, y: number) => this; + scale: (scaleX: number, scaleY: number, scaleCenter?: IPointLike) => this; + scaleTo: (scaleX: number, scaleY: number) => this; + rotate: (angle: number, rotateCenter?: IPointLike) => this; + rotateTo: (angle: number) => this; + skewTo: (b: number, c: number) => this; + addUpdateBoundTag: () => void; + addUpdatePaintTag: () => void; + addUpdateShapeAndBoundsTag: () => void; + addUpdateLayoutTag: () => void; + update: (d?: { + bounds: boolean; + trans: boolean; + }) => void; + animate?: (params?: IGraphicAnimateParams) => IAnimate; + name?: string; + shouldUpdateShape: () => boolean; + clearUpdateShapeTag: () => void; + setAttributes: (params: Partial, forceUpdateTag?: boolean, context?: ISetAttributeContext) => void; + initAttributes: (params: Partial) => void; + setAttribute: (key: string, value: any, forceUpdateTag?: boolean, context?: ISetAttributeContext) => void; + setStage: (stage?: IStage, layer?: ILayer, inheritedSharedStateScope?: SharedStateScope> | null) => void; + detachStageForRelease: () => void; + onSetStage: (cb: (g: IGraphic, stage: IStage) => void) => void; + shouldUpdateAABBBounds: () => boolean; + shouldSelfChangeUpdateAABBBounds: () => boolean; + shouldUpdateGlobalMatrix: () => boolean; + addUpdatePositionTag: () => void; + addUpdateGlobalPositionTag: () => void; + attachShadow: () => IShadowRoot; + detachShadow: () => void; + toJson: () => IGraphicJson; + createPathProxy: (path?: string) => void; + toCustomPath?: () => ICustomPath2D; + resources?: Map; + imageLoadSuccess: (url: string, data: HTMLImageElement) => void; + imageLoadFail: (url: string) => void; + clone: () => IGraphic; + stopAnimates: (stopChildren?: boolean) => void; + getNoWorkAnimateAttr: () => Record; + getGraphicTheme: () => T; + getAttributes: (final?: boolean) => Partial; + pauseAnimation?: (deep?: boolean) => void; + resumeAnimation?: (deep?: boolean) => void; + stopAnimation?: (deep?: boolean) => void; + reApplyAnimationState?: (state: string, deep?: boolean) => this; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IGraphicAttribute + +来源：`@visactor/vrender-core/es/interface/graphic.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IGraphicAttribute = IDebugType & IGraphicStyle & ITransform & { + strokeSeg: IStrokeSeg | null; + boundsPadding: number | number[]; + pickMode: 'accurate' | 'imprecise' | 'custom'; + boundsMode: 'accurate' | 'imprecise' | 'empty'; + customPickShape: () => boolean | null; + pickable: boolean; + fillPickable: boolean; + strokePickable: boolean; + childrenPickable: boolean; + visible: boolean; + zIndex: number; + layout: any; + renderable: boolean; + keepDirIn3d?: boolean; + shadowRootIdx: number; + shadowPickMode?: 'full' | 'graphic'; + globalZIndex: number; + globalCompositeOperation: CanvasRenderingContext2D['globalCompositeOperation'] | ''; + overflow: 'scroll' | 'hidden' | 'scroll-x' | 'scroll-y'; + fillStrokeOrder: number; + keepStrokeScale: boolean; + clipConfig: { + shape: string; + } | null; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IGraphicStyle + +来源：`@visactor/vrender-core/es/interface/graphic.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IGraphicStyle = ILayout & IFillStyle & IStrokeStyle & IPickStyle & { + forceBoundsWidth: number | (() => number) | undefined; + forceBoundsHeight: number | (() => number) | undefined; + opacity: number; + shadowGraphic?: IGraphic | undefined; + backgroundMode: BackgroundMode; + backgroundFit: boolean; + backgroundKeepAspectRatio: boolean; + backgroundScale: number; + backgroundOffsetX: number; + backgroundOffsetY: number; + backgroundPosition: BackgroundPosition; + backgroundClip: boolean; + backgroundCornerRadius: number | number[]; + backgroundOpacity: number; + autoAnimateTexture: boolean; + textureRatio: number; + textureOptions: any; + background: IBackgroundType | { + background: IBackgroundType; + dx?: number; + dy?: number; + width?: number; + height?: number; + x?: number; + y?: number; + } | null; + texture: TextureType | string; + textureColor: string; + textureSize: number; + texturePadding: number; + blur: number; + cursor: Cursor | null; + filter: string; + renderStyle?: 'default' | 'rough' | any; + roughStyle?: IRoughStyle | null; + html: ({ + dom: string | HTMLElement; + } & SimpleDomStyleOptions & CommonDomOptions) | null; + react: ({ + element: any; + } & SimpleDomStyleOptions & CommonDomOptions) | null; + vue: ({ + element: any; + } & SimpleDomStyleOptions & CommonDomOptions) | null; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IGroup + +来源：`@visactor/vrender-core/es/interface/graphic/group.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IGroup extends IGraphic { + childrenPickable?: boolean; + theme?: ITheme; + sharedStateDefinitions?: StateDefinitionsInput>; + sharedStateScope?: SharedStateScope>; + createTheme: () => void; + hideAll: () => void; + showAll: () => void; + setTheme: (t: IThemeSpec) => void; + incrementalAppendChild: (node: INode, highPerformance?: boolean) => INode | null; + incrementalClearChild: () => void; + createOrUpdateChild: (graphicName: string, attributes: GraphicAttributeMap[T], graphicType: T) => INode; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IGroupGraphicAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/group.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IGroupGraphicAttribute = Partial & Partial; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IImageGraphicAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/image.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IImageGraphicAttribute = Partial & Partial; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IRichTextAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/richText.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IRichTextAttribute = { + upgradeAttrs: { + lineHeight: true; + multiBreakLine: true; + } | null; + width: number; + height: number; + editable: boolean; + ascentDescentMode?: 'actual' | 'font'; + editOptions: IRichTextEditOptionsType | null; + ellipsis: boolean | string; + wordBreak: RichTextWordBreak; + verticalDirection: RichTextVerticalDirection; + maxHeight: number; + maxWidth: number; + textAlign: RichTextGlobalAlignType; + textBaseline: RichTextGlobalBaselineType; + layoutDirection: RichTextLayoutDirectionType; + textConfig: IRichTextCharacter[]; + disableAutoWrapLine: boolean; + singleLine: boolean; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IRichTextCharacter + +来源：`@visactor/vrender-core/es/interface/graphic/richText.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IRichTextCharacter = IRichTextParagraphCharacter | IRichTextImageCharacter; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IRichTextGraphicAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/richText.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type IRichTextGraphicAttribute = Partial & Partial; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## SymbolType + +来源：`@visactor/vrender-core/es/interface/graphic/symbol.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type SymbolType = 'circle' | 'cross' | 'diamond' | 'square' | 'arrow' | 'arrowLeft' | 'arrowRight' | 'arrow2Left' | 'arrow2Right' | 'wedge' | 'thinTriangle' | 'triangle' | 'triangleUp' | 'triangleDown' | 'triangleRight' | 'triangleLeft' | 'stroke' | 'star' | 'wye' | 'rect' | 'rectRound' | 'roundLine' | string; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ITextAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/text.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type ITextAttribute = { + text: string | number | string[] | number[]; + maxLineWidth: number; + maxWidth: number; + textAlign: TextAlignType; + textBaseline: TextBaselineType; + fontSize: number; + fontFamily: string; + fontWeight: string | number; + ellipsis: boolean | string; + fontVariant: string; + fontStyle: string; + lineHeight: number | string; + underline: number; + lineThrough: number; + scaleIn3d: boolean; + direction: 'horizontal' | 'vertical'; + verticalMode: number; + wordBreak: 'break-word' | 'break-all' | 'keep-all'; + ignoreBuf: boolean; + heightLimit: number; + lineClamp: number; + wrap: boolean; + whiteSpace: 'normal' | 'no-wrap'; + suffixPosition: 'start' | 'end' | 'middle'; + underlineDash: number[]; + underlineOffset: number; + disableAutoClipedPoptip?: boolean; + measureMode?: MeasureModeEnum; + keepCenterInLine?: boolean; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ITextGraphicAttribute + +来源：`@visactor/vrender-core/es/interface/graphic/text.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type ITextGraphicAttribute = Partial & Partial; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## TextAlignType + +来源：`@visactor/vrender-core/es/interface/graphic/text.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type TextAlignType = 'left' | 'right' | 'center' | 'start' | 'end'; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## TextBaselineType + +来源：`@visactor/vrender-core/es/interface/graphic/text.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export type TextBaselineType = 'top' | 'middle' | 'bottom' | 'alphabetic'; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ILayer + +来源：`@visactor/vrender-core/es/interface/layer.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface ILayer extends IGroup { + parent: any; + main: boolean; + width: number; + height: number; + viewWidth: number; + viewHeight: number; + readonly layerMode: LayerMode; + renderCount: number; + offscreen: boolean; + subLayers: Map; + readonly dirtyBound: IAABBBounds; + background: string; + dpr: number; + opacity: number; + canvasId?: string; + imageData?: ImageData; + blendMode?: string; + pickable: boolean; + pick: (x: number, y: number) => { + graphic?: IGraphic; + group?: IGroup; + } | false; + render: (params: ILayerDrawParams, userParams?: Partial) => void; + afterDraw: (cb: (l: this) => void) => void; + resize: (w: number, h: number) => void; + resizeView: (w: number, h: number) => void; + setDpr: (dpr: number) => void; + getNativeHandler: () => ILayerHandlerContribution; + combineSubLayer: (removeIncrementalKey?: boolean) => void; + startAnimate: (t: number) => void; + setToFrame: (t: number) => void; + prepare: (dirtyBounds: IBounds, params: ILayerHandlerDrawParams) => void; + drawTo: (target: IWindow, params: IDrawToParams) => void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## ICustomPath2D + +来源：`@visactor/vrender-core/es/interface/path.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface ICustomPath2D extends ICurvePath, IPath2D, Releaseable { + commandList: CommandType[]; + toString: () => string; + transform: (x: number, y: number, sx: number, sy: number) => void; + fromString: (pathStr: string, x?: number, y?: number, sX?: number, sY?: number) => ICustomPath2D; + fromCustomPath2D: (path: ICustomPath2D, x?: number, y?: number, sX?: number, sY?: number) => ICustomPath2D; + addCurve: (curve: ICurve) => void; + getYAt: (x: number) => number; + clear: () => void; + drawWithClipRange: (ctx: IPath2D, size: number, x: number, y: number, clipRange: number) => void; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IOption3D + +来源：`@visactor/vrender-core/es/interface/stage.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IOption3D { + enableView3dTransform?: boolean; + alpha?: number; + beta?: number; + gama?: number; + center?: { + x?: number; + y?: number; + z?: number; + dx?: number; + dy?: number; + dz?: number; + }; + fieldRatio?: number; + fieldDepth?: number; + light?: { + dir?: vec3; + color?: string; + ambient?: number; + }; + camera?: any; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IStage + +来源：`@visactor/vrender-core/es/interface/stage.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IStage extends INode { + stage?: IStage; + parent: IStage | null; + x: number; + y: number; + params: Partial; + window: IWindow; + width: number; + height: number; + viewWidth: number; + viewHeight: number; + defaultLayer: ILayer; + dirtyBounds: IBounds | null; + autoRender: boolean; + renderCount: number; + hooks: { + beforeRender: ISyncHook<[IStage]>; + afterRender: ISyncHook<[IStage]>; + afterClearScreen: ISyncHook<[IRenderServiceDrawParams]>; + afterClearRect: ISyncHook<[IRenderServiceDrawParams]>; + }; + option3d?: IOption3D; + set3dOptions: (options: IOption3D) => void; + light?: IDirectionLight; + camera?: ICamera; + dpr: number; + viewBox: IBoundsLike; + background: string | IColor; + ticker: ITicker; + increaseAutoRender: boolean; + readonly renderService: IRenderService; + readonly graphicService: IGraphicService; + getPickerService: () => IPickerService; + readonly pluginService: IPluginService; + readonly layerService: ILayerService; + rootSharedStateScope?: SharedStateScope>; + createLayer: (canvasId?: string, layerMode?: LayerMode) => ILayer; + getLayer: (name: string) => ILayer; + sortLayer: (cb: (layer1: ILayer, layer2: ILayer) => number) => void; + removeLayer: (layerId: number) => ILayer | false; + getTimeline: () => ITimeline; + render: (layers?: ILayer[], params?: Partial) => void; + renderNextFrame: (layers?: ILayer[], force?: boolean) => void; + tryInitInteractiveLayer: () => void; + resize: (w: number, h: number, rerender?: boolean) => void; + resizeWindow: (w: number, h: number, rerender?: boolean) => void; + resizeView: (w: number, h: number, rerender?: boolean) => void; + setViewBox: ((viewBox: IBoundsLike, rerender: boolean) => void) | ((x: number, y: number, w: number, h: number, rerender: boolean) => void) | ((x: number | IBoundsLike, y: number | boolean, w?: number, h?: number, rerender?: boolean) => void); + setDpr: (dpr: number, rerender?: boolean) => void; + setOrigin: (x: number, y: number) => void; + export: (type: IExportType) => HTMLCanvasElement | ImageData; + pick: (x: number, y: number) => PickResult | false; + startAnimate: (t: number) => void; + setToFrame: (t: number) => void; + dirty: (b: IBounds, matrix?: IMatrix) => void; + renderTo: (window: IWindow, params: { + x: number; + y: number; + width: number; + height: number; + }) => void; + renderToNewWindow: (fullImage?: boolean) => IWindow; + toCanvas: (fullImage?: boolean, viewBox?: IAABBBounds) => HTMLCanvasElement | null; + setBeforeRender: (cb: (stage: IStage) => void) => void; + removeBeforeRender: (cb: (stage: IStage) => void) => void; + setAfterRender: (cb: (stage: IStage) => void) => void; + removeAfterRender: (cb: (stage: IStage) => void) => void; + afterNextRender: (cb: (stage: IStage) => void) => void; + enableAutoRender: () => void; + disableAutoRender: () => void; + enableIncrementalAutoRender: () => void; + disableIncrementalAutoRender: () => void; + enableDirtyBounds: () => void; + disableDirtyBounds: () => void; + enableView3dTransform: () => void; + disableView3dTranform: () => void; + getPluginsByName: (name: string) => IPlugin[]; + clearViewBox: (color?: string) => void; + release: () => void; + setStage: (stage?: IStage) => void; + pauseRender: (sk?: number) => void; + resumeRender: () => void; + setCursor: (mode?: string) => void; + getTheme: () => IFullThemeSpec; + eventPointTransform: (e: PointerEvent | WheelEvent | TouchEvent) => { + x: number; + y: number; + }; + pauseTriggerEvent: () => void; + resumeTriggerEvent: () => void; + pauseAnimation?: (deep?: boolean) => void; + resumeAnimation?: (deep?: boolean) => void; + stopAnimation?: (deep?: boolean) => void; + reApplyAnimationState?: (state: string, deep?: boolean) => this; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IStageParams + +来源：`@visactor/vrender-core/es/interface/stage.d.ts`，@visactor/vrender-core@1.1.12 + +```typescript +export interface IStageParams { + viewBox: IBoundsLike; + width: number; + height: number; + dpr: number; + background: string | IColor; + canvas: string | HTMLCanvasElement; + container: string | HTMLElement; + canvasControled: boolean; + title: string; + autoRender: boolean; + autoRefresh: boolean; + enableLayout: boolean; + disableDirtyBounds: boolean; + interactiveLayer: boolean; + enableHtmlAttribute: string | boolean | HTMLElement; + ReactDOM: any; + enableScroll: boolean; + poptip: boolean; + beforeRender: (stage: IStage) => void; + afterRender: (stage: IStage) => void; + afterClearScreen: (drawParams: any) => void; + afterClearRect: (drawParams: any) => void; + renderStyle?: string; + ticker?: ITicker; + pluginList?: string[]; + optimize?: IOptimizeType; + event?: EventConfig; + supportsTouchEvents?: boolean; + supportsPointerEvents?: boolean; + context?: IStageCreateContext; + rafId?: number; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## CustomTicksFunc + +来源：`@visactor/vscale/es/interface.d.ts`，@visactor/vscale@1.0.28 + +```typescript +export type CustomTicksFunc = (scale: T, count: number) => number[]; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IBaseScale + +来源：`@visactor/vscale/es/interface.d.ts`，@visactor/vscale@1.0.28 + +```typescript +export interface IBaseScale { + readonly type: string; + unknown: (_?: any) => this | any; + scale: (x: any) => any; + domain: (_?: any[], slience?: boolean) => this | any; + range: (_?: any[], slience?: boolean) => this | any; + invert?: (y: any) => any; + clone?: () => IBaseScale; + rescale?: (slience?: boolean) => this; + tickData?: (count?: number) => TickData[]; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IContinuousScale + +来源：`@visactor/vscale/es/interface.d.ts`，@visactor/vscale@1.0.28 + +```typescript +export interface IContinuousScale extends IBaseScale, IRangeFactor { + readonly type: ContinuousScaleType; + invert: (y: number) => any; + rangeRound: (_: any[], slience?: boolean) => this; + clamp: (_?: boolean, f?: (x: number) => number, slience?: boolean) => this | boolean; + interpolate: (_?: InterpolateType, slience?: boolean) => this | InterpolateType; + clone?: () => IContinuousScale; + rescale: () => this; + fishEye: (options?: ScaleFishEyeOptions, slience?: boolean, clear?: boolean) => this | ScaleFishEyeOptions; +} +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IBoundsLike + +来源：`@visactor/vutils/es/data-structure/bounds.d.ts`，@visactor/vutils@1.0.28 + +```typescript +export type IBoundsLike = Pick; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IPointLike + +来源：`@visactor/vutils/es/data-structure/point.d.ts`，@visactor/vutils@1.0.28 + +```typescript +export type IPointLike = Pick; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IPadding + +来源：`@visactor/vutils/es/padding.d.ts`，@visactor/vutils@1.0.28 + +```typescript +export type IPadding = { + top?: number; + bottom?: number; + left?: number; + right?: number; +}; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## Maybe + +来源：`@visactor/vutils/es/type.d.ts`，@visactor/vutils@1.0.28 + +```typescript +export type Maybe = T | null | undefined; +``` + +这是对应包版本的直接声明摘录；嵌套外部类型未递归复制，按该版本包契约查询。常用图表属性优先参考已有组件/图元说明。 + + +## IBar3dSeriesSpec + +来源：`packages/vchart-extension/src/charts/bar-3d/interface.ts`，VChart 2.1.7 + +```typescript +export type IBar3dSeriesSpec = { + type: 'bar3d'; +} & Omit & + ICartesianSeriesSpec & + IAnimationSpec<'bar', BarAppearPreset>; +``` + +相关定义：[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa)、[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[BarAppearPreset](AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc) + + +## IPictogramSeriesSpec + +来源：`packages/vchart-extension/src/charts/pictogram/series/interface.ts`，VChart 2.1.7 + +```typescript +export interface IPictogramSeriesSpec extends ISeriesSpec, IAnimationSpec<'pictogram', 'fadeIn'> { + /** + * 系列类型 + */ + type: 'pictogram'; + /** + * svg 数据源 + */ + svg: string; + /** + * 名称维度 + */ + nameField?: string; + /** + * 值维度 + */ + valueField?: string; + /** + * 图元配置 + */ + pictogram?: IMarkSpec>; + + /** 默认填充颜色 */ + defaultFillColor?: string; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md) + + +## IRangeColumn3dSeriesSpec + +来源：`packages/vchart-extension/src/charts/range-column-3d/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRangeColumn3dSeriesSpec extends Omit { + type: 'rangeColumn3d'; +} +``` + +相关定义：[IRangeColumnSeriesSpec](AdditionalTypes-Type-Definition.md#type-71611a6326b0) + + +## IWordCloud3dSeriesSpec + +来源：`packages/vchart-extension/src/charts/word-cloud-3d/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWordCloud3dSeriesSpec extends IWordCloudSeriesBaseSpec { + type: 'wordCloud3d'; + depth_3d?: number; // 词云的半径深度 + postProjection?: 'StereographicProjection'; // 词云投影的算法 +} +``` + +相关定义：[IWordCloudSeriesBaseSpec](AdditionalTypes-Type-Definition.md#type-545e0cd34c67) + + +## ChannelAnimationConfig + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface ChannelAnimationConfig extends CommonAnimationConfigItem { + channel: IAnimationChannelAttrs | string[]; +} +``` + +相关定义：[CommonAnimationConfigItem](AdditionalTypes-Type-Definition.md#type-a27ba00f90e2)、[IAnimationChannelAttrs](AdditionalTypes-Type-Definition.md#type-f40bfaee5af2) + + +## CommonAnimationConfigItem + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface CommonAnimationConfigItem { + custom?: IAnimationChannelInterpolator | IAnimationCustomConstructor; + customParameters?: GraphicFunctionValueType; + + easing?: EasingType; + duration?: GraphicFunctionValueType; + delay?: GraphicFunctionValueType; + delayAfter?: GraphicFunctionValueType; + oneByOne?: GraphicFunctionValueType; + startTime?: GraphicFunctionValueType; + totalTime?: GraphicFunctionValueType; + /** loop: true 无限循环; loop: 正整数，表示循环的次数 */ + loop?: boolean | number; + /** 动画 effect 配置项 */ + options?: GraphicFunctionValueType; + /** 动画执行相关控制配置项 */ + controlOptions?: IAnimationControlOptions; + /** 该动画是否需要忽略子图元 */ + selfOnly?: boolean; +} +``` + +相关定义：[IAnimationChannelInterpolator](AdditionalTypes-Type-Definition.md#type-cbb1bcb4a54c)、[IAnimationCustomConstructor](AdditionalTypes-Type-Definition.md#type-be178b30c81f)、[GraphicFunctionValueType](AdditionalTypes-Type-Definition.md#type-2dfb509d67d0)、[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1)、[IAnimationControlOptions](AdditionalTypes-Type-Definition.md#type-727cdb8dd287) + + +## GraphicFunctionCallback + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type GraphicFunctionCallback = (datum: any, g: IGraphic, params: any) => T; +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3) + + +## GraphicFunctionValueType + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type GraphicFunctionValueType = GraphicFunctionCallback | T; +``` + +相关定义：[GraphicFunctionCallback](AdditionalTypes-Type-Definition.md#type-2d4e66b882cd) + + +## IAnimationChannelAttrs + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type IAnimationChannelAttrs = Record< + string, + { + from?: any | IAnimationChannelFunction; + to?: any | IAnimationChannelFunction; + } +>; +``` + +相关定义：[IAnimationChannelFunction](AdditionalTypes-Type-Definition.md#type-253d0d6a48ba) + + +## IAnimationChannelFunction + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type IAnimationChannelFunction = (datum: any, g: IGraphic, mark: IMark) => any; +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf) + + +## IAnimationChannelInterpolator + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type IAnimationChannelInterpolator = ( + ratio: number, + from: any, + to: any, + nextAttributes: any, + datum: any, + g: IGraphic, + parameters: IAnimationParameters +) => boolean | void; +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IAnimationParameters](AdditionalTypes-Type-Definition.md#type-3fc135bb4f43) + + +## IAnimationControlOptions + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationControlOptions { + /** 当动画状态变更时清空动画 */ + stopWhenStateChange?: boolean; + /** 是否立即应用动画初始状态 */ + immediatelyApply?: boolean; + /** encode 计算图元最终状态时是否忽略循环动画 */ + ignoreLoopFinalAttributes?: boolean; +} +``` + + +## IAnimationCustomConstructor + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationCustomConstructor { + new (from: any, to: any, duration: number, ease: EasingType, parameters?: any): ACustomAnimate; +} +``` + +相关定义：[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1)、[ACustomAnimate](AdditionalTypes-Type-Definition.md#type-f85debfe2020) + + +## IAnimationEffect + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type IAnimationEffect = { + type?: string; + channel?: IAnimationChannelAttrs | string[]; + custom?: IAnimationChannelInterpolator | IAnimationCustomConstructor; + customParameters?: GraphicFunctionValueType; + easing?: EasingType; + options?: GraphicFunctionValueType; +}; +``` + +相关定义：[IAnimationChannelAttrs](AdditionalTypes-Type-Definition.md#type-f40bfaee5af2)、[IAnimationChannelInterpolator](AdditionalTypes-Type-Definition.md#type-cbb1bcb4a54c)、[IAnimationCustomConstructor](AdditionalTypes-Type-Definition.md#type-be178b30c81f)、[GraphicFunctionValueType](AdditionalTypes-Type-Definition.md#type-2dfb509d67d0)、[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1) + + +## IAnimationParameters + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationParameters { + width: number; + height: number; + mark: IMark; + group: IMark | null; + elementIndex: number; + elementCount: number; + view: any; +} +``` + +相关定义：[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf) + + +## IAnimationTimeline + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationTimeline { + /** 为了方便动画编排，用户可以设置 id 用于识别时间线 */ + id?: string; + /** 时间切片 */ + timeSlices: IAnimationTimeSlice | IAnimationTimeSlice[]; + /** 动画开始的相对时间，可以为负数 */ + startTime?: GraphicFunctionValueType; + /** 动画时长 */ + totalTime?: GraphicFunctionValueType; + /** 动画依次执行的延迟 */ + oneByOne?: GraphicFunctionValueType; + /** loop: true 无限循环; loop: 正整数，表示循环的次数 */ + loop?: GraphicFunctionValueType; + /** 对图元元素进行划分，和过滤类似，但是不同时间线不能同时作用在相同的元素上 */ + partitioner?: GraphicFunctionCallback; + /** 对同一时间线上的元素进行排序 */ + sort?: (datumA: any, datumB: any, graphicA: IGraphic, graphicB: IGraphic) => number; + /** 动画执行相关控制配置项 */ + controlOptions?: IAnimationControlOptions; +} +``` + +相关定义：[IAnimationTimeSlice](AdditionalTypes-Type-Definition.md#type-1e49bff211ba)、[GraphicFunctionValueType](AdditionalTypes-Type-Definition.md#type-2dfb509d67d0)、[GraphicFunctionCallback](AdditionalTypes-Type-Definition.md#type-2d4e66b882cd)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IAnimationControlOptions](AdditionalTypes-Type-Definition.md#type-727cdb8dd287) + + +## IAnimationTimeSlice + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationTimeSlice { + effects: IAnimationEffect | IAnimationEffect[]; + duration?: GraphicFunctionValueType; + delay?: GraphicFunctionValueType; + delayAfter?: GraphicFunctionValueType; +} +``` + +相关定义：[IAnimationEffect](AdditionalTypes-Type-Definition.md#type-2dd72221397d)、[GraphicFunctionValueType](AdditionalTypes-Type-Definition.md#type-2dfb509d67d0) + + +## IStageAnimationCallback + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type IStageAnimationCallback = (stage: IStage, canvas: HTMLCanvasElement, ratio: number, time: number) => void; +``` + +相关定义：[IStage](AdditionalTypes-Type-Definition.md#type-454a11518dd1) + + +## IStateAnimationConfig + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface IStateAnimationConfig { + /** + * 状态动画的动画时长 + */ + duration?: number; + /** + * 状态动画的缓动函数类型 + */ + easing?: EasingType; +} +``` + +相关定义：[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1) + + +## MarkAnimationSpec + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface MarkAnimationSpec { + disappear?: IAnimationConfig & { + callBack?: IStageAnimationCallback | AStageAnimate; + }; + appear?: IAnimationConfig | IAnimationConfig[]; + enter?: IAnimationConfig | IAnimationConfig[]; + exit?: IAnimationConfig | IAnimationConfig[]; + update?: IAnimationConfig | IAnimationConfig[]; + normal?: IAnimationConfig | IAnimationConfig[]; + state?: IStateAnimationConfig; +} +``` + +相关定义：[IAnimationConfig](IAnimationConfig-Type-Definition.md)、[IStageAnimationCallback](AdditionalTypes-Type-Definition.md#type-3e0ce9607473)、[AStageAnimate](AdditionalTypes-Type-Definition.md#type-c0172addd0a4)、[IStateAnimationConfig](AdditionalTypes-Type-Definition.md#type-e4cf848bb846) + + +## TypeAnimationConfig + +来源：`packages/vchart/src/animation/interface.ts`，VChart 2.1.7 + +```typescript +export interface TypeAnimationConfig extends CommonAnimationConfigItem { + type: string; +} +``` + +相关定义：[CommonAnimationConfigItem](AdditionalTypes-Type-Definition.md#type-a27ba00f90e2) + + +## IAnimationSpec + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface IAnimationSpec { + /** + * 图表入场动画 + * 支持配置图表内置不同动画效果 + */ + animationAppear?: boolean | IStateAnimateSpec | IMarkAnimateSpec; + /** + * 数据更新 - 新增数据动画 + */ + animationEnter?: boolean | ICommonStateAnimateSpec | IMarkAnimateSpec; + /** + * 数据更新 - 数据更新动画 + */ + animationUpdate?: boolean | ICommonStateAnimateSpec | IMarkAnimateSpec; + /** + * 数据更新 - 数据删除动画 + */ + animationExit?: boolean | ICommonStateAnimateSpec | IMarkAnimateSpec; + /** + * 图表退场动画 + */ + animationDisappear?: boolean | ICommonStateAnimateSpec | IMarkAnimateSpec; + /** + * 状态切换动画 + * @since 1.12.0 + */ + animationState?: boolean | IStateAnimationConfig; + /** + * 循环动画 + */ + animationNormal?: IMarkAnimateSpec; +} +``` + +相关定义：[IStateAnimateSpec](AdditionalTypes-Type-Definition.md#type-c689f8784df3)、[IMarkAnimateSpec](AdditionalTypes-Type-Definition.md#type-f077d8f2c125)、[ICommonStateAnimateSpec](AdditionalTypes-Type-Definition.md#type-874c3b173f64)、[IStateAnimationConfig](AdditionalTypes-Type-Definition.md#type-e4cf848bb846) + + +## ICommonStateAnimateSpec + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface ICommonStateAnimateSpec { + /** + * 图表动画时长 + */ + duration?: number; + /** + * 动画延迟开始的时长 + */ + delay?: number; + /** + * 动画缓动效果 + */ + easing?: EasingType; + /** + * 是否轮流执行 + */ + oneByOne?: boolean; +} +``` + +相关定义：[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1) + + +## IMarkAnimateSpec + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkAnimateSpec = Partial< + Record +>; +``` + +相关定义：[IAnimationConfig](IAnimationConfig-Type-Definition.md) + + +## IMorphAnimationConfig + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMorphAnimationConfig { + easing?: EasingType; + delay?: MorphFunctionValueType; + duration?: MorphFunctionValueType; + oneByOne?: MorphFunctionValueType; + splitPath?: MorphFunctionValueType<'clone' | null | undefined>; +} +``` + +相关定义：[EasingType](AdditionalTypes-Type-Definition.md#type-6efe56d777d1)、[MorphFunctionValueType](AdditionalTypes-Type-Definition.md#type-e0d294fdac38) + + +## IMorphConfig + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMorphConfig { + /** whether enable reusing of grammar */ + reuse?: boolean; + /** whether enable morph */ + morph?: boolean; + /** force all marks to participate in morphing */ + morphAll?: boolean; + /** morphing animation config */ + animation?: IMorphAnimationConfig; + /** whether apply exit animations for released marks */ + enableExitAnimation?: boolean; +} +``` + +相关定义：[IMorphAnimationConfig](AdditionalTypes-Type-Definition.md#type-6fbb2d1cab32) + + +## IMorphSeriesSpec + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMorphSeriesSpec { + /** + * 系列全局动画是否开启 + * @default true + */ + enable?: boolean; + /** + * 图元匹配字段 + * 系列前后根据 morphKey 配置的内容进行关联 + */ + morphKey?: string; + /** + * 数据匹配字段 + * 多数据图元可配置 + */ + morphElementKey?: string; +} +``` + + +## IStateAnimateSpec + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export interface IStateAnimateSpec extends ICommonStateAnimateSpec { + /** + * 预设动画效果 + */ + preset?: Preset | false; +} +``` + +相关定义：[ICommonStateAnimateSpec](AdditionalTypes-Type-Definition.md#type-874c3b173f64) + + +## MorphData + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type MorphData = { prev: any[]; next: any[] }; +``` + + +## MorphElements + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type MorphElements = { prev: IGraphic[]; next: IGraphic[] }; +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3) + + +## MorphFunctionCallback + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type MorphFunctionCallback = (datum: MorphData, element: MorphElements, parameters: any) => T; +``` + +相关定义：[MorphData](AdditionalTypes-Type-Definition.md#type-e6ed6ba04d57)、[MorphElements](AdditionalTypes-Type-Definition.md#type-3a62a6f9f35a) + + +## MorphFunctionType + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type MorphFunctionType = T | MorphFunctionCallback; +``` + +相关定义：[MorphFunctionCallback](AdditionalTypes-Type-Definition.md#type-2d18666b391c) + + +## MorphFunctionValueType + +来源：`packages/vchart/src/animation/spec.ts`，VChart 2.1.7 + +```typescript +export type MorphFunctionValueType = MorphFunctionType | T; +``` + +相关定义：[MorphFunctionType](AdditionalTypes-Type-Definition.md#type-953fe2a09d7a) + + +## IAreaChartSpec + +来源：`packages/vchart/src/chart/area/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAreaChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'area'; + /** 系列配置 */ + series?: IAreaSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IAreaSeriesSpec](AdditionalTypes-Type-Definition.md#type-3c1aa405c767) + + +## IBarChartSpec + +来源：`packages/vchart/src/chart/bar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBarChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'bar'; + /** 系列配置 */ + series?: IBarSeriesSpec[]; + /** + * 是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度 + * @since 1.10.0 + */ + autoBandSize?: + | boolean + | { + /** 设置 bandSize 的在自动计算结果基础上的扩增值，单位为 px */ + extend: number; + }; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa) + + +## IBoxPlotChartSpec + +来源：`packages/vchart/src/chart/box-plot/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBoxPlotChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'boxPlot'; + /** 系列配置 */ + series?: IBoxPlotSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IBoxPlotSeriesSpec](AdditionalTypes-Type-Definition.md#type-4f696616234f) + + +## ICartesianChartSpec + +来源：`packages/vchart/src/chart/cartesian/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICartesianChartSpec extends IChartSpec { + /** + * 图表的方向配置。 + * - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 + * - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。 + */ + direction?: DirectionType; + /** + * 笛卡尔坐标系的坐标轴配置 + */ + axes?: ICartesianAxisSpec[]; + /** + * 十字辅助线配置 + */ + crosshair?: ICartesianCrosshairSpec | ICartesianCrosshairSpec[]; + /** + * 参考线配置 + */ + markLine?: IMarkLineSpec | IMarkLineSpec[]; + /** + * 参考区域配置 + */ + markArea?: IMarkAreaSpec | IMarkAreaSpec[]; + /** + * 参考点配置 + */ + markPoint?: IMarkPointSpec | IMarkPointSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9)、[ICartesianAxisSpec](ICartesianAxisSpec-Type-Definition.md)、[ICartesianCrosshairSpec](ICartesianCrosshairSpec-Type-Definition.md)、[IMarkLineSpec](IMarkLineSpec-Type-Definition.md)、[IMarkAreaSpec](IMarkAreaSpec-Type-Definition.md)、[IMarkPointSpec](IMarkPointSpec-Type-Definition.md) + + +## ICirclePackingChartSpec + +来源：`packages/vchart/src/chart/circle-packing/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICirclePackingChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'circlePacking'; + series?: ICirclePackingSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ICirclePackingSeriesSpec](AdditionalTypes-Type-Definition.md#type-bbcfdbd7ab2b) + + +## ICommonChartSpec + +来源：`packages/vchart/src/chart/common/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICommonChartSpec extends Omit { + type: 'common'; + /** + * 分组字段 + */ + seriesField?: string; + series?: ( + | IAreaSeriesSpec + | ILineSeriesSpec + | IBarSeriesSpec + | IRangeColumnChartSpec + | IRangeAreaChartSpec + | IMapSeriesSpec + | IPieSeriesSpec + | IRadarSeriesSpec + | IRoseSeriesSpec + | IScatterSeriesSpec + | ICircularProgressSeriesSpec + | ILinearProgressSeriesSpec + | IWordCloudSeriesSpec + | IFunnelSeriesSpec + | IBoxPlotSeriesSpec + | IGaugeSeriesSpec + | ISankeySeriesSpec + | ITreemapSeriesSpec + | ISunburstSeriesSpec + | ICirclePackingSeriesSpec + | IWaterfallSeriesSpec + | IHeatmapSeriesSpec + | IGaugePointerSeriesSpec + | ICorrelationSeriesSpec + )[]; + /** + * 坐标轴配置 + */ + axes?: ICartesianAxisSpec[] | IPolarAxisSpec[]; + /** + * 十字辅助线配置 + */ + crosshair?: ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | IPolarCrosshairSpec | IPolarCrosshairSpec[]; + /** + * **仅适用于笛卡尔坐标系**，参考线配置 + */ + markLine?: IMarkLineSpec | IMarkLineSpec[]; + /** + * **仅适用于笛卡尔坐标系**，参考区域配置 + */ + markArea?: IMarkAreaSpec | IMarkAreaSpec[]; + /** + * **仅适用于笛卡尔坐标系**，参考点配置 + */ + markPoint?: IMarkPointSpec | IMarkPointSpec[]; + + /** + * 是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度 + * @since 1.11.2 + */ + autoBandSize?: + | boolean + | { + /** 设置 bandSize 的在自动计算结果基础上的扩增值，单位为 px */ + extend: number; + }; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IAreaSeriesSpec](AdditionalTypes-Type-Definition.md#type-3c1aa405c767)、[ILineSeriesSpec](AdditionalTypes-Type-Definition.md#type-c14fbe0b660f)、[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa)、[IRangeColumnChartSpec](AdditionalTypes-Type-Definition.md#type-da04864ad35f)、[IRangeAreaChartSpec](AdditionalTypes-Type-Definition.md#type-3a7b7d9563aa)、[IMapSeriesSpec](AdditionalTypes-Type-Definition.md#type-f28afaaaf021)、[IPieSeriesSpec](AdditionalTypes-Type-Definition.md#type-71acefc8c120)、[IRadarSeriesSpec](AdditionalTypes-Type-Definition.md#type-702f2f2e90b8)、[IRoseSeriesSpec](AdditionalTypes-Type-Definition.md#type-50a9d844112a)、[IScatterSeriesSpec](AdditionalTypes-Type-Definition.md#type-08a7bd218e9e)、[ICircularProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-30261f5b0d11)、[ILinearProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-a272f43e66ef)、[IWordCloudSeriesSpec](AdditionalTypes-Type-Definition.md#type-472dc2c97d50)、[IFunnelSeriesSpec](AdditionalTypes-Type-Definition.md#type-0291e38eb55c)、[IBoxPlotSeriesSpec](AdditionalTypes-Type-Definition.md#type-4f696616234f)、[IGaugeSeriesSpec](AdditionalTypes-Type-Definition.md#type-dfd9dde34e4c)、[ISankeySeriesSpec](AdditionalTypes-Type-Definition.md#type-73ad288a6b3a)、[ITreemapSeriesSpec](AdditionalTypes-Type-Definition.md#type-6cdfbc0c0174)、[ISunburstSeriesSpec](AdditionalTypes-Type-Definition.md#type-42998a239bf0)、[ICirclePackingSeriesSpec](AdditionalTypes-Type-Definition.md#type-bbcfdbd7ab2b)、[IWaterfallSeriesSpec](AdditionalTypes-Type-Definition.md#type-312af991e7a8)、[IHeatmapSeriesSpec](AdditionalTypes-Type-Definition.md#type-6600af61a1ec)、[IGaugePointerSeriesSpec](AdditionalTypes-Type-Definition.md#type-9fdd71c680f3)、[ICorrelationSeriesSpec](AdditionalTypes-Type-Definition.md#type-129af10992bf)、[ICartesianAxisSpec](ICartesianAxisSpec-Type-Definition.md)、[IPolarAxisSpec](IPolarAxisSpec-Type-Definition.md)、[ICartesianCrosshairSpec](ICartesianCrosshairSpec-Type-Definition.md)、[IPolarCrosshairSpec](IPolarCrosshairSpec-Type-Definition.md)、[IMarkLineSpec](IMarkLineSpec-Type-Definition.md)、[IMarkAreaSpec](IMarkAreaSpec-Type-Definition.md)、[IMarkPointSpec](IMarkPointSpec-Type-Definition.md) + + +## ICorrelationChartSpec + +来源：`packages/vchart/src/chart/correlation/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICorrelationChartSpec + extends Omit, + IChartExtendsSeriesSpec { + type: 'correlation'; + series?: ICorrelationSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ICorrelationSeriesSpec](AdditionalTypes-Type-Definition.md#type-129af10992bf) + + +## IFunnelChartSpec + +来源：`packages/vchart/src/chart/funnel/interface.ts`，VChart 2.1.7 + +```typescript +export interface IFunnelChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'funnel'; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IFunnelSeriesSpec](AdditionalTypes-Type-Definition.md#type-0291e38eb55c) + + +## IGaugeChartSpec + +来源：`packages/vchart/src/chart/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGaugeChartSpec + extends Omit, + Omit { + type: 'gauge'; + + /** 表盘背景，可选择 gauge 系列或 circularProgress 系列的配置 */ + gauge?: Omit | Omit; + + /** 轴配置 */ + axes?: (IPolarAxisSpec | ILinearAxisSpec)[]; +} +``` + +相关定义：[IPolarChartSpec](AdditionalTypes-Type-Definition.md#type-47227db96ff6)、[IGaugePointerSeriesSpec](AdditionalTypes-Type-Definition.md#type-9fdd71c680f3)、[IGaugeSeriesSpec](AdditionalTypes-Type-Definition.md#type-dfd9dde34e4c)、[ICircularProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-30261f5b0d11)、[IPolarAxisSpec](IPolarAxisSpec-Type-Definition.md)、[ILinearAxisSpec](ILinearAxisSpec-Type-Definition.md) + + +## IHeatmapChartSpec + +来源：`packages/vchart/src/chart/heatmap/interface.ts`，VChart 2.1.7 + +```typescript +export interface IHeatmapChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'heatmap'; + /** 系列配置 */ + series?: IHeatmapSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IHeatmapSeriesSpec](AdditionalTypes-Type-Definition.md#type-6600af61a1ec) + + +## IHistogramChartSpec + +来源：`packages/vchart/src/chart/histogram/interface.ts`，VChart 2.1.7 + +```typescript +export interface IHistogramChartSpec + extends ICartesianChartSpec, + Omit, 'type'> { + type: 'histogram'; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa) + + +## DimensionIndexOption + +来源：`packages/vchart/src/chart/interface/chart.ts`，VChart 2.1.7 + +```typescript +export type DimensionIndexOption = { + filter?: (cmp: IComponent) => boolean; + tooltip?: boolean; + showTooltipOption?: IShowTooltipOption; + crosshair?: boolean; +}; +``` + +相关定义：[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[IShowTooltipOption](AdditionalTypes-Type-Definition.md#type-b4df769a6b46) + + +## IChart + +来源：`packages/vchart/src/chart/interface/chart.ts`，VChart 2.1.7 + +```typescript +export interface IChart extends ICompilable { + padding: IPadding; + + readonly type: string; + readonly chartData: IChartData; + readonly transformerConstructor: new (option: IChartSpecTransformerOption) => IChartSpecTransformer; + + getSpec: () => any; + setSpec: (s: any) => void; + + // data flow + reDataFlow: () => void; + + setCanvasRect: (width: number, height: number) => void; + getCanvasRect: () => ILayoutRect; + getViewRect: () => ILayoutRect; + + getOption: () => IChartOption; + + getModelOption: () => IModelOption; + /** + * 图表更新的时候按需调用 + * @since 1.11.0 + */ + + /** event */ + getEvent: () => IEvent; + + /** + * @since 1.10.4 + */ + getGlobalScale: () => IGlobalScale; + + /** layout */ + setLayout: (layout: LayoutCallBack) => void; + layout: () => void; + getLayoutTag: () => boolean; + setLayoutTag: (tag: boolean, morphConfig?: IMorphConfig, renderNextTick?: boolean) => boolean; + resetLayoutItemTag: () => void; + + // 使用parse前的原始数据结构更新数据 + updateData: (id: StringOrNumber, data: unknown, updateGlobalScale?: boolean, options?: IParserOptions) => void; + // 使用 IData 更新数据 + updateFullData: (data: IDataValues | IDataValues[]) => void; + // update scale domain which in GlobalScale + updateGlobalScaleDomain: () => void; + //生命周期 + created: (transformer: Maybe) => void; + init: () => void; + onLayoutStart: (ctx: IChartLayoutOption) => void; + onLayoutEnd: (ctx: IChartLayoutOption) => void; + onEvaluateEnd: (ctx: IChartEvaluateOption) => void; + onResize: (width: number, height: number, reRender: boolean) => void; + onLayout: () => void; + onBeforeRender: () => void; + + /** + * 图表更新的时候按需调用 + * @since 1.11.0 + */ + reInit: () => void; + + // series + getAllSeries: () => ISeries[]; + + // region + getRegionsInIndex: (index?: number[]) => IRegion[]; + getRegionsInIds: (ids: number[]) => IRegion[]; + getAllRegions: () => IRegion[]; + getRegionsInUserIdOrIndex: (user_ids?: StringOrNumber[], index?: number[]) => IRegion[]; + getRegionsInQuerier: (query: MaybeArray) => IRegion[]; + + // series + getSeriesInIndex: (index?: number[]) => ISeries[]; + getSeriesInIds: (ids?: number[]) => ISeries[]; + getSeriesInUserIdOrIndex: (user_ids?: StringOrNumber[], index?: number[]) => ISeries[]; + getSeriesInUserId: (userId: StringOrNumber) => ISeries | undefined; + + // component + getComponentByIndex: (key: string, index: number) => IComponent | undefined; + getComponentByUserId: (userId: StringOrNumber) => IComponent | undefined; + getComponentsByKey: (key: string) => IComponent[]; + getComponentsByType: (type: string) => IComponent[]; + getAllComponents: () => IComponent[]; + + // model + getModelById: (id: number) => IModel | undefined; + getModelByUserId: (userId: StringOrNumber) => IModel | undefined; + getModelInFilter: ( + filter: string | { type: string; index: number } | ((model: IModel) => boolean) + ) => IModel | undefined; + getAllModels: () => IModel[]; + + // mark + getMarkById: (id: number) => IMark | undefined; + getAllMarks: () => IMark[]; + getMarkByUserName: (name: string) => IMark[]; + + // spec + updateSpec: (spec: any) => IUpdateSpecResult; + + // state + /** + * 更新或设置图元状态 + * @param state 状态筛选器 + * @param filter 筛选器 + */ + updateState: ( + state: Record, 'style'>>, + filter?: (series: ISeries, mark: IMark, stateKey: string) => boolean //series + mark 筛选 + ) => void; + + /** + * 更新图元选中状态 + * @param datum hover 图元数据 + * @param filter 筛选器 用来筛选系列与mark + * @param region region 筛选器 + */ + setSelected: ( + datum: MaybeArray | null, + filter?: (series: ISeries, mark: IMark) => boolean, + region?: IRegionQuerier + ) => void; + + /** + * 更新图元 hover 状态 + * @param datum hover 图元数据 + * @param filter 筛选器 用来筛选系列与mark + * @param region region 筛选器 + */ + setHovered: ( + datum: MaybeArray | null, + filter?: (series: ISeries, mark: IMark) => boolean, + region?: IRegionQuerier + ) => void; + /** + * 清除所有图元的状态 + * + * @since 1.11.0 + */ + clearState: (state: string) => void; + /** + * 清除所有图元的所有状态 + * + * @since 1.12.4 + */ + clearAllStates: () => void; + /** + * 清除所有图元的选中状态 + * + * @since 1.11.0 + */ + clearSelected: () => void; + /** + * 清除所有图元的hover状态 + * + * @since 1.11.0 + */ + clearHovered: () => void; + + // 更新 viewBox + updateViewBox: (viewBox: IBoundsLike, reLayout: boolean) => void; + + // 获取实际渲染的 canvas + getCanvas: () => HTMLCanvasElement | undefined; + + setCurrentTheme: () => void; + + getSeriesData: (id: StringOrNumber | undefined, index: number | undefined) => DataView | undefined; + // setDimensionIndex + setDimensionIndex: (value: StringOrNumber, opt: DimensionIndexOption) => void; + /** + * 显示交叉线 + * @since 2.0.9 + */ + showCrosshair: (cb: (axis: IAxis) => false | string | number) => void; + + /** + * 根据数据筛选图元 + * @since 1.13.9 + */ + filterGraphicsByDatum: ( + datum: MaybeArray | null, + opt?: { + filter?: (series: ISeries, mark: IMark) => boolean; + region?: IRegionQuerier; + getDatum?: (el: IMarkGraphic, mark: IMark, s: ISeries, r: IRegion) => Datum; + callback?: (el: IMarkGraphic, mark: IMark, s: ISeries, r: IRegion) => void; + regionCallback?: (pickElements: IMarkGraphic[], r: IRegion) => void; + } + ) => IMarkGraphic[]; +} +``` + +相关定义：[ICompilable](AdditionalTypes-Type-Definition.md#type-590d0c32ce42)、[IPadding](AdditionalTypes-Type-Definition.md#type-698f5ded9c9f)、[IChartData](AdditionalTypes-Type-Definition.md#type-b326c4e21951)、[IChartSpecTransformerOption](AdditionalTypes-Type-Definition.md#type-42469e396d0c)、[IChartSpecTransformer](AdditionalTypes-Type-Definition.md#type-664463dc79e8)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IChartOption](AdditionalTypes-Type-Definition.md#type-cb5d64868d2d)、[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[IEvent](AdditionalTypes-Type-Definition.md#type-17583cb7e08d)、[IGlobalScale](AdditionalTypes-Type-Definition.md#type-86e42efb33dd)、[LayoutCallBack](AdditionalTypes-Type-Definition.md#type-0bf7cec9094c)、[IMorphConfig](AdditionalTypes-Type-Definition.md#type-bffef8c15a00)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IParserOptions](AdditionalTypes-Type-Definition.md#type-63f1dbc535e0)、[IDataValues](AdditionalTypes-Type-Definition.md#type-218b08963b1d)、[Maybe](AdditionalTypes-Type-Definition.md#type-0f3d51337f61)、[IChartLayoutOption](AdditionalTypes-Type-Definition.md#type-b3fb7b561e3d)、[IChartEvaluateOption](AdditionalTypes-Type-Definition.md#type-895c62f86a47)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24)、[MaybeArray](AdditionalTypes-Type-Definition.md#type-915c1abd7543)、[IRegionQuerier](AdditionalTypes-Type-Definition.md#type-a826f89dd07b)、[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IUpdateSpecResult](AdditionalTypes-Type-Definition.md#type-646a207a21dd)、[IMarkStateSpec](AdditionalTypes-Type-Definition.md#type-4d46c5681360)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[DimensionIndexOption](AdditionalTypes-Type-Definition.md#type-5b5f8e33e6e1)、[IAxis](AdditionalTypes-Type-Definition.md#type-9cbd2aefe72d)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3) + + +## IChartData + +来源：`packages/vchart/src/chart/interface/chart.ts`，VChart 2.1.7 + +```typescript +export interface IChartData { + parseData: (dataSpec: IData) => void; + updateData: (dataSpec: IData, fullUp?: boolean, forceMerge?: boolean) => boolean; + getSeriesData: (id: StringOrNumber | undefined, index: number | undefined) => DataView | undefined; +} +``` + +相关定义：[IData](IData-Type-Definition.md)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8) + + +## IChartSpecTransformer + +来源：`packages/vchart/src/chart/interface/chart.ts`，VChart 2.1.7 + +```typescript +export interface IChartSpecTransformer { + readonly type: string; + readonly seriesType: string; + + /** 此方法不建议重写 */ + initChartSpec: (spec: any) => IChartSpecInfo; + /** 将图表 spec 统一转换为 common chart spec */ + transformSpec: (spec: any) => void; + /** 转换 model spec，应用主题 */ + transformModelSpec: (spec: any) => IChartSpecInfo; + /** 根据图表 spec 生成 spec info */ + createSpecInfo: ( + chartSpec: any, + transform?: (constructor: IModelConstructor, specInfo: IModelSpecInfo, chartSpecInfo?: IChartSpecInfo) => void + ) => IChartSpecInfo; + getSeriesRelatedSpecKeys: () => Record; + /** 枚举 spec 中每个有效的 region */ + forEachRegionInSpec: ( + spec: any, + callbackfn: (constructor: IRegionConstructor, specInfo: IModelSpecInfo, chartSpecInfo?: IChartSpecInfo) => K, + chartSpecInfo?: IChartSpecInfo + ) => K[]; + /** 枚举 spec 中每个有效的 series */ + forEachSeriesInSpec: ( + spec: any, + callbackfn: (constructor: ISeriesConstructor, specInfo: IModelSpecInfo, chartSpecInfo?: IChartSpecInfo) => K, + chartSpecInfo?: IChartSpecInfo + ) => K[]; + /** 枚举 spec 中每个有效的 component */ + forEachComponentInSpec: ( + spec: any, + callbackfn: (constructor: IComponentConstructor, specInfo: IModelSpecInfo, chartSpecInfo?: IChartSpecInfo) => K, + chartSpecInfo?: IChartSpecInfo + ) => K[]; +} +``` + +相关定义：[IChartSpecInfo](AdditionalTypes-Type-Definition.md#type-618e9dfe06cf)、[IModelConstructor](AdditionalTypes-Type-Definition.md#type-b2886ff503c6)、[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a)、[IRegionConstructor](AdditionalTypes-Type-Definition.md#type-4ab33fce2070)、[ISeriesConstructor](AdditionalTypes-Type-Definition.md#type-4d9d86b6e907)、[IComponentConstructor](AdditionalTypes-Type-Definition.md#type-897b853a0458) + + +## IChartEvaluateOption + +来源：`packages/vchart/src/chart/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartEvaluateOption {} +``` + + +## IChartLayoutOption + +来源：`packages/vchart/src/chart/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartLayoutOption {} +``` + + +## IChartOption + +来源：`packages/vchart/src/chart/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartOption + extends Omit< + IModelOption, + 'getChartViewRect' | 'getChartLayoutRect' | 'globalScale' | 'getChart' | 'getSeriesData' | 'animation' + > { + container: HTMLElement | null; + canvas?: HTMLCanvasElement | OffscreenCanvas | string; + modeParams?: IRenderOption['modeParams']; + + /** + * TODO: 支持百分比 + */ + viewBox?: IBoundsLike; + + /** + * 自定义布局方法 + */ + layout?: LayoutCallBack; + + /** + * 是否关闭交互效果 + */ + disableTriggerEvent?: boolean; + + /** + * 组件内容展示配置 + * @since 2.0.11 + */ + componentShowContent?: { + /** + * tooltip 是否关闭内容展示 + * @default false + */ + tooltip?: boolean | Partial>; + // crosshair 组件是否展示 + crosshair?: boolean; + }; + + /** + * 性能相关的钩子 + */ + performanceHook?: IPerformanceHook; +} +``` + +相关定义：[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[IRenderOption](AdditionalTypes-Type-Definition.md#type-0f4236fc8d55)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[LayoutCallBack](AdditionalTypes-Type-Definition.md#type-0bf7cec9094c)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[IPerformanceHook](AdditionalTypes-Type-Definition.md#type-095e16af33ef) + + +## IChartSpecInfo + +来源：`packages/vchart/src/chart/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartSpecInfo { + region?: IRegionSpecInfo[]; + series?: ISeriesSpecInfo[]; + component?: Record>; +} +``` + +相关定义：[IRegionSpecInfo](AdditionalTypes-Type-Definition.md#type-dacf9d61a878)、[ISeriesSpecInfo](AdditionalTypes-Type-Definition.md#type-94e8317ff02e)、[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a) + + +## IChartSpecTransformerOption + +来源：`packages/vchart/src/chart/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartSpecTransformerOption extends Partial { + seriesType?: string; +} +``` + +相关定义：[IChartOption](AdditionalTypes-Type-Definition.md#type-cb5d64868d2d) + + +## ILineChartSpec + +来源：`packages/vchart/src/chart/line/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILineChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'line'; + /** 系列配置 */ + series?: ILineSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ILineSeriesSpec](AdditionalTypes-Type-Definition.md#type-c14fbe0b660f) + + +## ILiquidChartSpec + +来源：`packages/vchart/src/chart/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILiquidChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'liquid'; + /** 系列配置 */ + series?: ILiquidSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ILiquidSeriesSpec](AdditionalTypes-Type-Definition.md#type-fbf087ad5565) + + +## IMapChartSpec + +来源：`packages/vchart/src/chart/map/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMapChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'map'; + series?: IMapSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IMapSeriesSpec](AdditionalTypes-Type-Definition.md#type-f28afaaaf021) + + +## IPieChartSpec + +来源：`packages/vchart/src/chart/pie/interface.ts`，VChart 2.1.7 + +```typescript +export interface IPieChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'pie'; + /** 饼图指标卡 */ + indicator?: IIndicatorSpec | IIndicatorSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IPieSeriesSpec](AdditionalTypes-Type-Definition.md#type-71acefc8c120)、[IIndicatorSpec](IIndicatorSpec-Type-Definition.md) + + +## IPolarChartSpec + +来源：`packages/vchart/src/chart/polar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IPolarChartSpec extends IChartSpec { + /** + * 极坐标系下坐标轴配置，支持半径轴和角度轴。 + * * `orient: 'angle'` 角度轴 + * * `orient: 'radius'` 半径轴 + */ + axes?: IPolarAxisSpec[]; + /** + * 十字辅助线配置 + */ + crosshair?: IPolarCrosshairSpec | IPolarCrosshairSpec[]; + + /** + * @since 1.11.2 + */ + layoutRadius?: 'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number); + + /** + * 指标卡配置 + */ + indicator?: IIndicatorSpec | IIndicatorSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IPolarAxisSpec](IPolarAxisSpec-Type-Definition.md)、[IPolarCrosshairSpec](IPolarCrosshairSpec-Type-Definition.md)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IPointLike](AdditionalTypes-Type-Definition.md#type-e25b463f6cfe)、[IIndicatorSpec](IIndicatorSpec-Type-Definition.md) + + +## ICircularProgressChartSpec + +来源：`packages/vchart/src/chart/progress/circular/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICircularProgressChartSpec + extends IProgressChartSpec, + IChartExtendsSeriesSpec { + type: 'circularProgress'; + series?: ICircularProgressSeriesSpec[]; +} +``` + +相关定义：[IProgressChartSpec](AdditionalTypes-Type-Definition.md#type-c981df1ddf60)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ICircularProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-30261f5b0d11) + + +## IProgressChartSpec + +来源：`packages/vchart/src/chart/progress/interface.ts`，VChart 2.1.7 + +```typescript +export interface IProgressChartSpec extends IChartSpec { + /** + * 分组字段 + */ + seriesField?: string; + /** + * 进度条圆角半径 + * @default 0 + */ + cornerRadius?: number; + /** 轴配置 */ + axes?: ICartesianAxisSpec[] | IPolarAxisSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[ICartesianAxisSpec](ICartesianAxisSpec-Type-Definition.md)、[IPolarAxisSpec](IPolarAxisSpec-Type-Definition.md) + + +## ILinearProgressChartSpec + +来源：`packages/vchart/src/chart/progress/linear/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILinearProgressChartSpec + extends IProgressChartSpec, + IChartExtendsSeriesSpec { + type: 'linearProgress'; + /** 轴配置 */ + axes?: ICartesianAxisSpec[]; + series?: ILinearProgressSeriesSpec[]; +} +``` + +相关定义：[IProgressChartSpec](AdditionalTypes-Type-Definition.md#type-c981df1ddf60)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ILinearProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-a272f43e66ef)、[ICartesianAxisSpec](ICartesianAxisSpec-Type-Definition.md) + + +## IRadarChartSpec + +来源：`packages/vchart/src/chart/radar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRadarChartSpec extends IPolarChartSpec, IChartExtendsSeriesSpec { + type: 'radar'; + series?: IRadarSeriesSpec[]; +} +``` + +相关定义：[IPolarChartSpec](AdditionalTypes-Type-Definition.md#type-47227db96ff6)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IRadarSeriesSpec](AdditionalTypes-Type-Definition.md#type-702f2f2e90b8) + + +## IRangeAreaChartSpec + +来源：`packages/vchart/src/chart/range-area/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRangeAreaChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + /** 图表类型配置 */ + type: 'rangeArea'; + /** 系列配置 */ + series?: IRangeAreaSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IRangeAreaSeriesSpec](AdditionalTypes-Type-Definition.md#type-777c15c57cb1) + + +## IRangeColumnChartSpec + +来源：`packages/vchart/src/chart/range-column/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRangeColumnChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + /** 图表类型配置 */ + type: 'rangeColumn'; + /** 系列配置 */ + series?: IRangeColumnSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IRangeColumnSeriesSpec](AdditionalTypes-Type-Definition.md#type-71611a6326b0) + + +## IRoseChartSpec + +来源：`packages/vchart/src/chart/rose/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRoseChartSpec extends IPolarChartSpec, IChartExtendsSeriesSpec { + type: 'rose'; + series?: IRoseSeriesSpec[]; +} +``` + +相关定义：[IPolarChartSpec](AdditionalTypes-Type-Definition.md#type-47227db96ff6)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IRoseSeriesSpec](AdditionalTypes-Type-Definition.md#type-50a9d844112a) + + +## ISankeyChartSpec + +来源：`packages/vchart/src/chart/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface ISankeyChartSpec extends Omit, IChartExtendsSeriesSpec { + type: 'sankey'; + series?: ISankeySeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ISankeySeriesSpec](AdditionalTypes-Type-Definition.md#type-73ad288a6b3a) + + +## IScatterChartSpec + +来源：`packages/vchart/src/chart/scatter/interface.ts`，VChart 2.1.7 + +```typescript +export interface IScatterChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'scatter'; + /** 系列配置 */ + series?: IScatterSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IScatterSeriesSpec](AdditionalTypes-Type-Definition.md#type-08a7bd218e9e) + + +## ISunburstChartSpec + +来源：`packages/vchart/src/chart/sunburst/interface.ts`，VChart 2.1.7 + +```typescript +export interface ISunburstChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'sunburst'; + series?: ISunburstSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[ISunburstSeriesSpec](AdditionalTypes-Type-Definition.md#type-42998a239bf0) + + +## ITreemapChartSpec + +来源：`packages/vchart/src/chart/treemap/interface.ts`，VChart 2.1.7 + +```typescript +export interface ITreemapChartSpec extends Omit, Omit { + type: 'treemap'; + series?: ITreemapSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[ITreemapSeriesSpec](AdditionalTypes-Type-Definition.md#type-6cdfbc0c0174) + + +## IWaterfallChartSpec + +来源：`packages/vchart/src/chart/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWaterfallChartSpec extends ICartesianChartSpec, IChartExtendsSeriesSpec { + type: 'waterfall'; + /** 系列配置 */ + series?: IWaterfallSeriesSpec[]; +} +``` + +相关定义：[ICartesianChartSpec](AdditionalTypes-Type-Definition.md#type-0ecf9332a2b4)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IWaterfallSeriesSpec](AdditionalTypes-Type-Definition.md#type-312af991e7a8) + + +## IWordCloudChartSpec + +来源：`packages/vchart/src/chart/word-cloud/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWordCloudChartSpec extends IChartSpec, IChartExtendsSeriesSpec { + type: 'wordCloud'; + series?: IWordCloudSeriesSpec[]; +} +``` + +相关定义：[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IChartExtendsSeriesSpec](AdditionalTypes-Type-Definition.md#type-0d38580aaf51)、[IWordCloudSeriesSpec](AdditionalTypes-Type-Definition.md#type-472dc2c97d50) + + +## ICompilableData + +来源：`packages/vchart/src/compile/data/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICompilableData extends IGrammarItem { + getDataView: () => DataView; + setDataView: (d?: DataView) => void; + + getProduct: () => any; + updateData: (noRender?: boolean) => void; + getLatestData: () => any; + + addRelatedMark: (mark: ICompilableMark) => void; +} +``` + +相关定义：[IGrammarItem](AdditionalTypes-Type-Definition.md#type-96b4a08944c0)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[ICompilableMark](AdditionalTypes-Type-Definition.md#type-fb1ce8327f06) + + +## CompilerListenerParameters + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export type CompilerListenerParameters = { + type: EventType; + event: Event; + source: EventSourceType; + item: IMarkGraphic | null; + datum: any | null; + markId: number | null; + modelId: number | null; + markUserId: StringOrNumber | null; + modelUserId: StringOrNumber | null; +}; +``` + +相关定义：[EventType](AdditionalTypes-Type-Definition.md#type-a71637b330ab)、[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## GrammarItemCompileOption + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export type GrammarItemCompileOption = Record; +``` + + +## ICompilable + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export interface ICompilable { + /** 获取 compile 对象 */ + getCompiler: () => ICompiler; + /** 获取 vgrammar view */ + getStage: () => IStage; + + /** 编译总入口 */ + compile: () => void; + /** 编译所有 mark */ + compileMarks?: (group?: IGroup) => void; + /** 编译所有 data */ + compileData?: () => void; + + /** 清除compile 内容入口 */ + clear?: () => void; + + /** 全部编译完成 lift circle */ + afterCompile?: () => void; + + /** 释放总入口 */ + release: () => void; +} +``` + +相关定义：[ICompiler](AdditionalTypes-Type-Definition.md#type-cbf1a5d7de9b)、[IStage](AdditionalTypes-Type-Definition.md#type-454a11518dd1)、[IGroup](AdditionalTypes-Type-Definition.md#type-8af3ee2f9b73) + + +## ICompilableInitOption + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export interface ICompilableInitOption { + /** 编译对象 应当由外部提供 */ + getCompiler: () => ICompiler; +} +``` + +相关定义：[ICompiler](AdditionalTypes-Type-Definition.md#type-cbf1a5d7de9b) + + +## ICompiler + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export interface ICompiler { + getOption: () => IRenderOption; + isInited?: boolean; + readonly stateAnimationConfig?: MarkAnimationSpec; + getCanvas: () => HTMLCanvasElement | undefined; + getStage: () => IStage | undefined; + compile: (ctx: { chart: IChart; vChart: IVChart }, option?: IVChartRenderOption) => void; + clear: (ctx: { chart: IChart; vChart: IVChart }, removeGraphicItems?: boolean) => void; + renderNextTick: (morphConfig?: IMorphConfig) => void; + render: (morphConfig?: IMorphConfig) => void; + setStageAnimationConfig: (config: Partial) => void; + updateViewBox: (viewBox: IBoundsLike, reRender?: boolean) => void; + resize: (width: number, height: number, reRender?: boolean) => void; + setBackground: (color: IColor) => void; + setSize: (width: number, height: number) => void; + setViewBox: (viewBox: IBoundsLike, reRender?: boolean) => void; + addEventListener: ( + source: EventSourceType, + type: string, + callback: (params: CompilerListenerParameters) => void + ) => void; + removeEventListener: ( + source: EventSourceType, + type: string, + callback: (params: CompilerListenerParameters) => void + ) => void; + release: () => void; + releaseGrammar: (removeGraphicItems: boolean) => void; + // addGrammarItem: (grammarItem: IGrammarItem) => void; + // removeGrammarItem: (grammarItem: IGrammarItem, reserveVGrammarModel?: boolean) => void; + + addRootMark: (mark: IMark) => any; + removeRootMark: (mark: IMark) => any; + getRootMarks: () => IMark[]; + + updateLayoutTag: () => void; + getLayoutState: () => LayoutState; + getRootGroup: () => IGroup; + getChart: () => IChart; +} +``` + +相关定义：[IRenderOption](AdditionalTypes-Type-Definition.md#type-0f4236fc8d55)、[MarkAnimationSpec](AdditionalTypes-Type-Definition.md#type-1cf6d57c137c)、[IStage](AdditionalTypes-Type-Definition.md#type-454a11518dd1)、[IChart](AdditionalTypes-Type-Definition.md#type-d27fa13b0c29)、[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201)、[IVChartRenderOption](AdditionalTypes-Type-Definition.md#type-88e49d0ebe2f)、[IMorphConfig](AdditionalTypes-Type-Definition.md#type-bffef8c15a00)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[IColor](AdditionalTypes-Type-Definition.md#type-a0aea41aa029)、[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d)、[CompilerListenerParameters](AdditionalTypes-Type-Definition.md#type-9760c8c7fdef)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[LayoutState](AdditionalTypes-Type-Definition.md#type-4a8b32cef03c)、[IGroup](AdditionalTypes-Type-Definition.md#type-8af3ee2f9b73) + + +## IGrammarItem + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export interface IGrammarItem extends ICompilable { + id: number; + /** 生成语法元素名称 */ + generateProductId: () => string; + /** 获取语法元素名称 */ + getProductId: () => string; + /** 删除已编译的语法元素 */ + removeProduct: (releaseDetach?: boolean) => void; + // transform + setTransform: (transform: ITransformSpec[]) => void; +} +``` + +相关定义：[ICompilable](AdditionalTypes-Type-Definition.md#type-590d0c32ce42)、[ITransformSpec](AdditionalTypes-Type-Definition.md#type-e91ac41860ff) + + +## ITransformSpec + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export interface ITransformSpec { + type: string; + [key: string]: any; +} +``` + + +## StateValueMap + +来源：`packages/vchart/src/compile/interface/compilable-item.ts`，VChart 2.1.7 + +```typescript +export type StateValueMap = Record; +``` + + +## GestureConfig + +来源：`packages/vchart/src/compile/interface/compiler.ts`，VChart 2.1.7 + +```typescript +export interface GestureConfig { + press?: { + /** + * @default 251 + * Minimal press time in ms. + * @see http://hammerjs.github.io/recognizer-press/ + */ + time?: number; + /** + * @default 10 + * Maximal movement that is allowed while pressing. + * @see http://hammerjs.github.io/recognizer-press/ + */ + threshold?: number; + }; + swipe?: { + /** + * Minimal distance required before recognizing. + * @default 10 + * @see https://hammerjs.github.io/recognizer-swipe/ + */ + threshold?: number; + /** + * Minimal velocity required before recognizing, unit is in px per ms. + * @default 0.3 + * @see http://hammerjs.github.io/recognizer-swipe/ + */ + velocity?: number; + }; + tap?: { + /** + * max time between the multi-tap taps + * @default 300 + */ + interval?: number; + }; +} +``` + + +## IOptimizeType + +来源：`packages/vchart/src/compile/interface/compiler.ts`，VChart 2.1.7 + +```typescript +export type IOptimizeType = { + // 视口不在可视区，跳过渲染，默认为true + skipRenderWithOutRange?: boolean; + // 跳过图元在区间外的判断 + // 不存在dirtyBounds的时候，根据该配置判断是否关闭图元的超出边界判定 + // 如果有dirtyBounds那么该配置不生效 + disableCheckGraphicWidthOutRange?: boolean; +}; +``` + + +## IRenderOption + +来源：`packages/vchart/src/compile/interface/compiler.ts`，VChart 2.1.7 + +```typescript +export interface IRenderOption { + /** + * 配置渲染环境，默认为 'desktop-browser'，当需要在非浏览器环境渲染 VChart 时，需要配置该属性。 + * - 'desktop-browser': 默认模式，适用于 PC 及 H5 + * - 'mobile-browser': H5 模式 + * - 'node': Node 渲染 + * - 'worker': worker 模式 + * - 'miniApp': 小程序模式 + * - 'lynx': lynx 渲染 + * @default 'desktop-browser' + */ + mode?: RenderMode; + + gestureConfig?: GestureConfig; + /** + * 渲染环境参数配置。 + * + * app 级 envParams 只应放对整个 VRender app scope 都有效的环境能力； + * 具体 canvas name/id、width、height、dpr 会随 stage 创建参数传入。 + * Lynx 新接入请优先使用 pixelRatio、lynx/runtime、canvasFactory 等全局能力， + * 不要把 domref/canvasIdLists/freeCanvasIdx 作为新主路径依赖。 + */ + modeParams?: + | { + tooltipCanvasId?: StringOrNumber; + [key: string]: any; + } + | unknown; + + /** + * 是否自动刷线dpr + * @since 1.12.14 + */ + autoRefreshDpr?: boolean; + /** + * 设置屏幕分辨率 + */ + dpr?: number; + /** + * 图表交互全局开关，默认为 `true`，开启。 + * @default true + */ + interactive?: boolean; + /** + * 指定绘制的区域 + */ + viewBox?: IBoundsLike; + /** + * 用于告诉底层的渲染引擎 VRender，图表的 Canvas 是否是受控制的canvas，如果不是的话，不会进行resize等操作。 + * @default true + */ + canvasControled?: boolean; + /** + * 外部传入的 VRender stage。普通用户仍应优先使用 dom/renderCanvas； + * 显式传入 stage 时，stage ownership 属于外部，VChart release 不会释放该 stage。 + */ + stage?: IStage; + /** + * 外部传入的 VRender app。VChart 可使用它创建内部 stage，但 app ownership 属于外部， + * VChart release 只释放自己创建的 stage，不释放该 app。 + */ + app?: IApp; + /** + * 外部传入的 VRender layer + */ + layer?: ILayer; + + /** + * 绘制之前的钩子函数 + */ + beforeRender?: IStageParams['beforeRender']; + /** + * 绘制之后的钩子函数 + */ + afterRender?: IStageParams['afterRender']; + + renderHooks?: { + /** + * 渲染层清除屏幕之后的钩子函数，这个钩子在实际渲染之前 + * @since 2.0.1 + */ + afterClearScreen?: IStageParams['afterClearScreen']; + /** + * 渲染层清除屏幕之后的钩子函数，这个钩子在实际渲染之前 + * @since 2.0.2 + */ + afterClearRect?: IStageParams['afterClearRect']; + /** + * 渲染层钩子 直接透传 + * @since 2.0.2 + */ + [key: string]: any; + }; + /** + * 绘图区域背景色设置 + */ + background?: IColor; + /** + * 日志类型，用于开发调试 + */ + logLevel?: number; + /** + * 错误消息回调函数 + */ + onError?: (...args: any[]) => void; + /** + * 是否关闭dirtyBounds + * @default false + */ + disableDirtyBounds?: boolean; + /** + * 是否开启view3d的变换模式 + */ + enableView3dTransform?: boolean; + /** + * vrender 的插件列表 + */ + pluginList?: string[]; + /** + * stage 创建前需要安装到当前 VRender app 的插件。 + */ + runtimePluginInstallers?: ((app?: IApp) => void)[]; + /** + * vrender 的 ticker + */ + ticker?: ITicker; + /** + * @since 1.8.0 + */ + optimize?: IOptimizeType; + /** + * @since 1.8.3 + */ + enableHtmlAttribute?: boolean; + /** + * @since 1.8.9 + * 是否支持touch事件 + */ + supportsTouchEvents?: boolean; + /** + * @since 1.8.9 + * 是否支持pointer事件 + */ + supportsPointerEvents?: boolean; + /** + * @since 1.11.0 + * 用于vrender渲染react元素，`react-dom`包导出元素 + */ + ReactDOM?: any; + /** + * @since 1.13.2 + * @default 200 + * 单位 ms + * 多次点击之间的最大时间，默认为 200 ms，用于判断点击次数 + */ + clickInterval?: number; + /** + * @since 1.13.2 + * @default false + * VRender 参数 是否自动阻止事件 + */ + autoPreventDefault?: boolean; + /** + * @deprecated + * 请使用 hooks 代替 + */ + performanceHook?: IPerformanceHook; + + /** + * 3d配置 + */ + options3d?: { + enable?: boolean; + /* 是否支持3d视角变换 */ + enableView3dTranform?: boolean; + } & IOption3D; +} +``` + +相关定义：[RenderMode](AdditionalTypes-Type-Definition.md#type-875ef0d8fcf4)、[GestureConfig](AdditionalTypes-Type-Definition.md#type-6ae14ac920fd)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[IStage](AdditionalTypes-Type-Definition.md#type-454a11518dd1)、[IApp](AdditionalTypes-Type-Definition.md#type-d176b9e09694)、[ILayer](AdditionalTypes-Type-Definition.md#type-92d2afdda23a)、[IStageParams](AdditionalTypes-Type-Definition.md#type-681e3d101563)、[IColor](AdditionalTypes-Type-Definition.md#type-a0aea41aa029)、[ITicker](AdditionalTypes-Type-Definition.md#type-619b260e190a)、[IOptimizeType](AdditionalTypes-Type-Definition.md#type-4a85608bd0f1)、[IPerformanceHook](AdditionalTypes-Type-Definition.md#type-095e16af33ef)、[IOption3D](AdditionalTypes-Type-Definition.md#type-f65323c92812) + + +## LayoutState + +来源：`packages/vchart/src/compile/interface/compiler.ts`，VChart 2.1.7 + +```typescript +export enum LayoutState { + before = 'before', + layouting = 'layouting', + reevaluate = 'reevaluate', + after = 'after' +} +``` + + +## ICompilableMark + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICompilableMark extends IGrammarItem { + // 类型 + readonly type: MarkType; + // id + readonly id: number; + // name + readonly name: string; + // key field + readonly key?: string | ((datum: Datum) => string); + // parent model + readonly model: IModel; + + /** + * 上报发生了变更，需要更新 + */ + commit: (render?: boolean, recursion?: boolean) => void; + uncommit: () => void; + isCommited: () => boolean; + + // 数据 可以没有 + getData: () => ICompilableData | undefined; + setData: (d: ICompilableData) => void; + getDataView: () => DataView | undefined; + setDataView: (d: DataView) => void; + + // 状态 + state: IMarkStateManager; + readonly stateStyle: IMarkStateStyle; + hasState: (state: string) => boolean; + getState: (state: string) => any; + updateState: (newState: Record) => void; + /** 更新 mark 样式 */ + compileEncode: () => void; + + // 动画配置 + setAnimationConfig: (config: Partial) => void; + getAnimationConfig: () => Partial; + + // 是否显示 + getVisible: () => boolean; + setVisible: (visible: boolean) => void; + + // groupKey 配置 + setGroupKey: (groupKey: string) => void; + + // 用户 id + getUserId: () => StringOrNumber | undefined; + setUserId: (id: StringOrNumber) => void; + + compile: (option?: IMarkCompileOption) => void; + + getProduct: () => Maybe; + + /** 获取子mark */ + getMarks: () => ICompilableMark[]; + + /** 是否跳过布局阶段 */ + setSkipBeforeLayouted: (skip: boolean) => void; + + getMarkConfig: () => IMarkConfig; + setMarkConfig: (config: IMarkConfig) => void; + + getContext: () => any; + + /** 开始状态动画 */ + // runAnimationByState: (animationState?: string) => IAnimateArranger; + // /** 停止状态动画*/ + // stopAnimationByState: (animationState?: string) => IAnimate; + // /** 暂停状态动画*/ + // pauseAnimationByState: (animationState: string) => IAnimate; + // /** 恢复状态动画*/ + // resumeAnimationByState: (animationState: string) => IAnimate; + + layout: (layoutCallback: () => void) => void; + setDataLabelType?: () => string; +} +``` + +相关定义：[IGrammarItem](AdditionalTypes-Type-Definition.md#type-96b4a08944c0)、[MarkType](AdditionalTypes-Type-Definition.md#type-15c62fdeb46b)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[ICompilableData](AdditionalTypes-Type-Definition.md#type-bac9ca204677)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[IMarkStateManager](AdditionalTypes-Type-Definition.md#type-ee48e6df46c2)、[IMarkStateStyle](AdditionalTypes-Type-Definition.md#type-103f402e7251)、[MarkAnimationSpec](AdditionalTypes-Type-Definition.md#type-1cf6d57c137c)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IMarkCompileOption](AdditionalTypes-Type-Definition.md#type-4c11a0696204)、[Maybe](AdditionalTypes-Type-Definition.md#type-644c0bc1509c)、[IGroup](AdditionalTypes-Type-Definition.md#type-8af3ee2f9b73)、[IMarkConfig](AdditionalTypes-Type-Definition.md#type-589e28ffc9d8) + + +## IMarkCompileOption + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMarkCompileOption extends GrammarItemCompileOption { + group?: IGroup; + context?: any; +} +``` + +相关定义：[GrammarItemCompileOption](AdditionalTypes-Type-Definition.md#type-13afff202962)、[IGroup](AdditionalTypes-Type-Definition.md#type-8af3ee2f9b73) + + +## IMarkConfig + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMarkConfig { + clipPath?: IGraphic[] | ((graphics: IGraphic[]) => IGraphic[]); + clip?: boolean; + zIndex?: number; + interactive?: boolean; + /** + * set customized shape + */ + setCustomizedShape?: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D; + /** 是否开启大数据渲染模式 */ + large?: boolean; + /** 开启大数据渲染优化的阀值，对应的是data的长度 */ + largeThreshold?: number; + /** 分片长度 */ + progressiveStep?: number; + /** 开启分片渲染的阀值，对应的是单系列data的长度 */ + progressiveThreshold?: number; + /** + * use 'sequential' for symbol chart + * use 'mod' for bar/line chart + */ + // largeChunkMode?: 'sequential' | 'mod'; + support3d?: boolean; + /** + * 象形图，给图形设置名称 + */ + graphicName?: string | ((g: IMarkConfig) => string); + /** + * enable global morphing animation of the mark + */ + morph?: boolean; + /** + * this key will be used to match the mark to morph + */ + morphKey?: string; + /** + * this key will be used to match the element of two marks to morph + * If not specified, we'll use the "key" of the mark by default + */ + morphElementKey?: string; + + overflow?: 'scroll' | 'hidden' | 'scroll-x' | 'scroll-y'; + skipTheme?: boolean; + + /** + * 是否开启序列动画能力，默认关闭 + */ + useSequentialAnimation?: boolean; +} +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[ICustomPath2D](AdditionalTypes-Type-Definition.md#type-68cc5b53deb9) + + +## IMarkStateManager + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMarkStateManager { + getStateInfoList: () => IStateInfo[]; + getStateInfo: (stateValue: StateValue) => IStateInfo; + addStateInfo: (stateInfo: IStateInfo) => void; + changeStateInfo: (stateInfo: Partial) => void; + clearStateInfo: (stateValues: StateValue[]) => void; + clearAllStateInfo: () => void; + checkOneState: (renderNode: IMarkGraphic, datum: Datum[], state: IStateInfo) => 'in' | 'out' | 'skip'; + checkState: (renderNode: IMarkGraphic, datum: Datum[]) => StateValue[]; + getStateMap: () => StateValueMap; + updateState: (newState: Partial, noRender?: boolean) => void; + release: () => void; +} +``` + +相关定义：[IStateInfo](AdditionalTypes-Type-Definition.md#type-88e39c561dcb)、[StateValue](AdditionalTypes-Type-Definition.md#type-0848cecfdc96)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[StateValueMap](AdditionalTypes-Type-Definition.md#type-8cab308b2bc7) + + +## IModelMarkAttributeContext + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelMarkAttributeContext { + [key: string]: unknown; +} +``` + + +## ISeriesMarkAttributeContext + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesMarkAttributeContext extends IModelMarkAttributeContext { + // 通用的默认属性值获取，比如color，如果有散点图有sizeScale，则可以获取 size + globalScale: (scaleKey: string, value: string | number) => unknown; + // 传入seriesField值，获取对应的颜色。 + // 如果传入 null ，返回的是当前系列对应的第一个颜色值。 + seriesColor: (seriesValue?: string | number) => string; + /** + * 获取当前的 region + * @returns + */ + getRegion: () => IRegion; +} +``` + +相关定义：[IModelMarkAttributeContext](AdditionalTypes-Type-Definition.md#type-b137387c3a9b)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24) + + +## IStateInfo + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export interface IStateInfo { + /** 状态值 */ + stateValue: StateValue; + // 对应的数据维度 可以是多维度 + // TODO: fields 是否保留 + fields?: any | null | undefined; + /** 筛选数据 */ + datums?: any[] | null | undefined; + /** 筛选数据 */ + datumKeys?: string[] | null | undefined; + /** 筛选 item */ + items?: any[] | null | undefined; + /** 筛选函数 */ + filter?: + | (( + datum: any, + options: { + mark?: IMark; + type?: string; + renderNode?: IGraphic; + } + ) => boolean) + | null + | undefined; + cache?: { + [key: string]: { + [key: string]: boolean; + }; + }; + /** 状态优先级 */ + level?: number | undefined; +} +``` + +相关定义：[StateValue](AdditionalTypes-Type-Definition.md#type-0848cecfdc96)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3) + + +## STATE_CUSTOM + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type STATE_CUSTOM = string; +``` + + +## STATE_HOVER + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type STATE_HOVER = typeof STATE_VALUE_ENUM.STATE_HOVER; +``` + +相关定义：[STATE_VALUE_ENUM.STATE_HOVER](AdditionalTypes-Type-Definition.md#type-05b8969d76ad) + + +## STATE_HOVER_REVERSE + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type STATE_HOVER_REVERSE = typeof STATE_VALUE_ENUM.STATE_HOVER_REVERSE; +``` + +相关定义：[STATE_VALUE_ENUM.STATE_HOVER_REVERSE](AdditionalTypes-Type-Definition.md#type-05b8969d76ad) + + +## STATE_NORMAL + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type STATE_NORMAL = typeof STATE_VALUE_ENUM.STATE_NORMAL; +``` + +相关定义：[STATE_VALUE_ENUM.STATE_NORMAL](AdditionalTypes-Type-Definition.md#type-05b8969d76ad) + + +## STATE_VALUE_ENUM + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export enum STATE_VALUE_ENUM { + STATE_NORMAL = 'normal', + + STATE_HOVER = 'hover', + STATE_HOVER_REVERSE = 'hover_reverse', + + STATE_DIMENSION_HOVER = 'dimension_hover', + STATE_DIMENSION_HOVER_REVERSE = 'dimension_hover_reverse', + + STATE_SELECTED = 'selected', + STATE_SELECTED_REVERSE = 'selected_reverse', + + // todo: 2.0考虑优化 + STATE_SANKEY_EMPHASIS = 'selected', + STATE_SANKEY_EMPHASIS_REVERSE = 'blur', + + STATE_HIGHLIGHT = 'highlight', + STATE_BLUR = 'blur', + + STATE_ACTIVE = 'active' +} +``` + + +## StateValue + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type StateValue = STATE_NORMAL | STATE_HOVER | STATE_CUSTOM; +``` + +相关定义：[STATE_NORMAL](AdditionalTypes-Type-Definition.md#type-d571794e99de)、[STATE_HOVER](AdditionalTypes-Type-Definition.md#type-988d7ec528f6)、[STATE_CUSTOM](AdditionalTypes-Type-Definition.md#type-77e45e91e9ef) + + +## StateValueNot + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type StateValueNot = STATE_HOVER_REVERSE | STATE_CUSTOM; +``` + +相关定义：[STATE_HOVER_REVERSE](AdditionalTypes-Type-Definition.md#type-b2903000e622)、[STATE_CUSTOM](AdditionalTypes-Type-Definition.md#type-77e45e91e9ef) + + +## StateValueType + +来源：`packages/vchart/src/compile/mark/interface.ts`，VChart 2.1.7 + +```typescript +export type StateValueType = StateValue | StateValueNot; +``` + +相关定义：[StateValue](AdditionalTypes-Type-Definition.md#type-0848cecfdc96)、[StateValueNot](AdditionalTypes-Type-Definition.md#type-166ca5507a1b) + + +## IAxisHelper + +来源：`packages/vchart/src/component/axis/cartesian/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IAxisHelper { + isContinuous: boolean; + + dataToPosition: (values: any[], cfg?: IAxisLocationCfg) => number; + valueToPosition?: (value: any, cfg?: IAxisLocationCfg) => number; + getScale?: (depth: number) => IBaseScale; + getBandwidth?: (depth: number) => number | undefined; // band轴特有；连续轴可按关联柱系列返回虚拟 bandwidth + + // 用户其他模块扩充轴scale的区间 + setExtendDomain?: (key: string, value: number | undefined) => void; + + getAxisType: () => string; + + getAxisId: () => number; + + getSpec?: () => ICommonAxisSpec; + + isInverse: () => boolean; + + // 在地理坐标系系列中，传递经纬度配置字段 + getFields?: () => string[]; +} +``` + +相关定义：[IAxisLocationCfg](AdditionalTypes-Type-Definition.md#type-a2ddebc5e9d7)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[ICommonAxisSpec](AdditionalTypes-Type-Definition.md#type-500cf18886a4) + + +## AxisType + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export type AxisType = 'linear' | 'ordinal' | 'band' | 'point' | 'time' | 'log' | 'symlog'; +``` + + +## IAxis + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IAxis extends IComponent { + valueToPosition: (value: any) => number; + getScale: () => IBaseScale; + getScales: () => IBaseScale[]; + getOrient: () => ICartesianAxisSpec['orient'] | IPolarOrientType; + getInverse: () => boolean; + getCoordinateType: () => CoordinateType; + visible: boolean; + // 标记轴的方向，左到右，右到左，上到下，下到上 + directionStr?: 'l2r' | 'r2l' | 't2b' | 'b2t'; + // 更新轴的 scaleRange + updateScaleRange?: () => void; +} +``` + +相关定义：[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[ICartesianAxisSpec](ICartesianAxisSpec-Type-Definition.md)、[IPolarOrientType](AdditionalTypes-Type-Definition.md#type-ccede16adcb5)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b) + + +## IAxisItem + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IAxisItem { + /** + * 是否显示 + */ + visible?: boolean; + /** + * 样式配置 + */ + style?: Omit; +} +``` + + +## IAxisLocationCfg + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IAxisLocationCfg { + bandPosition?: number; + datum?: Datum; +} +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61) + + +## IBandAxisLayer + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IBandAxisLayer extends Omit { + /** + * 是否显示 + * @default true + */ + visible?: boolean; +} +``` + +相关定义：[ITickCalculationCfg](AdditionalTypes-Type-Definition.md#type-d35c784ee3a7) + + +## ITickCalculationCfg + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ITickCalculationCfg { + /** tick步长 */ + tickStep?: number; + /** + * 期望的连续轴tick数量 + * The desired number of ticks draw on linear axis. + * @default 5 + * @description 建议的tick数量，并不保证结果一定是配置值 + * @since 1.4.0 后支持函数回调。 + */ + tickCount?: number | ((option: ITickCallbackOption) => number); + /** + * 强制设置tick数量 + * The exact number of ticks draw on linear axis. Might lead to decimal step. + * @default 5 + * @description 强制设置的tick数量，可能由于数据范围导致tick值为小数 + */ + forceTickCount?: number; + /** + * 连续轴 tick 生成算法： + * 'average': 尽可能均分； + * 'd3'：与 d3 默认逻辑一致，以 [1, 2, 5] 为基数生成； + * CustomTicksFunc: 自定义tick生成算法 + * @default 'average' + * @since 1.3.0 + * + * @typedef {function} CustomTicksFunc + * @param {IContinuousScale} scale - 连续轴的比例尺对象 + * @param {number} tickCount - 生成tick的数量 + * @returns {number[]} - 生成的 tick 数组 + * @since 1.12.0 + * + * @example + * // 自定义 tick 生成函数示例 + * const customTickFunc: CustomTicksFunc = (scale, tickCount=5) => { + * const domain = scale.domain(); + * const step = (domain[domain.length - 1] - domain[0]) / (tickCount - 1); + * return Array.from({ length: tickCount }, (_, i) => domain[0] + i * step); + * }; + */ + tickMode?: 'average' | 'd3' | CustomTicksFunc; + /** + * 连续轴，是否避免小数 tick。 + * @default false + * @description 当配置了 tickStep 或 forceTickCount 时不生效。 + * @since 1.3.0 + */ + noDecimals?: boolean; +} +``` + +相关定义：[ITickCallbackOption](AdditionalTypes-Type-Definition.md#type-41696b783ff0)、[CustomTicksFunc](AdditionalTypes-Type-Definition.md#type-a2851eee354b)、[IContinuousScale](AdditionalTypes-Type-Definition.md#type-61b93a04c77c) + + +## ITickCallbackOption + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export type ITickCallbackOption = { + axisLength?: number; + labelStyle?: ITextGraphicAttribute; +}; +``` + +相关定义：[ITextGraphicAttribute](AdditionalTypes-Type-Definition.md#type-36d5f8ea422d) + + +## StyleCallback + +来源：`packages/vchart/src/component/axis/interface/common.ts`，VChart 2.1.7 + +```typescript +export type StyleCallback = (value: any, index: number, datum: Datum, data: Datum[]) => T; +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61) + + +## IBandAxisSpec + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IBandAxisSpec { + /** + * 是否去除 band 轴两端的留白，如果为 true，则两端的 padding 为 0， + * **并且 bandPadding、paddingInner 和 paddingOuter 的设置将被忽略**。 + * @default false + * @since 1.7.0 + */ + trimPadding?: boolean; + /** + * 同时设置轴的 paddingInner 和 paddingOuter + * **因为有可能存在多层 scale( xField 设置成了数组，即分组场景），所以支持了数组类型，用于多层 scale 的 bandPadding 配置** + */ + bandPadding?: number | number[]; + /** + * band 轴的内边距 + * ** 因为有可能存在多层 scale( xField 设置成了数组，即分组场景），所以支持了数组类型，用于多层 scale 的 paddingInner 配置** + * @default 0.1 + */ + paddingInner?: number | number[]; + /** + * band 轴的外边距 + * ** 因为有可能存在多层 scale( xField 设置成了数组，即分组场景），所以支持了数组类型，用于多层 scale 的 paddingOuter 配置** + * @default 0.3 + */ + paddingOuter?: number | number[]; + /** + * 配置离散轴的数值范围 + * @since 1.1.0 + */ + domain?: StringOrNumber[]; + /** + * `bandPosition` 是一个可选参数，用于指定数据点在 band 轴上的位置。它的含义是确定数据点在 band 轴上的位置偏移量，相对于 band 轴的起始位置。 + * `bandPosition` 的取值范围是从 0 到 1，其中 0 表示数据点位于 band 轴的起始位置，1 表示数据点位于 band 轴的结束位置。 + * @default 0.5 + */ + bandPosition?: number; + + /** + * 当存在多层分组场景时，是否展示所有的分组轴 + * @default false + * @since 1.9.0 + */ + showAllGroupLayers?: boolean; + /** + * 每一层轴的配置 + * layer[0] 为离坐标轴线最近的轴，当且仅当 `showAllGroupLayers` 配置开启生效。 + * @since 1.9.0 + */ + layers?: IBandAxisLayer[]; +} +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IBandAxisLayer](AdditionalTypes-Type-Definition.md#type-840e25edaed7) + + +## ICommonAxisSpec + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ICommonAxisSpec extends Omit, IAnimationSpec { + /** + * 轴类型 + */ + type?: AxisType; + /** + * 是否显示坐标轴 + * @default true + */ + visible?: boolean; + /** + * 是否开启反向坐标轴。 + * @default false + */ + inverse?: boolean; + /** + * 轴刻度线配置 + */ + tick?: ITick; + /** + * 子刻度线配置 + */ + subTick?: ISubTick; + + /** + * 是否开启动画，默认关闭 + * @default false + */ + animation?: boolean; + + // 交互相关的配置 + /** + * 是否开启 select 选中交互，默认关闭 + * @default false + */ + select?: boolean; + /** + * 是否开启 hover 悬浮交互，默认关闭 + * @default false + */ + hover?: boolean; + + /** + * 是否开启轴数据采样，默认开启。 + * 轴采样开启之后，会对轴数据进行采样显示，防止轴数据的重叠。 + * 通过配置 `label.minGap` 可以控制轴标签之间的间距。 + * @default true + * @since 1.1.0 + */ + sampling?: boolean; + + /** + * 是否强制初始化 tick 数据，仅在 visible 为 false 时生效 + * @default false + */ + forceInitTick?: boolean; +} +``` + +相关定义：[IComponentSpec](AdditionalTypes-Type-Definition.md#type-d23c51c12154)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[AxisType](AdditionalTypes-Type-Definition.md#type-3271a928e402)、[ITick](AdditionalTypes-Type-Definition.md#type-ffc51285024b)、[ISubTick](AdditionalTypes-Type-Definition.md#type-8a597b4f0966) + + +## IDomainLine + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IDomainLine extends IAxisItem { + /** + * domainLine 在不同交互状态下的样式配置，支持： + * 1. hover + * 2. hover_reverse + * 3. selected + * 4. selected_reverse + */ + state?: AxisItemStateStyle; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[AxisItemStateStyle](AdditionalTypes-Type-Definition.md#type-80c23221deb4) + + +## IGrid + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IGrid extends IAxisItem { + /** + * 两个栅格线间的填充色 + */ + alternateColor?: string | string[]; + /** + * grid 是否与 label 对齐，默认为 true，即对齐，配置为 false 则显示在前后两个刻度中间 + * @default true + */ + alignWithLabel?: boolean; + /** + * 网格线样式，支持回调 + */ + style?: IRuleMarkSpec | StyleCallback; + /** + * 快捷属性，也可以在 `style` 中配置，用于配置网格线的绘制顺序，默认为 50 + * @default 50 + * @since 1.4.0 + */ + zIndex?: number; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[StyleCallback](AdditionalTypes-Type-Definition.md#type-9266636e13da) + + +## ILabel + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ILabel extends IAxisItem { + /** + * 文本类型 + * @deprecated 1.10.0 版本后，在 formatMethod 中返回 { type: 'rich', text: xxx} + * */ + type?: 'text' | 'rich'; + /** + * 轴标签内容格式化函数 + * @param text 原始标签文本值 + * @param datum 图形数据 + * @returns 格式化后的文本 + */ + formatMethod?: IFormatMethod<[text: string | string[], datum?: Datum]>; + /** + * 格式化模板 + * @description 可以通过类似 `{value:.2f}%` 的形式对指定数据字段进行格式化 + * @since 1.10.0 + */ + formatter?: string | string[]; + /** 标签同 tick 之间的间距 */ + space?: number; + /** + * 标签朝向，默认朝外(坐标线包围盒外部) + * @default false + */ + inside?: boolean; + /** + * 标签之间的最小间距（单位为像素），仅当轴采样开始时生效（`sampling: true`）。 + * 该配置会影响轴采样的结果。 + */ + minGap?: number; + /** + * 文本样式设置 + */ + style?: ITextMarkSpec | StyleCallback; + /** + * label 不同交互状态下的样式配置，支持： + * 1. hover + * 2. hover_reverse + * 3. selected + * 4. selected_reverse + */ + state?: AxisItemStateStyle; + /** + * 用于 label 的数据过滤 + * @since 1.1.0 + */ + dataFilter?: (data: AxisItem[], layer: number, context: { vchart: IVChart }) => AxisItem[]; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IFormatMethod](AdditionalTypes-Type-Definition.md#type-6375b3333257)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[StyleCallback](AdditionalTypes-Type-Definition.md#type-9266636e13da)、[AxisItemStateStyle](AdditionalTypes-Type-Definition.md#type-80c23221deb4)、[AxisItem](AdditionalTypes-Type-Definition.md#type-7666dd9220f0)、[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201) + + +## ISubTick + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ISubTick extends IAxisItem { + /** + * TODO: 考虑下 log 轴，自刻度线之间的间距是不均匀的问题 + * 子刻度个数 + */ + tickCount?: number; + /** + * 子刻度线朝向，默认朝外(坐标线包围盒外部) + * @default false + */ + inside?: boolean; + /** 子刻度线的长度 */ + tickSize?: number; + /** + * 子刻度线不同交互状态下的样式配置，支持： + * 1. hover + * 2. hover_reverse + * 3. selected + * 4. selected_reverse + */ + state?: AxisItemStateStyle; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[AxisItemStateStyle](AdditionalTypes-Type-Definition.md#type-80c23221deb4) + + +## ITick + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ITick extends IAxisItem, ITickCalculationCfg { + /** + * Length of tick lines + * 坐标轴刻度线的长度 + * @default 4 + */ + tickSize?: number; + /** + * 刻度线朝向，默认朝外(坐标线包围盒外部) + * @default false + */ + inside?: boolean; + /** + * tick 是否与 label 对齐，默认为 true，即对齐，配置为 false 则显示在前后两个刻度中间 + * @default true + */ + alignWithLabel?: boolean; + /** + * 刻度线样式设置，支持回调 + */ + style?: IRuleMarkSpec | StyleCallback; + /** + * 刻度线不同交互状态下的样式配置，支持： + * 1. hover + * 2. hover_reverse + * 3. selected + * 4. selected_reverse + */ + state?: AxisItemStateStyle; + /** + * 用于 tick 的数据过滤 + * @since 1.1.0 + */ + dataFilter?: (data: AxisItem[], context: { vchart: IVChart }) => AxisItem[]; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[ITickCalculationCfg](AdditionalTypes-Type-Definition.md#type-d35c784ee3a7)、[StyleCallback](AdditionalTypes-Type-Definition.md#type-9266636e13da)、[AxisItemStateStyle](AdditionalTypes-Type-Definition.md#type-80c23221deb4)、[AxisItem](AdditionalTypes-Type-Definition.md#type-7666dd9220f0)、[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201) + + +## ITitle + +来源：`packages/vchart/src/component/axis/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ITitle extends IAxisItem { + /** + * 文本类型 + * @deprecated 1.10.0 版本后，在 formatMethod 中返回 { type: 'rich', text: xxx} + * */ + type?: 'text' | 'rich'; + /** + * 轴标题内容，支持多种格式 + * - 字符串或者数值 + * - 字符串或者数值数组 + */ + text?: ITextMarkSpec['text'] | ReturnType>; + /** + * 标题的显示位置，直角坐标系默认 'middle'； + * 极坐标系的圆弧轴如果配置了内半径，则默认 'middle'，否则 'end' + */ + position?: 'start' | 'middle' | 'end'; + /** + * 标题距离坐标轴(轴线、刻度、标签共同构成的包围盒)的距离 + */ + space?: number; + /** + * 标题内边距配置 + */ + padding?: IPadding | number | number[]; + /** + * 标题背景色设置 + */ + background?: IAxisItem & { + /** + * 背景的交互状态样式配置 + */ + state?: AxisItemStateStyle>; + }; + /** + * TODO: 接入富文本 + * 标题 shape 配置 + */ + shape?: IAxisItem & { + /** + * shape 同标题文本之间的间距 + */ + space?: number; + /** + * shape 标记的交互状态样式配置 + */ + state?: AxisItemStateStyle>; + }; + /** + * 标题整体的旋转角度（如果标题配置了 background、shape 等属性的话，需要使用该属性进行整体的配置旋转）。 + */ + angle?: number; + /** + * text 文本的交互状态样式配置 + */ + state?: AxisItemStateStyle>; +} +``` + +相关定义：[IAxisItem](AdditionalTypes-Type-Definition.md#type-a4970733eae3)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IRichTextFormatMethod](AdditionalTypes-Type-Definition.md#type-3b28c6257cf4)、[IPadding](IPadding-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[AxisItemStateStyle](AdditionalTypes-Type-Definition.md#type-80c23221deb4)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md) + + +## IPolarAxisHelper + +来源：`packages/vchart/src/component/axis/polar/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IPolarAxisHelper { + // axis is continuous + isContinuous: boolean; + + dataToPosition: (values: any, cfg?: any) => number; + coordToPoint: (point: IPolarPoint) => IPoint; + pointToCoord: (point: IPoint) => IPolarPoint; + center: () => IPoint; + layoutRadius: () => number; + + getScale: (depth?: number) => IBaseScale; + getBandwidth?: (depth?: number) => number; // band轴特有 + getAxisId: () => number; + // 用户其他模块扩充轴scale的区间 + setExtendDomain?: (key: string, value: number | undefined) => void; +} +``` + +相关定义：[IPolarPoint](AdditionalTypes-Type-Definition.md#type-d403c828183d)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d) + + +## IPolarGrid + +来源：`packages/vchart/src/component/axis/polar/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IPolarGrid = IGrid & { + /** + * smooth 为 true 时，为圆形 grid，为 false 则为多边形 grid + * @default false + */ + smooth?: boolean; +}; +``` + +相关定义：[IGrid](AdditionalTypes-Type-Definition.md#type-1de217f01390) + + +## IPolarAxisCommonSpec + +来源：`packages/vchart/src/component/axis/polar/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IPolarAxisCommonSpec = Omit & { + /** + * 布局半径，相当于计算内径、外径的基准值 + * 默认值为: region宽度、高度最小值的一般 + * @since 1.11.2 + */ + layoutRadius?: 'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number); + /** + * 当配置了 innerRadius 时，可以通过设置 inside: true，将坐标轴展示在内圆。 + * @default false + */ + inside?: boolean; + /** + * 轴位置，枚举类型，支持：`'radius'` 和 `'angle'` + * - `'radius'` 代表半径轴 + * - `'angle'` 代表角度轴 + */ + orient: IPolarOrientType; + /** + * 网格线配置 + */ + grid?: IPolarGrid; + /** + * 轴的外半径，数值范围 0 -1 + */ + radius?: number; + /** + * 子网格线配置 + */ + subGrid?: IPolarGrid; + /** + * 轴线配置 + */ + domainLine?: IDomainLine; + /** + * 轴标签配置 + */ + label?: IPolarAxisLabel; + /** + * 轴标题配置 + */ + title?: ITitle; + /** + * 内半径（比例值，取值范围 0~1） + */ + innerRadius?: number; + /** + * 外半径（比例值，取值范围 0~1） + */ + outerRadius?: number; + /** + * 中心点 + * @since 1.11.2 x,y 支持百分比的值，如`50%` + */ + center?: { x: number | string; y: number | string }; + /** + * 起始角度 + */ + startAngle?: number; + /** + * 终止角度 + */ + endAngle?: number; +}; +``` + +相关定义：[ICommonAxisSpec](AdditionalTypes-Type-Definition.md#type-500cf18886a4)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IPointLike](AdditionalTypes-Type-Definition.md#type-e25b463f6cfe)、[IPolarOrientType](AdditionalTypes-Type-Definition.md#type-ccede16adcb5)、[IPolarGrid](AdditionalTypes-Type-Definition.md#type-9dc0e97c311d)、[IDomainLine](AdditionalTypes-Type-Definition.md#type-89c12f9d6546)、[IPolarAxisLabel](AdditionalTypes-Type-Definition.md#type-fc89a697d2d9)、[ITitle](AdditionalTypes-Type-Definition.md#type-d18262dc39a4) + + +## IPolarAxisLabel + +来源：`packages/vchart/src/component/axis/polar/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IPolarAxisLabel = ILabel & + Pick< + AxisLabelOverlap, + 'autoHide' | 'autoHideMethod' | 'autoHideSeparation' | 'autoLimit' | 'limitEllipsis' | 'layoutFunc' | 'autoWrap' + > & { + /** + * 是否自动限制标签最大宽度（开启基于布局的宽度控制） + * @since 2.0.12 + */ + autoLabelMaxWidth?: boolean; + }; +``` + +相关定义：[ILabel](AdditionalTypes-Type-Definition.md#type-f22047f767c3)、[AxisLabelOverlap](AdditionalTypes-Type-Definition.md#type-92b85bf48fbb) + + +## IPolarBandAxisSpec + +来源：`packages/vchart/src/component/axis/polar/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IPolarBandAxisSpec = IPolarAxisCommonSpec & IBandAxisSpec; +``` + +相关定义：[IPolarAxisCommonSpec](AdditionalTypes-Type-Definition.md#type-b43b48bb37ff)、[IBandAxisSpec](AdditionalTypes-Type-Definition.md#type-63185662c008) + + +## IPolarLinearAxisSpec + +来源：`packages/vchart/src/component/axis/polar/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IPolarLinearAxisSpec = IPolarAxisCommonSpec & ILinearAxisSpec; +``` + +相关定义：[IPolarAxisCommonSpec](AdditionalTypes-Type-Definition.md#type-b43b48bb37ff)、[ILinearAxisSpec](ILinearAxisSpec-Type-Definition.md) + + +## IComponentSpec + +来源：`packages/vchart/src/component/base/interface.ts`，VChart 2.1.7 + +```typescript +export interface IComponentSpec extends IModelSpec { + /** + * 组件关联的region索引 + * @default 0 + */ + regionIndex?: number | number[]; + /** + * 组件关联的region id + */ + regionId?: StringOrNumber | StringOrNumber[]; + /** + * 组件关联的系列索引 + */ + seriesIndex?: number | number[]; + /** + * 组件关联的系列id + */ + seriesId?: StringOrNumber | StringOrNumber[]; +} +``` + +相关定义：[IModelSpec](AdditionalTypes-Type-Definition.md#type-93f598dd1ef8)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## ICrosshairSpec + +来源：`packages/vchart/src/component/crosshair/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type ICrosshairSpec = ICartesianCrosshairSpec | IPolarCrosshairSpec; +``` + +相关定义：[ICartesianCrosshairSpec](ICartesianCrosshairSpec-Type-Definition.md)、[IPolarCrosshairSpec](IPolarCrosshairSpec-Type-Definition.md) + + +## IGeoCoordinateHelper + +来源：`packages/vchart/src/component/geo/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGeoCoordinateHelper { + longitudeField?: string; + latitudeField?: string; + + dataToPosition: (values: [number, number]) => IPoint; + dataToLatitude: (lat: number) => number; + dataToLongitude: (lon: number) => number; + + shape: (datum: any) => string; + + getCoordinateId: () => number; +} +``` + +相关定义：[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b) + + +## IComponent + +来源：`packages/vchart/src/component/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IComponent extends ILayoutModel { + readonly name: string; + + // 区域 + getRegions: () => IRegion[]; + getBindSeriesFilter?: () => ISeriesFilter; + getVRenderComponents: () => IGraphic[]; + + // 清空，用于更新等场景 + clear: () => void; + + // 数据 + getDatum: (childGraphic?: IGraphic) => any | undefined; +} +``` + +相关定义：[ILayoutModel](AdditionalTypes-Type-Definition.md#type-b788a1bf7960)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24)、[ISeriesFilter](AdditionalTypes-Type-Definition.md#type-547a568e3f15)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3) + + +## IComponentConstructor + +来源：`packages/vchart/src/component/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IComponentConstructor extends IModelConstructor { + type: string; + specKey?: string; + getSpecInfo?: (chartSpec: any, chartSpecInfo?: IChartSpecInfo) => Maybe; + createComponent: (specInfo: IModelSpecInfo, options: IComponentOption) => IComponent; + new (spec: any, options: IComponentOption): IComponent; +} +``` + +相关定义：[IModelConstructor](AdditionalTypes-Type-Definition.md#type-b2886ff503c6)、[IChartSpecInfo](AdditionalTypes-Type-Definition.md#type-618e9dfe06cf)、[Maybe](AdditionalTypes-Type-Definition.md#type-644c0bc1509c)、[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a)、[IComponentOption](AdditionalTypes-Type-Definition.md#type-3aea69e255fe)、[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c) + + +## IComponentOption + +来源：`packages/vchart/src/component/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IComponentOption extends IModelOption { + // 区域 + getAllRegions: () => IRegion[]; + getRegionsInIndex: (index?: number[]) => IRegion[]; + getRegionsInIds: (ids: number[]) => IRegion[]; + getRegionsInUserIdOrIndex: (user_ids?: StringOrNumber[], index?: number[]) => IRegion[]; + // series + getAllSeries: () => ISeries[]; + getSeriesInIndex: (index?: number[]) => ISeries[]; + getSeriesInIds: (ids?: number[]) => ISeries[]; + getSeriesInUserIdOrIndex: (user_ids?: StringOrNumber[], index?: number[]) => ISeries[]; + // component + getAllComponents: () => IComponent[]; + getComponentByIndex: (key: string, index: number) => IComponent | undefined; + getComponentByUserId: (userId: StringOrNumber) => IComponent | undefined; + getComponentsByKey: (key: string) => IComponent[]; + getComponentsByType: (type: string) => IComponent[]; +} +``` + +相关定义：[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c) + + +## ComponentTypeEnum + +来源：`packages/vchart/src/component/interface/type.ts`，VChart 2.1.7 + +```typescript +export enum ComponentTypeEnum { + cartesianAxis = 'cartesianAxis', + cartesianBandAxis = 'cartesianAxis-band', + cartesianLinearAxis = 'cartesianAxis-linear', + cartesianTimeAxis = 'cartesianAxis-time', + cartesianLogAxis = 'cartesianAxis-log', + cartesianSymlogAxis = 'cartesianAxis-symlog', + polarAxis = 'polarAxis', + polarBandAxis = 'polarAxis-band', + polarLinearAxis = 'polarAxis-linear', + crosshair = 'crosshair', + cartesianCrosshair = 'cartesianCrosshair', + polarCrosshair = 'polarCrosshair', + dataZoom = 'dataZoom', + geoCoordinate = 'geoCoordinate', + indicator = 'indicator', + discreteLegend = 'discreteLegend', + continuousLegend = 'continuousLegend', + colorLegend = 'colorLegend', + sizeLegend = 'sizeLegend', + markLine = 'markLine', + markArea = 'markArea', + markPoint = 'markPoint', + polarMarkLine = 'polarMarkLine', + polarMarkArea = 'polarMarkArea', + polarMarkPoint = 'polarMarkPoint', + geoMarkPoint = 'geoMarkPoint', + tooltip = 'tooltip', + title = 'title', + player = 'player', + scrollBar = 'scrollBar', + label = 'label', + totalLabel = 'totalLabel', + + brush = 'brush', + + poptip = 'poptip', + + customMark = 'customMark' +} +``` + + +## ILabelInfo + +来源：`packages/vchart/src/component/label/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILabelInfo { + baseMark: IMark; + labelMark: ILabelMark; + series: ISeries; + labelSpec: TransformedLabelSpec; +} +``` + +相关定义：[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[ILabelMark](AdditionalTypes-Type-Definition.md#type-e9520a36483b)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[TransformedLabelSpec](AdditionalTypes-Type-Definition.md#type-cc4522eb0b63) + + +## TransformedLabelSpec + +来源：`packages/vchart/src/component/label/interface.ts`，VChart 2.1.7 + +```typescript +export type TransformedLabelSpec = ILabelSpec & { + getStyleHandler: (series: ISeries) => (mark?: ILabelMark, spec?: any) => void; +}; +``` + +相关定义：[ILabelSpec](ILabelSpec-Type-Definition.md)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[ILabelMark](AdditionalTypes-Type-Definition.md#type-e9520a36483b) + + +## ContinuousLegendTextStyle + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +type ContinuousLegendTextStyle = Omit, 'text'>; +``` + +相关定义：[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md) + + +## ContinuousLegendTextStyleCallback + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +type ContinuousLegendTextStyleCallback = ( + value: Text, + position: 'start' | 'end', + context: HandlerTextStyleContext +) => ContinuousLegendTextStyle | undefined; +``` + +相关定义：[Text](AdditionalTypes-Type-Definition.md#type-960aad16c272)、[HandlerTextStyleContext](AdditionalTypes-Type-Definition.md#type-589dee7f19a8)、[ContinuousLegendTextStyle](AdditionalTypes-Type-Definition.md#type-002e36355ca4) + + +## HandlerTextAttribute + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +export type HandlerTextAttribute = { + /** 是否展示 */ + visible?: boolean; + /** + * 数据展示的小数精度，默认为0，无小数点。 + */ + precision?: number; + /** 文本内容格式化函数 */ + formatter?: (text: Text) => Text; + /** + * 文本同滑块的间距，默认为 6 + */ + space?: number; + /** + * 文本样式 + */ + style?: ContinuousLegendTextStyle | ContinuousLegendTextStyleCallback; +}; +``` + +相关定义：[Text](AdditionalTypes-Type-Definition.md#type-960aad16c272)、[ContinuousLegendTextStyle](AdditionalTypes-Type-Definition.md#type-002e36355ca4)、[ContinuousLegendTextStyleCallback](AdditionalTypes-Type-Definition.md#type-9281e10d6686) + + +## IColorLegendSpec + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +export type IColorLegendSpec = IContinuousLegendSpec & { + /** + * 声明 color 类型图例 + */ + type: 'color'; +}; +``` + +相关定义：[IContinuousLegendSpec](AdditionalTypes-Type-Definition.md#type-178043e98fbb) + + +## IContinuousLegendSpec + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +export type IContinuousLegendSpec = ILegendCommonSpec & { + /** + * 连续图例是否开启反向展示，最小值和最大值会发生反向 + * @default false + * @since 1.11.0 + */ + inverse?: boolean; + /** + * 声明关联的映射字段 + */ + field?: string; + /** + * 连续图例关联的映射 scale + */ + scale?: string; + /** + * 默认筛选的数据范围 + */ + defaultSelected?: [number, number]; + /** + * 是否允许拖动，默认为 true + */ + slidable?: boolean; + /** + * 滑块轨道配置 + */ + rail?: { + /** + * 滑块的宽度 + */ + width?: number; + /** + * 滑块的高度 + */ + height?: number; + /** + * 背景轨道样式配置 + */ + style?: Omit, 'width' | 'height'>; + }; + /** + * 滑块手柄配置 + */ + handler?: { + /** + * 是否绘制 handler，默认为 true + */ + visible?: boolean; + /** + * 滑块手柄的样式配置 + */ + style?: NoVisibleMarkStyle; + }; + /** + * 选中区域样式配置 + */ + track?: { + style?: Omit, 'width' | 'height'>; + }; + /** + * 滑块首部文本配置 + */ + startText?: TextAttribute; + /** + * 滑块尾部文本配置 + */ + endText?: TextAttribute; + /** + * 滑块对应的文本配置项 + */ + handlerText?: HandlerTextAttribute; +}; +``` + +相关定义：[ILegendCommonSpec](AdditionalTypes-Type-Definition.md#type-2ad671a416ad)、[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[TextAttribute](AdditionalTypes-Type-Definition.md#type-2a9351a6ae07)、[HandlerTextAttribute](AdditionalTypes-Type-Definition.md#type-a72bb8927b69) + + +## ISizeLegendSpec + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +export type ISizeLegendSpec = IContinuousLegendSpec & { + /** + * 声明 size 类型图例 + */ + type: 'size'; + /** + * size 背景样式配置 + */ + sizeBackground?: Omit, 'visible' | 'width' | 'height'>; + /** + * 指定组件中手柄和文字的摆放位置，可选值为： + * 'left' 手柄和label在滑块左侧，layout 为 vertical 时有效。 + * 'right' 手柄和label在滑块右侧，layout 为 vertical 时有效。 + * 'top' 手柄和label在滑块上侧，layout 为 horizontal 时有效。 + * 'bottom' 手柄和label在滑块下侧，layout 为 horizontal 时有效。 + */ + align?: 'top' | 'bottom' | 'left' | 'right'; +}; +``` + +相关定义：[IContinuousLegendSpec](AdditionalTypes-Type-Definition.md#type-178043e98fbb)、[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md) + + +## Text + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +type Text = StringOrNumber; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## TextAttribute + +来源：`packages/vchart/src/component/legend/continuous/interface.ts`，VChart 2.1.7 + +```typescript +export type TextAttribute = { + /** 是否展示 */ + visible?: boolean; + /** 文本内容 */ + text?: Text; + /** + * 文本同滑块的间距，默认为 6 + */ + space?: number; + /** + * 文本样式 + */ + style?: ContinuousLegendTextStyle; +}; +``` + +相关定义：[Text](AdditionalTypes-Type-Definition.md#type-960aad16c272)、[ContinuousLegendTextStyle](AdditionalTypes-Type-Definition.md#type-002e36355ca4) + + +## DiscreteLegendArrangeCount + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type DiscreteLegendArrangeCount = number | ((ctx: IDiscreteLegendArrangeContext) => number); +``` + +相关定义：[IDiscreteLegendArrangeContext](AdditionalTypes-Type-Definition.md#type-b2a5329df03f) + + +## formatterCallback + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type formatterCallback = IFormatMethod<[text: StringOrNumber, item: LegendItemDatum, index: number]>; +``` + +相关定义：[IFormatMethod](AdditionalTypes-Type-Definition.md#type-6375b3333257)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[LegendItemDatum](AdditionalTypes-Type-Definition.md#type-75bc5c7a36bf) + + +## IDiscreteLegendArrangeContext + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export interface IDiscreteLegendArrangeContext { + /** the layout rect allocated to the legend in the current layout */ + rect: ILayoutRect; + /** the resolved orient the legend lays out with (defaults to `'left'` when `spec.orient` is unset) */ + orient: IOrientType; + /** the id of the legend */ + id?: StringOrNumber; +} +``` + +相关定义：[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IDiscreteLegendPagerCallbackContext + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export interface IDiscreteLegendPagerCallbackContext extends IDiscreteLegendArrangeContext { + /** the resolved maximum row count, when configured */ + maxRow?: number; + /** the resolved maximum column count, when configured */ + maxCol?: number; +} +``` + +相关定义：[IDiscreteLegendArrangeContext](AdditionalTypes-Type-Definition.md#type-b2a5329df03f) + + +## IDiscreteLegendSpec + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type IDiscreteLegendSpec = ILegendCommonSpec & { + type?: 'discrete'; + /** + * 在原始图例绘制数据的基础上，进行自定义，比如可以自定义 value 值 + * @param data 图例的绘制数据 + * @param colorScale 全局颜色映射 scale + * @param globalScale 图表上所有的 scale + * @returns + */ + data?: (data: LegendItemDatum[], colorScale: IBaseScale, globalScale: IGlobalScale) => LegendItemDatum[]; + + /** 图例项配置 */ + item?: IItem; + + /** + * 翻页器配置 + */ + pager?: IPager | ILegendScrollbar; + /** + * scale must match the id of the scale configured in **scales** + * 离散图例对应的scale + * @since 1.10.5 + */ + scale?: string; + /** + * 同`scale`，为了和连续图例保持一致，建议统一为`scale` + */ + scaleName?: string; + /** + * After the legend is bound to the scale, the dimension associated with the series data and the legend can be configured through field. + * If the field is not configured, the first item of fields in the domain of scale is used by default + * If the domain of the scale is not dependent on data statistics, series.getSeriesField() is used by default + */ + field?: string; + /** + * 默认筛选的数据范围 + */ + defaultSelected?: string[]; + /** + * The maximum number of rows displayed (for horizontal legend). Besides a fixed number, a + * callback `(ctx) => number` is also supported, which is evaluated during layout so the row + * count can adapt to the space allocated to the legend. + * @since 2.0.23 + */ + maxRow?: DiscreteLegendArrangeCount; + /** + * The maximum number of columns displayed (for vertical legend). Besides a fixed number, a + * callback `(ctx) => number` is also supported (see {@link maxRow}). + * @since 2.0.23 + */ + maxCol?: DiscreteLegendArrangeCount; +} & Omit; +``` + +相关定义：[ILegendCommonSpec](AdditionalTypes-Type-Definition.md#type-2ad671a416ad)、[LegendItemDatum](AdditionalTypes-Type-Definition.md#type-75bc5c7a36bf)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[IGlobalScale](AdditionalTypes-Type-Definition.md#type-86e42efb33dd)、[IItem](AdditionalTypes-Type-Definition.md#type-57549774cd09)、[IPager](AdditionalTypes-Type-Definition.md#type-f566fb09d5b0)、[ILegendScrollbar](AdditionalTypes-Type-Definition.md#type-d1127d0675cd)、[DiscreteLegendArrangeCount](AdditionalTypes-Type-Definition.md#type-fba860215816)、[DiscreteLegendAttrs](AdditionalTypes-Type-Definition.md#type-8f8c60190b3e) + + +## IItem + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type IItem = { + /** + * @since 1.10.0 + * 指定图例项中图标和文字的摆放位置，可选值为： + * 'left' 图标在左侧 + * 'right' 图标在右侧 + * 默认值为： 'left' + */ + align?: 'left' | 'right'; + /** + * 图例项背景配置 + */ + background?: { + /** + * 是否展示图例项背景 + */ + visible?: boolean; + } & LegendItemStyle>>; + /** + * 图例项的 shape 图标的配置 + */ + shape?: { + /** + * 图例项的 shape 图标 + */ + visible?: boolean; + /** shape 同后面 label 的间距 */ + space?: number; + } & LegendItemStyle>>>; + /** + * 图例项的 label 文本配置 + */ + label?: { + /** + * @since 1.10.0 + * 当 label + value 同时展示，文字超长的时候，label的宽度占比 + */ + widthRatio?: number; + /** + * 图例项 label 同后面 value 的间距 + */ + space?: number; + /** + * 格式化文本函数 + */ + formatMethod?: formatterCallback; + /** + * 格式化模板 + * @description 可以通过类似 `{value:.2f}%` 的形式对指定数据字段进行格式化 + * @since 1.10.0 + */ + formatter?: string; + } & LegendItemStyle>>; + /** + * 图例项 value 配置 + */ + value?: { + /** + * @since 1.10.0 + * 当 label + value 同时展示，文字超长的时候，label的宽度占比 + */ + widthRatio?: number; + /** value 同后面元素的间距 */ + space?: number; + /** + * 是否右对齐显示，仅当设置图例项宽度 itemWidth 时生效 + * 默认为 false， + */ + alignRight?: boolean; + /** + * 格式化文本函数 + */ + formatMethod?: formatterCallback; + /** + * 格式化模板 + * @description 可以通过类似 `{value:.2f}%` 的形式对指定数据字段进行格式化 + * @since 1.10.0 + */ + formatter?: string | string[]; + } & LegendItemStyle>>; + /** + * 聚焦按钮配置 + */ + focusIconStyle?: NoVisibleMarkStyle; + /** + * 图例项的最大宽度，默认为 null。 + * 可使用百分比，表示显示区域的宽度占比。 + */ + maxWidth?: number | string; + /** + * 图例项的宽度, 默认自动计算。 + * 可使用百分比，表示显示区域的宽度占比。 + */ + width?: number | string; + /** + * 图例的高度，默认自动计算。 + * 可使用百分比，表示显示区域的高度占比。 + */ + height?: number | string; + /** + * @since 1.10.0 + * 当label+ value同时存在的时候，自动省略的策略 + * 'labelFirst' - 尽量保证完整展示`label` + * 'valueFirst' - 尽量保证完整展示`value` + * 'none' - 按照`widthRatio`展示label 和 value + */ + autoEllipsisStrategy?: 'labelFirst' | 'valueFirst' | 'none'; +} & Omit; +``` + +相关定义：[LegendItemStyle](AdditionalTypes-Type-Definition.md#type-643f46f185c3)、[LegendItemStyleValue](AdditionalTypes-Type-Definition.md#type-4f178926a3e4)、[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[formatterCallback](AdditionalTypes-Type-Definition.md#type-38a35ad3a73f)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[LegendItem](AdditionalTypes-Type-Definition.md#type-1b703f3ae381) + + +## ILegendScrollbar + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type ILegendScrollbar = { + type: 'scrollbar'; + railStyle?: Omit>, 'width' | 'height'>; + sliderStyle?: Omit>, 'width' | 'height'>; +} & Omit; +``` + +相关定义：[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[LegendScrollbarAttributes](AdditionalTypes-Type-Definition.md#type-8dec8f9540ef) + + +## IPager + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type IPager = { + /** + * 文本样式配置 + */ + textStyle?: Partial>; + handler?: { + /** + * 按钮同文本内容区的间距，默认为 8 + */ + space?: number; + /** + * 上一页按钮形状 + */ + preShape?: string; + /** + * 下一页按钮形状 + */ + nextShape?: string; + style?: Omit, 'symbolType'>; + state?: { + /** + * hover 状态下的样式 + */ + hover?: Omit, 'symbolType'>; + /** + * 不可用状态样式 + */ + disable?: Omit, 'symbolType'>; + }; + }; + /** + * The layout of the pager. A callback is evaluated during layout after `maxRow` / `maxCol` + * have been resolved, allowing the pager handlers to adapt to a multi-row / multi-column legend. + * @since 2.2.0 + */ + layout?: LegendPagerLayout | ((ctx: IDiscreteLegendPagerCallbackContext) => LegendPagerLayout); + /** + * The cross-axis position of the pager. A callback is evaluated during layout after `maxRow` / + * `maxCol` have been resolved, allowing the pager alignment to adapt to the resolved page layout. + * @since 2.2.0 + */ + position?: LegendPagerPosition | ((ctx: IDiscreteLegendPagerCallbackContext) => LegendPagerPosition); +} & Omit; +``` + +相关定义：[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[LegendPagerLayout](AdditionalTypes-Type-Definition.md#type-a73f71981dd9)、[IDiscreteLegendPagerCallbackContext](AdditionalTypes-Type-Definition.md#type-c58e01a94725)、[LegendPagerPosition](AdditionalTypes-Type-Definition.md#type-f597fa365630)、[LegendPagerAttributes](AdditionalTypes-Type-Definition.md#type-833ac1fb317b) + + +## LegendItemStyle + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type LegendItemStyle = { + /** + * 样式配置 + */ + style?: T; + /** + * 状态样式配置 + */ + state?: { + /** + * 选中态 + */ + selected?: T; + /** + * 非选中态 + */ + unSelected?: T; + /** + * 选中态 hover + */ + selectedHover?: T; + /** + * 非选中态 hover + */ + unSelectedHover?: T; + }; +}; +``` + + +## LegendItemStyleValue + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type LegendItemStyleValue = + | T + | ((item: LegendItemDatum, isSelected: boolean, index: number, allItems: LegendItemDatum[]) => T); +``` + +相关定义：[LegendItemDatum](AdditionalTypes-Type-Definition.md#type-75bc5c7a36bf) + + +## LegendPagerLayout + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type LegendPagerLayout = 'horizontal' | 'vertical'; +``` + + +## LegendPagerPosition + +来源：`packages/vchart/src/component/legend/discrete/interface.ts`，VChart 2.1.7 + +```typescript +export type LegendPagerPosition = 'start' | 'middle' | 'end'; +``` + + +## ILegend + +来源：`packages/vchart/src/component/legend/interface.ts`，VChart 2.1.7 + +```typescript +export type ILegend = IComponent & { + getLegendData: () => Datum[]; + getSelectedData: () => StringOrNumber[]; + setSelectedData: (d: StringOrNumber[]) => void; +}; +``` + +相关定义：[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## ILegendCommonSpec + +来源：`packages/vchart/src/component/legend/interface.ts`，VChart 2.1.7 + +```typescript +export type ILegendCommonSpec = { + /** + * 是否显示图例 + * @default true + */ + visible?: boolean; + /** + * 图例的位置，相对于region区域的四个方位， + * left - 图例在左侧 + * right - 图例在右侧 + * top - 图例在上方 + * bottom - 图例在下方 + * @default 'left' + */ + orient?: IOrientType; + /** + * 图例在当前行或者列的对齐方式，起始 | 居中 | 末尾， + * 对于orient为'left'或者'right'的图例， + * start - 图例在左侧 + * middle - 图例居中 + * end - 图例在右侧 + * 对于orient为'top'或者'bottom'的图例， + * start - 图例在上方 + * middle - 图例居中 + * end - 图例在下方 + * @default 'middle' + */ + position?: 'start' | 'middle' | 'end'; + /** + * 图例组件的布局配置，默认自动跟随显示位置进行调整。 + * 1. `orient` 为 'top' 或者 'bottom' 时，默认为 'horizontal' 水平布局 + * 2. `orient` 为 'left' 或者 'right' 时，默认为 'vertical' 垂直布局 + */ + layout?: 'horizontal' | 'vertical'; + + /** + * 是否进行数据筛选，默认为 true + */ + filter?: boolean; + /** + * 自定义筛选函数 + * @since 1.13.1 + * @param data 当前数据 + * @param selectedRange 选中的数据范围 + * @param datumField 筛选数据对应的字段 + * @returns 最终展示的数据 + */ + customFilter?: (data: any, selectedRange: StringOrNumber[], datumField: string) => any; + + /** + * 图例标题配置 + */ + title?: ITitle; + + /** + * 图例背景配置 + */ + background?: { + /** + * 是否绘制背景层 + */ + visible?: boolean; + /** + * 背景内边距 + */ + padding?: IPadding | number | number[]; + /** + * 背景层样式 + */ + style?: Omit, 'visible' | 'width' | 'height'>; + }; + /** + * 是否允许交互 + * @default true + */ + interactive?: boolean; +} & Omit; +``` + +相关定义：[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[ITitle](AdditionalTypes-Type-Definition.md#type-22ab2af9147f)、[IPadding](IPadding-Type-Definition.md)、[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IComponentSpec](AdditionalTypes-Type-Definition.md#type-d23c51c12154) + + +## ITitle + +来源：`packages/vchart/src/component/legend/interface.ts`，VChart 2.1.7 + +```typescript +export type ITitle = { + /** 标题文本样式 */ + textStyle?: NoVisibleMarkStyle; + /** + * @deprecated 请使用 textStyle 配置文本样式 + */ + style?: NoVisibleMarkStyle; + /** 文本前 mark 图元 */ + shape?: { + /** + * 是否展示 shape + */ + visible?: boolean; + /** + * shape 同 文本的间距 + */ + space?: number; + style?: NoVisibleMarkStyle; + }; + /** + * 标题的背景面板配置 + */ + background?: { + /** + * 是否绘制背景层 + */ + visible?: boolean; + /** + * 背景层样式 + */ + style?: Omit, 'visible' | 'width' | 'height'>; + }; +} & Omit; +``` + +相关定义：[NoVisibleMarkStyle](AdditionalTypes-Type-Definition.md#type-bf107a034542)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[LegendTitle](AdditionalTypes-Type-Definition.md#type-c8f27ac5183b) + + +## NoVisibleMarkStyle + +来源：`packages/vchart/src/component/legend/interface.ts`，VChart 2.1.7 + +```typescript +export type NoVisibleMarkStyle = Omit; +``` + + +## IAggrType + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IAggrType = 'sum' | 'average' | 'min' | 'max' | 'variance' | 'standardDeviation' | 'median'; +``` + + +## IDataPointSpec + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IDataPointSpec = { + /** + * 数据字段配置 + */ + [key: string]: IDataPos | IDataPosCallback; + /** + * 具体某个数据元素关联的series序号（仅在标注目标：数据元素下有效） + */ + refRelativeSeriesIndex?: number; + /** + * 具体某个数据元素关联的series 的id（仅在标注目标：数据元素下有效） + */ + refRelativeSeriesId?: StringOrNumber; + /** + * 指定使用 xField 上的那个维度索引，因为 xField 字段有可能会包含多个维度，比如分组场景 + * @default 0 + * @since 1.7.0 + */ + xFieldIndex?: number; + /** + * 指定使用 xField 上的维度名称，因为 xField 字段有可能会包含多个维度，比如分组场景。 + * `xFieldIndex` 和 `xFieldDim` 声明一个即可，同时声明则 `xFieldDim` 优先级更高。 + * @since 1.7.0 + */ + xFieldDim?: string; + /** + * 指定使用 yField 上的那个维度索引，因为 yField 字段有可能会包含多个维度，比如分组场景。 + * @default 0 + * @since 1.7.0 + */ + yFieldIndex?: number; + /** + * 指定使用 yField 上的维度名称，因为 yField 字段有可能会包含多个维度，比如分组场景。 + * `yFieldIndex` 和 `yFieldDim` 声明一个即可，同时声明则 `yFieldDim` 优先级更高。 + * @since 1.7.0 + */ + yFieldDim?: string; + /** + * 指定使用 angleField 上的那个维度索引，因为 angleField 字段有可能会包含多个维度，比如分组场景 + * @default 0 + * @since 1.11.0 + */ + angleFieldIndex?: number; + /** + * 指定使用 angleField 上的维度名称，因为 angleField 字段有可能会包含多个维度，比如分组场景。 + * `angleFieldIndex` 和 `angleFieldDim` 声明一个即可，同时声明则 `angleFieldDim` 优先级更高。 + * @since 1.11.0 + */ + angleFieldDim?: string; + /** + * 指定使用 radiusField 上的那个维度索引，因为 radiusField 字段有可能会包含多个维度，比如分组场景 + * @default 0 + * @since 1.11.0 + */ + radiusFieldIndex?: number; + /** + * 指定使用 radiusField 上的维度名称，因为 radiusField 字段有可能会包含多个维度，比如分组场景。 + * `radiusFieldIndex` 和 `radiusFieldDim` 声明一个即可，同时声明则 `radiusFieldDim` 优先级更高。 + * @since 1.11.0 + */ + radiusFieldDim?: string; +}; +``` + +相关定义：[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IDataPos + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IDataPos = StringOrNumber | IAggrType; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IAggrType](AdditionalTypes-Type-Definition.md#type-952d359c9b51) + + +## IDataPosCallback + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IDataPosCallback = ( + relativeSeriesData: Datum[], + startRelativeSeriesData: Datum[], + endRelativeSeriesData: Datum[], + relativeSeries: IMarkerSupportSeries, + startRelativeSeries: IMarkerSupportSeries, + endRelativeSeries: IMarkerSupportSeries +) => StringOrNumber; +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-8cb45fc9b0d9)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IMarkerAttributeContext + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerAttributeContext = { + vchart: IVChart; + relativeSeries: IMarkerSupportSeries; + startRelativeSeries: IMarkerSupportSeries; + endRelativeSeries: IMarkerSupportSeries; +}; +``` + +相关定义：[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723) + + +## IMarkerCrossSeriesSpec + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMarkerCrossSeriesSpec { + /** + * 设置起点关联的系列，设置该系列的序号（仅在标注目标：坐标空间下有效） + */ + startRelativeSeriesIndex?: number; + /** + * 设置终点关联的系列，设置该序列的序号（仅在标注目标：坐标空间下有效） + */ + endRelativeSeriesIndex?: number; + /** + * 设置起点关联的系列，设置该系列的id（仅在标注目标：坐标空间下有效） + */ + startRelativeSeriesId?: string; + /** + * 设置终点关联的系列，设置该序列的id（仅在标注目标：坐标空间下有效） + */ + endRelativeSeriesId?: string; + /** + * 数据处理需要单独关联系列, 设置序列的序号来进行关联，当配置为'all'时代表关联当前region下所有系列 + * @since 1.11.0 + */ + specifiedDataSeriesIndex?: 'all' | number | number[]; + /** + * 数据处理需要单独关联系列, 设置序列的id来进行关联，当配置为'all'时代表关联当前region下所有系列 + * @since 1.11.0 + */ + specifiedDataSeriesId?: 'all' | string | string[]; +} +``` + + +## IMarkerLabelSpec + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerLabelSpec = IMarkerLabelWithoutRefSpec & IMarkerRef; +``` + +相关定义：[IMarkerLabelWithoutRefSpec](AdditionalTypes-Type-Definition.md#type-253fe6ea4b96)、[IMarkerRef](AdditionalTypes-Type-Definition.md#type-542373c2f97e) + + +## IMarkerLabelWithoutRefSpec + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerLabelWithoutRefSpec = { + /** + * 是否展示标注标签 + */ + visible?: boolean; + /** + * label整体 - 是否自动旋转 + */ + autoRotate?: boolean; + /** + * label整体 - 最小宽度，像素值 + * @default 30 + */ + minWidth?: number; + /** + * label整体 - 最大宽度，像素值。当文字超过最大宽度时，会自动省略。 + */ + maxWidth?: number; + /** + * label整体 - 背景面板配置 + */ + labelBackground?: { + /** + * 标签背景是否显示，是否可见 + */ + visible?: boolean; + /** + * 标签背景支持自定义path + * @since 1.11.10 + */ + customShape?: ( + text: ITextGraphicAttribute | IRichTextGraphicAttribute, + attrs: Partial, + path: ICustomPath2D + ) => ICustomPath2D; + /** + * 内部边距 + */ + padding?: IPadding | number[] | number; + } & Partial>>; + + /** + * @deprecated + * 设置文本类型为富文本或者普通文本，已废弃 + **/ + type?: 'rich' | 'text'; + /** + * 文本内容，如果需要进行换行，则使用数组形式，如 ['abc', '123'] + * 支持富文本内容 textConfig，设置富文本时要配置 textType 类型为 'rich' + */ + text?: string | string[] | number | number[] | ReturnType>; + /** + * label文本 - 文本格式化 + * @param markData 组成标注的数据 + * @param seriesData 标注关联的数据 + * @returns 格式化后的文本 + */ + formatMethod?: IFormatMethod<[markData: Datum[], seriesData: Datum[]]>; + + /** + * label文本 - 文本前 mark 图元 + */ + shape?: { + /** + * 是否显示标签文本前的图形 + */ + visible?: boolean; + /** + * 标签文本前的图形对应的样式设置 + */ + style: Omit; + }; + /** + * label文本 - shape 同文本之间的间距 + */ + space?: number; + + /** + * 是否自动调整 label 使其展示在 marker 可见区域内。 + * @default false + * @since 1.4.0 + */ + confine?: boolean; + /** + * 水平方向的偏移 + */ + dx?: number; + /** + * 垂直方向的偏移 + */ + dy?: number; +} & Partial>>; +``` + +相关定义：[ITextGraphicAttribute](AdditionalTypes-Type-Definition.md#type-36d5f8ea422d)、[IRichTextGraphicAttribute](AdditionalTypes-Type-Definition.md#type-e3b4c4057a4f)、[IGraphicAttribute](AdditionalTypes-Type-Definition.md#type-463cf72553ce)、[ICustomPath2D](AdditionalTypes-Type-Definition.md#type-68cc5b53deb9)、[IPadding](AdditionalTypes-Type-Definition.md#type-698f5ded9c9f)、[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IRichTextFormatMethod](AdditionalTypes-Type-Definition.md#type-3b28c6257cf4)、[IFormatMethod](AdditionalTypes-Type-Definition.md#type-6375b3333257)、[Datum](AdditionalTypes-Type-Definition.md#type-8cb45fc9b0d9)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IComposedTextMarkSpec](AdditionalTypes-Type-Definition.md#type-3cdc9715d892) + + +## IMarkerPositionsSpec + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerPositionsSpec = { + /** + * 画布坐标 + * `positions` 自 1.12.0 版本开始支持回调函数 + */ + positions: + | MarkerPositionPoint[] + | ((seriesData: Datum[], relativeSeries: IMarkerSupportSeries) => MarkerPositionPoint[]); + /** + * 是否为相对 region 的坐标，默认为 false，即相对画布的坐标 + * @default false + * @since 1.7.0 + */ + regionRelative?: boolean; +}; +``` + +相关定义：[MarkerPositionPoint](AdditionalTypes-Type-Definition.md#type-99fde6736e73)、[Datum](AdditionalTypes-Type-Definition.md#type-8cb45fc9b0d9)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723) + + +## IMarkerRef + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMarkerRef { + /** + * label or symbol 相对line平行方向上的偏移 + */ + refX?: number; + /** + * label or symbol 相对line正交方向上的偏移 + */ + refY?: number; + /** + * label or symbol 相对默认角度的偏移 （label跟随line的角度做自动旋转时，默认按照line的平行向量作为初始角度） + */ + refAngle?: number; +} +``` + + +## IMarkerState + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerState = { + /** 默认样式设置 */ + style?: T | MarkerStyleCallback; + /** 不同状态下的样式配置 */ + state?: Record>; +}; +``` + +相关定义：[MarkerStyleCallback](AdditionalTypes-Type-Definition.md#type-88db8cbea942)、[MarkerStateValue](AdditionalTypes-Type-Definition.md#type-c42b3a87f060)、[MarkerStateCallback](AdditionalTypes-Type-Definition.md#type-6718d706fea0) + + +## IMarkerSupportSeries + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerSupportSeries = ICartesianSeries | IPolarSeries | IGeoSeries; +``` + +相关定义：[ICartesianSeries](AdditionalTypes-Type-Definition.md#type-80c7ff644ee5)、[IPolarSeries](AdditionalTypes-Type-Definition.md#type-6c82e34ce6af)、[IGeoSeries](AdditionalTypes-Type-Definition.md#type-7f5ce0113c45) + + +## IMarkerSymbol + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type IMarkerSymbol = IMarkerRef & { + /** 是否展示 symbol */ + visible: boolean; + /** + * symbol 形状，默认为带左右方向的箭头 + */ + symbolType?: SymbolType; + /** + * symbol 大小 + */ + size?: number; +} & Partial>>; +``` + +相关定义：[IMarkerRef](AdditionalTypes-Type-Definition.md#type-542373c2f97e)、[SymbolType](AdditionalTypes-Type-Definition.md#type-4dccce8cd4d7)、[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md) + + +## MarkerPositionPoint + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type MarkerPositionPoint = { + /** + * x 坐标位置，number 类型表示像素值，string 类型表示相对画布宽度或者 region 宽度的占比（从左往右） + */ + x: StringOrNumber; + /** + * y 坐标位置，number 类型表示像素值，string 类型表示相对画布高度或者 region 高度的占比（从上至下） + */ + y: StringOrNumber; +}; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## MarkerStateCallback + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type MarkerStateCallback = ( + /** + * markerData 标注组件聚合后的数据 + */ + markerData: DataView, + /** + * @since 1.13.0 + * context 组件上下文, 包括相对系列，起始相对系列，结束相对系列和图表实例 + */ + context: IMarkerAttributeContext +) => T; +``` + +相关定义：[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[IMarkerAttributeContext](AdditionalTypes-Type-Definition.md#type-2598f79dce37) + + +## MarkerStateValue + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type MarkerStateValue = + | 'hover' + | 'hover_reverse' + | 'dimension_hover' + | 'dimension_hover_reverse' + | 'selected' + | 'selected_reverse'; +``` + + +## MarkerStyleCallback + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type MarkerStyleCallback = ( + /** + * markerData 标注组件聚合后的数据 + */ + markerData: DataView, + /** + * @since 1.13.0 + * context 组件上下文, 包括相对系列，起始相对系列，结束相对系列和图表实例 + */ + context: IMarkerAttributeContext +) => T; +``` + +相关定义：[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[IMarkerAttributeContext](AdditionalTypes-Type-Definition.md#type-2598f79dce37) + + +## OffsetPoint + +来源：`packages/vchart/src/component/marker/interface.ts`，VChart 2.1.7 + +```typescript +export type OffsetPoint = { + /** + * x 方向的偏移 + * 1. number 类型表示像素值，如 12 + * 2. string 类型表示百分比，如 '10%' 表示相对于所在 region 宽度的占比 + */ + x?: number | string; + /** + * y 方向的偏移 + * 1. number 类型表示像素值，如 12 + * 2. string 类型表示百分比，如 '10%' 表示相对于所在 region 高度的占比 + */ + y?: number | string; +}; +``` + + +## IMarkAreaAngleRadiusSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaAngleRadiusSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, angle 轴上位置，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, angle 轴上位置，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle1: IDataPos | IDataPosCallback; + /** + * 极坐标系下, radius 轴上位置， 或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; + /** + * 极坐标系下, radius 轴上位置， 或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkAreaAngleSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaAngleSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, angle 轴上位置，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, angle 轴上位置，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkAreaCoordinateSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkAreaCoordinateSpec = { + /** + * 指定数据点的参考线。基于指定数据点进行参考线的绘制，可以对数据点进行数据处理 + * `coordinates` 自 1.12.0 版本开始支持回调函数 + */ + coordinates: IDataPointSpec[] | ((seriesData: Datum[], relativeSeries: IMarkerSupportSeries) => IDataPointSpec[]); + + /** + * 对每个数据点转化后的画布坐标点进行偏移，该偏移值可以是像素值，也可以是 string 类型，如 '20%' 代表百分比 + * 每个元素对应一个坐标点的偏移量 + * @since 1.7.3 + */ + coordinatesOffset?: OffsetPoint[]; +}; +``` + +相关定义：[IDataPointSpec](AdditionalTypes-Type-Definition.md#type-f2db44670f10)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723)、[OffsetPoint](AdditionalTypes-Type-Definition.md#type-7815e4367a31) + + +## IMarkAreaRadiusSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaRadiusSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, radius 轴上位置， 或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; + /** + * 极坐标系下, radius 轴上位置， 或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkAreaXSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaXSpec extends IMarkerCrossSeriesSpec { + /** + * x轴上的参考线。可以配置参考线在x轴上的值，或者聚合计算类型 + * 可以将 x 配置为 '15%' 百分比的形式，用于表示将 x 绘制在 marker 所在 region 横轴（从左往右）的百分之 15 位置处 + */ + x: IDataPos | IDataPosCallback; + /** + * 设置x轴上的第二个值，如果同时设置了x 和 x1，会形成一个范围 + */ + x1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkAreaXYSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaXYSpec extends IMarkerCrossSeriesSpec { + /** + * x轴上的参考线。可以配置参考线在x轴上的值，或者聚合计算类型 + * 可以将 x 配置为 '15%' 百分比的形式，用于表示将 x 绘制在 marker 所在 region 横轴（从左往右）的百分之 15 位置处 + */ + x: IDataPos | IDataPosCallback; + /** + * 设置x轴上的第二个值，如果同时设置了x 和 x1，会形成一个范围 + */ + x1: IDataPos | IDataPosCallback; + /** + * y轴上的参考线。可以配置参考线在y轴上的值，或者聚合计算类型 + * 可以将 y 配置为 '15%' 百分比的形式，用于表示将 y 绘制在 marker 所在 region 纵轴（从上到下）的百分之 15 位置处 + */ + y: IDataPos | IDataPosCallback; + /** + * 设置y轴上的第二个值，如果同时设置了y 和 y1，会形成一个范围 + */ + y1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkAreaYSpec + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaYSpec extends IMarkerCrossSeriesSpec { + /** + * y轴上的参考线。可以配置参考线在y轴上的值，或者聚合计算类型 + * 可以将 y 配置为 '15%' 百分比的形式，用于表示将 y 绘制在 marker 所在 region 纵轴（从上到下）的百分之 15 位置处 + */ + y: IDataPos | IDataPosCallback; + /** + * 设置y轴上的第二个值，如果同时设置了y 和 y1，会形成一个范围 + */ + y1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IRegressType + +来源：`packages/vchart/src/component/marker/mark-area/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IRegressType = 'regression'; +``` + + +## IMarkAreaLabel + +来源：`packages/vchart/src/component/marker/mark-area/interface/theme.ts`，VChart 2.1.7 + +```typescript +export type IMarkAreaLabel = { + /** + * label整体 - 相对line的位置 + */ + position?: keyof typeof IMarkAreaLabelPosition | IMarkCommonArcLabelPosition; +} & IMarkerLabelWithoutRefSpec; +``` + +相关定义：[IMarkAreaLabelPosition](AdditionalTypes-Type-Definition.md#type-a1709a28c988)、[IMarkCommonArcLabelPosition](AdditionalTypes-Type-Definition.md#type-9a828f1ac3c0)、[IMarkerLabelWithoutRefSpec](AdditionalTypes-Type-Definition.md#type-253fe6ea4b96) + + +## IMarkAreaTheme + +来源：`packages/vchart/src/component/marker/mark-area/interface/theme.ts`，VChart 2.1.7 + +```typescript +export interface IMarkAreaTheme { + /** + * 标记区域的样式 + */ + area?: Partial>; + /** + * 标记区域的标签样式配置。 + * 自 1.13.9 版本开始，支持创建多个标签 + */ + label?: IMarkAreaLabel | IMarkAreaLabel[]; +} +``` + +相关定义：[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[IPolygonMarkSpec](IPolygonMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IMarkAreaLabel](AdditionalTypes-Type-Definition.md#type-4079709b8a02) + + +## IMarkLineAngleSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineAngleSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineAngRadRad1Spec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineAngRadRad1Spec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineAngRadSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineAngRadSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle1: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineCoordinateSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkLineCoordinateSpec = { + /** + * 指定数据点的参考线。基于指定数据点进行参考线的绘制，可以对数据点进行数据处理 + * `coordinates` 自 1.12.0 版本开始支持回调函数 + */ + coordinates: IDataPointSpec[] | ((seriesData: Datum[], relativeSeries: IMarkerSupportSeries) => IDataPointSpec[]); + /** + * 对每个数据点转化后的画布坐标点进行偏移，该偏移值可以是像素值，也可以是 string 类型，如 '20%' 代表百分比 + * 每个元素对应一个坐标点的偏移量 + * @since 1.7.3 + */ + coordinatesOffset?: OffsetPoint[]; + /** + * 数据点的处理方法。 如果不配置则按照coordinate数组直接连接成line。 + */ + process?: + | { + x: IAggrType; + } + | { + y: IAggrType; + } + | { + xy: IRegressType; // FIXME: xy属性名称不太合理，可能需调整 + }; +}; +``` + +相关定义：[IDataPointSpec](AdditionalTypes-Type-Definition.md#type-f2db44670f10)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723)、[OffsetPoint](AdditionalTypes-Type-Definition.md#type-7815e4367a31)、[IAggrType](AdditionalTypes-Type-Definition.md#type-952d359c9b51)、[IRegressType](AdditionalTypes-Type-Definition.md#type-0d292ecf19f3) + + +## IMarkLineRadAngAng1Spec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineRadAngAng1Spec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle1: IDataPos | IDataPosCallback; + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineRadiusSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineRadiusSpec extends IMarkerCrossSeriesSpec { + /** + * 极坐标系下, 参考线在 radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineXSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineXSpec extends IMarkerCrossSeriesSpec { + /** + * 单独声明 x 属性，可以绘制一条贯穿 y 轴的标注线 + * x 轴上的参考线。可以配置参考线在 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，用于表示将 x 绘制在 marker 所在 region 横轴（从左往右）的百分之 15 位置处。 + */ + x: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineXYSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineXYSpec extends IMarkerCrossSeriesSpec { + /** + * 参考线起始点在 x 轴上位置，可以配置参考线在 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + */ + x: IDataPos | IDataPosCallback; + /** + * 该参考线起始点在 y 轴的起点位置，可以配置 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + */ + y: IDataPos | IDataPosCallback; + /** + * 该参考线终点在 x 轴的终点位置，可以配置 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + * @since 1.7.3 + */ + x1: IDataPos | IDataPosCallback; + /** + * 该参考线终点在 y 轴的终点位置，可以配置 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + * @since 1.7.3 + */ + y1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineXYY1Spec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineXYY1Spec extends IMarkerCrossSeriesSpec { + /** + * 参考线在 x 轴上位置，可以配置参考线在 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + */ + x: IDataPos | IDataPosCallback; + /** + * 该参考线在 y 轴的起点位置，可以配置 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + */ + y: IDataPos | IDataPosCallback; + /** + * 该参考线在 y 轴的终点位置，可以配置 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + * @since 1.7.3 + */ + y1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineYSpec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineYSpec extends IMarkerCrossSeriesSpec { + /** + * 单独声明 y 属性，可以绘制一条贯穿 x 轴的标注线 + * y轴上的参考线。可以配置参考线在y轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算 + * 可以将 y 配置为 '15%' 百分比的形式，用于表示将 x 绘制在 marker 所在 region 纵轴（从上到下）的百分之 15 位置处 + */ + y: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineYXX1Spec + +来源：`packages/vchart/src/component/marker/mark-line/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineYXX1Spec extends IMarkerCrossSeriesSpec { + /** + * 参考线在 y 轴上位置，可以配置参考线在 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + */ + y: IDataPos | IDataPosCallback; + /** + * 该参考线在 x 轴的起点位置，可以配置 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + */ + x: IDataPos | IDataPosCallback; + /** + * 该参考线在 x 轴的终点位置，可以配置 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + * @since 1.7.3 + */ + x1: IDataPos | IDataPosCallback; +} +``` + +相关定义：[IMarkerCrossSeriesSpec](AdditionalTypes-Type-Definition.md#type-88cab1c9cdbd)、[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkLineLabel + +来源：`packages/vchart/src/component/marker/mark-line/interface/theme.ts`，VChart 2.1.7 + +```typescript +export type IMarkLineLabel = { + /** + * label整体 - 相对line的位置 + */ + position?: keyof typeof IMarkLineLabelPosition | IMarkCommonArcLabelPosition; +} & IMarkerLabelSpec; +``` + +相关定义：[IMarkLineLabelPosition](AdditionalTypes-Type-Definition.md#type-5be4f671bfe4)、[IMarkCommonArcLabelPosition](AdditionalTypes-Type-Definition.md#type-9a828f1ac3c0)、[IMarkerLabelSpec](AdditionalTypes-Type-Definition.md#type-2d979381ccd7) + + +## IMarkLineTheme + +来源：`packages/vchart/src/component/marker/mark-line/interface/theme.ts`，VChart 2.1.7 + +```typescript +export interface IMarkLineTheme { + /** + * 标注线的线样式 + */ + line?: Partial>; + /** + * 标注线的标签样式。 + * 自 1.13.9 版本开始，支持创建多个标签。 + */ + label?: IMarkLineLabel | IMarkLineLabel[]; + + /** + * 线标注起点symbol样式 + */ + startSymbol?: IMarkerSymbol; + /** + * 线标注终点symbol样式 + */ + endSymbol?: IMarkerSymbol; +} +``` + +相关定义：[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IMarkLineLabel](AdditionalTypes-Type-Definition.md#type-e04a2517c735)、[IMarkerSymbol](AdditionalTypes-Type-Definition.md#type-3acb04a4042d) + + +## IMarkPointAngleRadiusSpec + +来源：`packages/vchart/src/component/marker/mark-point/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkPointAngleRadiusSpec = { + /** + * 极坐标系下, angle 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + angle: IDataPos | IDataPosCallback; + /** + * 极坐标系下, radius 轴上位置，可以配置参考线在 angle 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * @since 1.11.0 + */ + radius: IDataPos | IDataPosCallback; +}; +``` + +相关定义：[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkPointCoordinateSpec + +来源：`packages/vchart/src/component/marker/mark-point/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkPointCoordinateSpec = { + /** + * 指定数据点的参考线。基于指定数据点进行参考线的绘制，可以对数据点进行数据处理 + * `coordinate` 自 1.12.0 版本开始支持回调函数 + */ + coordinate: IDataPointSpec | ((seriesData: Datum[], relativeSeries: IMarkerSupportSeries) => IDataPointSpec); + /** + * 对每个数据点转化后的画布坐标点进行偏移，该偏移值可以是像素值，也可以是 string 类型，如 '20%' 代表百分比 + * 每个元素对应一个坐标点的偏移量 + * @since 1.7.3 + */ + coordinatesOffset?: OffsetPoint; +}; +``` + +相关定义：[IDataPointSpec](AdditionalTypes-Type-Definition.md#type-f2db44670f10)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723)、[OffsetPoint](AdditionalTypes-Type-Definition.md#type-7815e4367a31) + + +## IMarkPointGeoNameSpec + +来源：`packages/vchart/src/component/marker/mark-point/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkPointGeoNameSpec = { + /** + * 地理坐标系下, 地理区域的名称。 + * @since 1.11.0 + */ + areaName: string | IDataPosCallback; +}; +``` + +相关定义：[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IMarkPointPositionsSpec + +来源：`packages/vchart/src/component/marker/mark-point/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkPointPositionsSpec = { + /** + * `position` 自 1.12.0 版本开始支持回调函数 + */ + position: MarkerPositionPoint | ((seriesData: Datum[], relativeSeries: IMarkerSupportSeries) => MarkerPositionPoint); + /** + * 是否为相对 region 的坐标，默认为 false，即相对画布的坐标 + * @default false + * @since 1.7.0 + */ + regionRelative?: boolean; +}; +``` + +相关定义：[MarkerPositionPoint](AdditionalTypes-Type-Definition.md#type-99fde6736e73)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IMarkerSupportSeries](AdditionalTypes-Type-Definition.md#type-cee3d7685723) + + +## IMarkPointXYSpec + +来源：`packages/vchart/src/component/marker/mark-point/interface/spec.ts`，VChart 2.1.7 + +```typescript +export type IMarkPointXYSpec = { + /** + * 参考点在 y 轴上位置，可以配置参考线在 y 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 y 配置为 '15%' 百分比的形式，表示该位置位于 region 纵轴（从上到下）的百分之 15 位置处。 + */ + y: IDataPos | IDataPosCallback; + /** + * 参考点在 x 轴的起点位置，可以配置 x 轴上的值，或者聚合计算类型，或者以回调的形式通过数据自行计算。 + * 可以将 x 配置为 '15%' 百分比的形式，表示该位置位于 region 横轴（从左往右）的百分之 15 位置处。 + */ + x: IDataPos | IDataPosCallback; +}; +``` + +相关定义：[IDataPos](AdditionalTypes-Type-Definition.md#type-4e110ff2986a)、[IDataPosCallback](AdditionalTypes-Type-Definition.md#type-1379fa4fc2bc) + + +## IItemContent + +来源：`packages/vchart/src/component/marker/mark-point/interface/theme.ts`，VChart 2.1.7 + +```typescript +export interface IItemContent extends IMarkerRef { + /** + * 标注内容相对于定位点的位置 + */ + position?: keyof typeof IMarkPointItemPosition; + /** + * x 方向偏移量 + */ + offsetX?: number | 'regionRight' | 'regionLeft' | IOffsetCallback; + /** + * y 方向偏移量 + */ + offsetY?: number | 'regionTop' | 'regionBottom' | IOffsetCallback; + /** + * 是否自动调整 item content 使其展示在 marker 可见区域内。 + * @default false + * @since 1.8.7 + */ + confine?: boolean; + + /** + * 标注类型 + */ + // richText 和 text + rich的功能有重叠, 所以去掉richText的配置 + // 为了兼容老配置, 会把用户配的richText转化成text + rich的形式 + // type?: 'symbol' | 'text' | 'image' | 'richText'; + type?: 'symbol' | 'text' | 'image' | 'custom'; + + /** + * 标注内容的样式及状态 等价于 symbol | image | text | richText | customMark + * @since 2.0.0 + */ + style?: IItemContentStyle | MarkerStyleCallback | IMarkerLabelSpec; + state?: Record>; + + // 老写法, 先保留 + /** + * type为symbol时, symbol的样式 + */ + symbol?: Partial>; + /** + * type为image时, image的样式 + */ + image?: Partial>; + /** + * type为text时, text的样式 + * 'text'类型的ItemContent新增三种子类型：'text','rich'。配置在textStyle.type上。 + */ + text?: IMarkerLabelSpec; + /** + * type为rich text时, rich text的样式 + */ + richText?: Partial>; + /** + * type为custom时, customMark的样式(目前仅在mapLabel内部逻辑中使用到) + */ + customMark?: Partial>; +} +``` + +相关定义：[IMarkerRef](AdditionalTypes-Type-Definition.md#type-542373c2f97e)、[IMarkPointItemPosition](AdditionalTypes-Type-Definition.md#type-39230de2ade7)、[IOffsetCallback](AdditionalTypes-Type-Definition.md#type-db4f6fc17505)、[IItemContentStyle](AdditionalTypes-Type-Definition.md#type-364c9501578d)、[MarkerStyleCallback](AdditionalTypes-Type-Definition.md#type-88db8cbea942)、[IMarkerLabelSpec](AdditionalTypes-Type-Definition.md#type-2d979381ccd7)、[MarkerStateValue](AdditionalTypes-Type-Definition.md#type-c42b3a87f060)、[MarkerStateCallback](AdditionalTypes-Type-Definition.md#type-6718d706fea0)、[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IImageGraphicAttribute](AdditionalTypes-Type-Definition.md#type-fcfc702de0ac)、[IRichTextGraphicAttribute](AdditionalTypes-Type-Definition.md#type-e3b4c4057a4f)、[IGroupGraphicAttribute](AdditionalTypes-Type-Definition.md#type-2f7220f7ffb4) + + +## IItemContentStyle + +来源：`packages/vchart/src/component/marker/mark-point/interface/theme.ts`，VChart 2.1.7 + +```typescript +export type IItemContentStyle = ISymbolMarkSpec | IImageGraphicAttribute | IGroupGraphicAttribute; +``` + +相关定义：[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IImageGraphicAttribute](AdditionalTypes-Type-Definition.md#type-fcfc702de0ac)、[IGroupGraphicAttribute](AdditionalTypes-Type-Definition.md#type-2f7220f7ffb4) + + +## IItemLine + +来源：`packages/vchart/src/component/marker/mark-point/interface/theme.ts`，VChart 2.1.7 + +```typescript +export type IItemLine = IMarkerSymbol> = { + /** TODO：'type-opo' */ + /** + * 引导线类型 + * 'type-s'表示起点和终点直接连线; 'type-do'表示包含一个折点，且折点x坐标为起点到终点的 1/2 x坐标，折点y坐标为起点y坐标；'type-op' 表示包含一个折点，且折点x坐标为起点x坐标，折点y坐标为终点y坐标；'type-po' 表示包含一个折点，且折点x坐标为终点x坐标，折点y坐标为起点y坐标 + * 引导线类型的具体形式参考：https://journals.sagepub.com/doi/10.1177/1473871618799500 + */ + type?: 'type-s' | 'type-do' | 'type-po' | 'type-op' | 'type-arc'; + /** + * 当type为type-arc时生效, 数值决定圆心到终点连线的偏移量, 绝对值越小, 曲率越大, 符号决定法向, 不能等于0 + * @since 1.11.1 + * @default 0.8 + */ + arcRatio?: number; + /** + * 引导线可见性 + */ + visible?: boolean; + /** + * 垂直于引导线的装饰线，参考案例: https://observablehq.com/@mikelotis/edmonton-population-history-line-chart + */ + decorativeLine?: { + /** + * 装饰线可见性 + */ + visible?: boolean; + /** + * 装饰线的长度 + */ + length?: number; + }; + /** + * 引导线起点symbol样式 + */ + startSymbol?: T; + /** + * 引导线终点symbol样式 + */ + endSymbol?: T; + /** + * 引导线样式 + */ + line?: Partial>>; +}; +``` + +相关定义：[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[IMarkerSymbol](AdditionalTypes-Type-Definition.md#type-3acb04a4042d) + + +## IMarkPointTheme + +来源：`packages/vchart/src/component/marker/mark-point/interface/theme.ts`，VChart 2.1.7 + +```typescript +export interface IMarkPointTheme = Partial> { + /** + * 标注引导线 + */ + itemLine?: IItemLine; + + /** + * 标注内容 + */ + itemContent?: IItemContent; + /** + * 被标注的内容 + * @since 1.11.1 + */ + targetSymbol?: { + /** + * 被标注内容与标记线间的间隙 + * @default 0 + */ + offset?: number; + /** + * 是否显示 + * @default false + */ + visible?: boolean; + /** + * 大小 + * @default 20 + */ + size?: number; + } & Partial>; +} +``` + +相关定义：[IItemLine](AdditionalTypes-Type-Definition.md#type-8dd1e2b302ff)、[IItemContent](AdditionalTypes-Type-Definition.md#type-8262891f07ed)、[IMarkerState](AdditionalTypes-Type-Definition.md#type-1839dc4b258a)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IMarkerSymbol](AdditionalTypes-Type-Definition.md#type-3acb04a4042d) + + +## IOffsetCallback + +来源：`packages/vchart/src/component/marker/mark-point/interface/theme.ts`，VChart 2.1.7 + +```typescript +export type IOffsetCallback = (region: IRegion) => number; +``` + +相关定义：[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24) + + +## ITitleSpecWithoutText + +来源：`packages/vchart/src/component/title/interface/spec.ts`，VChart 2.1.7 + +```typescript +interface ITitleSpecWithoutText extends Omit { + /** + * 是否显示标题 + */ + visible?: boolean; + /** + * Title位置 + * @default 'top' + */ + orient?: IOrientType; + /** + * 标题左上角x坐标像素值 + */ + x?: number; + /** + * 标题左上角y坐标像素值 + */ + y?: number; + /** + * 标题宽度，支持像素值、百分比与回调，百分比与回调的基准是图表视图区域 + */ + width?: ILayoutNumber; + /** + * 标题高度，支持像素值、百分比与回调，百分比与回调的基准是图表视图区域 + */ + height?: ILayoutNumber; + /** + * 最小宽度，支持像素值、百分比与回调 + */ + minWidth?: ILayoutNumber; + /** + * 最大宽度，支持像素值、百分比与回调。当文字超过最大宽度时，会自动省略。 + */ + maxWidth?: ILayoutNumber; + /** + * 最小高度，支持像素值、百分比与回调 + */ + minHeight?: ILayoutNumber; + /** + * 最大高度，支持像素值、百分比与回调。当文字超过最大高度时，会自动省略。 + */ + maxHeight?: ILayoutNumber; + /** + * 标题的边距留白 + */ + innerPadding?: IPadding | number | number[]; + /** + * 文字水平对齐方式 + * 'left' | 'center' | 'right' + */ + align?: string; + /** + * 文字垂直对齐方式 + * 'top' | 'middle' | 'bottom' + */ + verticalAlign?: string; + /** + * 主标题样式 + */ + textStyle?: { + /** + * 给主标题设置给定的宽度 + */ + width?: number; + /** + * 给主标题设置给定的高度 + */ + height?: number; + /** + * 文字水平对齐方式 + * 'left' | 'center' | 'right' + */ + align?: string; + /** + * 文字垂直对齐方式 + * 'top' | 'middle' | 'bottom' + */ + verticalAlign?: string; + /** + * 折行方式 + * 'break-word' | 'break-all' | 'keep-all' + */ + wordBreak?: ITextAttribute['wordBreak']; + /** + * 按照宽度限制自动折行或显示省略号(maxLineWidth) + * 默认设置为title宽度 + */ + maxLineWidth?: number; + /** + * 高度限制控制显示内容及省略号(heightLimit) + */ + heightLimit?: number; + /** + * 按照行数限制显示内容及省略号(lineClamp) + */ + lineClamp?: number; + /** + * 富文本配置（暂时保留旧设置） + * @deprecated use text & textType instead + */ + character?: IRichTextCharacter[]; + } & Partial; + /** + * 副标题样式 + */ + subtextStyle?: { + /** 指定宽度 */ + width?: number; + /** 指定高度 */ + height?: number; + /** + * 文字水平对齐方式 + * 'left' | 'center' | 'right' + */ + align?: string; + /** + * 文字垂直对齐方式 + * 'top' | 'middle' | 'bottom' + */ + verticalAlign?: string; + /** + * 折行方式 + * 'break-word' | 'break-all' | 'keep-all + */ + wordBreak?: ITextAttribute['wordBreak']; + /** + * 按照宽度限制自动折行或显示省略号(maxLineWidth) + * 默认设置为title宽度 + */ + maxLineWidth?: number; + /** + * 高度限制控制显示内容及省略号(heightLimit) + */ + heightLimit?: number; + /** + * 按照行数限制显示内容及省略号(lineClamp) + */ + lineClamp?: number; + /** + * 富文本配置（暂时保留旧设置） + * @deprecated use subtext & subtextType instead + */ + character?: IRichTextCharacter[]; + } & Partial; +} +``` + +相关定义：[IComponentSpec](AdditionalTypes-Type-Definition.md#type-d23c51c12154)、[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[ILayoutNumber](AdditionalTypes-Type-Definition.md#type-9638d3997297)、[IPadding](IPadding-Type-Definition.md)、[ITextAttribute](AdditionalTypes-Type-Definition.md#type-4ecb56643e01)、[IRichTextCharacter](AdditionalTypes-Type-Definition.md#type-a486d6a175fe)、[ITextGraphicAttribute](AdditionalTypes-Type-Definition.md#type-36d5f8ea422d) + + +## ITooltip + +来源：`packages/vchart/src/component/tooltip/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ITooltip extends IComponent { + tooltipHandler?: ITooltipHandler; + getVisible: () => boolean; + showTooltip: (datum: Datum, options: IShowTooltipOption) => void; + enable?: boolean; +} +``` + +相关定义：[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[ITooltipHandler](AdditionalTypes-Type-Definition.md#type-73b5fb837aea)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IShowTooltipOption](AdditionalTypes-Type-Definition.md#type-b4df769a6b46) + + +## TooltipHandlerParams + +来源：`packages/vchart/src/component/tooltip/interface/common.ts`，VChart 2.1.7 + +```typescript +export type TooltipHandlerParams = DimensionEventParams & { + /** 本次触发的 tooltip 是否只改变了位置 */ + changePositionOnly?: boolean; + /** tooltip 组件实例 */ + tooltip: ITooltip; + /** tooltip 原始的spec */ + tooltipSpec?: ITooltipSpec; + /** TODO: 本次触发的tooltip，主要包含pattern数据，待优化 */ + activeTooltipSpec?: ITooltipActual; + // Pick; + /** 和 datum 同组的数据项 */ + groupDatum?: Datum[]; +}; +``` + +相关定义：[DimensionEventParams](AdditionalTypes-Type-Definition.md#type-15e7376683b8)、[ITooltip](AdditionalTypes-Type-Definition.md#type-b713b3be426c)、[ITooltipSpec](ITooltipSpec-Type-Definition.md)、[ITooltipActual](AdditionalTypes-Type-Definition.md#type-b6803f56a729)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61) + + +## TooltipResult + +来源：`packages/vchart/src/component/tooltip/interface/common.ts`，VChart 2.1.7 + +```typescript +export const enum TooltipResult { + /** tooltip 显示成功 */ + success = 0, + /** tooltip 未成功显示 */ + failed = 1 +} +``` + + +## TooltipEventParams + +来源：`packages/vchart/src/component/tooltip/interface/event.ts`，VChart 2.1.7 + +```typescript +export type TooltipEventParams = TooltipHandlerParams & { + /** 触发的 tooltip 类型 */ + activeType?: TooltipActiveType; + /** tooltip 数据 */ + tooltipData?: TooltipData; + /** + * tooltip是否为空 + * @since 1.11.1 + */ + isEmptyTooltip?: boolean; +}; +``` + +相关定义：[TooltipHandlerParams](AdditionalTypes-Type-Definition.md#type-82517d84c2af)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[TooltipData](AdditionalTypes-Type-Definition.md#type-2020c8fc6cbe) + + +## ITooltipHandlerSpec + +来源：`packages/vchart/src/component/tooltip/interface/spec.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipHandlerSpec { + /** 显示 tooltip，可以选择返回是否遇到异常 */ + showTooltip: ( + activeType: TooltipActiveType, + tooltipData: TooltipData, + params: TooltipHandlerParams + ) => Maybe; + /** 隐藏 tooltip，可以选择返回是否遇到异常 */ + hideTooltip: (params: TooltipHandlerParams) => Maybe; + /** 释放 tooltip */ + release: () => void; + /** 可选，判断 tooltip 是否正在显示 */ + isTooltipShown?: () => boolean; +} +``` + +相关定义：[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[TooltipData](AdditionalTypes-Type-Definition.md#type-2020c8fc6cbe)、[TooltipHandlerParams](AdditionalTypes-Type-Definition.md#type-82517d84c2af)、[Maybe](AdditionalTypes-Type-Definition.md#type-644c0bc1509c)、[TooltipResult](AdditionalTypes-Type-Definition.md#type-34c5550c97cd) + + +## ITooltipTextTheme + +来源：`packages/vchart/src/component/tooltip/interface/theme.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipTextTheme { + /** + * 字体 + */ + fontFamily?: string; + /** + * 字体大小 + */ + fontSize?: number | ITokenKey; + /** + * 字体颜色 + */ + fill?: ColorType; + /** + * 字体颜色（兼容旧版本） + * @deprecated + */ + fontColor?: ColorType; + /** + * 字重 + */ + fontWeight?: StringOrNumber; + /** + * 对齐方式 + */ + textAlign?: TextAlign; + /** + * 字体基线 + */ + textBaseline?: TextBaseLine; + /** + * 行高 + */ + lineHeight?: number | string | ITokenKey; + /** + * 与相邻元素的水平间距 + */ + spacing?: number; + /** + * 是否支持换行 + */ + multiLine?: boolean; + /** + * 最大宽度 + */ + maxWidth?: number; + /** + * 换行模式，默认为'break-word' + */ + wordBreak?: ITextAttribute['wordBreak']; + /** + * 是否开启自动宽度。效果分为以下几种情况： + * - tooltip 标题：`autoWidth` 默认为 `false`。如果配置为 `true`，则 tooltip 标题会保持和 tooltip 内容一致的宽度 + * - tooltip key 标签：`autoWidth` 不适用 + * - tooltip value 标签：`autoWidth` 默认为 `true`。如果配置为 `true`，则 tooltip value 标签会自动占满 tooltip 整体宽度的剩余部分 + * @since 1.4.2 + */ + autoWidth?: boolean; +} +``` + +相关定义：[ITokenKey](AdditionalTypes-Type-Definition.md#type-cbbd743bf503)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[TextAlign](AdditionalTypes-Type-Definition.md#type-6b2c76bfb154)、[TextBaseLine](AdditionalTypes-Type-Definition.md#type-94a26edb6027)、[ITextAttribute](AdditionalTypes-Type-Definition.md#type-4ecb56643e01) + + +## ChartEvent + +来源：`packages/vchart/src/constant/event.ts`，VChart 2.1.7 + +```typescript +export enum ChartEvent { + initialized = 'initialized', // 图表实例初始化完成 + rendered = 'rendered', // 图表渲染方法被调用时触发，表明图表已经执行过渲染逻辑，只会触发一次 + renderFinished = 'renderFinished', // 每次画布渲染完成触发的事件，不包含动画结束 + animationFinished = 'animationFinished', // 图表动画结束时触发的事件 + // region + regionSeriesDataFilterOver = 'regionSeriesDataFilterOver', + // series start + // series.liftCircle + afterInitData = 'afterInitData', + afterInitEvent = 'afterInitEvent', + afterInitMark = 'afterInitMark', + // series.data + rawDataUpdate = 'rawDataUpdate', + viewDataFilterOver = 'viewDataFilterOver', + viewDataUpdate = 'viewDataUpdate', + viewDataStatisticsUpdate = 'viewDataStatisticsUpdate', + // dot series + markDeltaYUpdate = 'markDeltaYUpdate', + // pie series + viewDataLabelUpdate = 'viewDataLabelUpdate', + /** series end */ + // scale + scaleDomainUpdate = 'scaleDomainUpdate', + scaleRawDomainUpdate = 'scaleRawDomainUpdate', + scaleUpdate = 'scaleUpdate', + // datazoom + dataZoomChange = 'dataZoomChange', + // Hierarchy + drill = 'drill', + layoutStart = 'layoutStart', + layoutEnd = 'layoutEnd', + layoutRectUpdate = 'layoutRectUpdate', + + // player + playerPlay = 'playerPlay', + playerPause = 'playerPause', + playerEnd = 'playerEnd', + playerChange = 'playerChange', + playerForward = 'playerForward', + playerBackward = 'playerBackward', + // scrollBar + scrollBarChange = 'scrollBarChange', + // brush + brushStart = 'brushStart', + brushChange = 'brushChange', + brushEnd = 'brushEnd', + brushClear = 'brushClear', + brushActive = 'brushActive', + // legend + legendSelectedDataChange = 'legendSelectedDataChange', + legendFilter = 'legendFilter', + legendItemClick = 'legendItemClick', + legendItemHover = 'legendItemHover', + legendItemUnHover = 'legendItemUnHover', + // tooltip + tooltipShow = 'tooltipShow', + tooltipHide = 'tooltipHide', + tooltipRelease = 'tooltipRelease', + // resize + afterResize = 'afterResize', + afterRender = 'afterRender', + // layout + afterLayout = 'afterLayout', + afterMarkLayoutEnd = 'afterMarkLayoutEnd', + // wordcloud + afterWordcloudShapeDraw = 'afterWordcloudShapeDraw' +} +``` + + +## Event_Bubble_Level + +来源：`packages/vchart/src/constant/event.ts`，VChart 2.1.7 + +```typescript +export enum Event_Bubble_Level { + vchart = 'vchart', + chart = 'chart', + model = 'model', + mark = 'mark' +} +``` + + +## Event_Source_Type + +来源：`packages/vchart/src/constant/event.ts`，VChart 2.1.7 + +```typescript +export enum Event_Source_Type { + chart = 'chart', + window = 'window', + canvas = 'canvas' +} +``` + + +## HOOK_EVENT + +来源：`packages/vchart/src/constant/event.ts`，VChart 2.1.7 + +```typescript +export enum HOOK_EVENT { + BEFORE_EVALUATE_DATA = 'beforeEvaluateData', + AFTER_EVALUATE_DATA = 'afterEvaluateData', + + BEFORE_EVALUATE_SCALE = 'beforeEvaluateScale', + AFTER_EVALUATE_SCALE = 'afterEvaluateScale', + + BEFORE_PARSE_VIEW = 'beforeParseView', + AFTER_PARSE_VIEW = 'afterParseView', + + BEFORE_TRANSFORM = 'beforeTransform', + AFTER_TRANSFORM = 'afterTransform', + + BEFORE_CREATE_VRENDER_STAGE = 'beforeCreateVRenderStage', + AFTER_CREATE_VRENDER_STAGE = 'afterCreateVRenderStage', + + BEFORE_CREATE_VRENDER_LAYER = 'beforeCreateVRenderLayer', + AFTER_CREATE_VRENDER_LAYER = 'afterCreateVRenderLayer', + + BEFORE_STAGE_RESIZE = 'beforeStageResize', + AFTER_STAGE_RESIZE = 'afterStageResize', + + BEFORE_VRENDER_DRAW = 'beforeVRenderDraw', + AFTER_VRENDER_DRAW = 'afterVRenderDraw', + + BEFORE_MARK_JOIN = 'beforeMarkJoin', + AFTER_MARK_JOIN = 'afterMarkJoin', + BEFORE_MARK_UPDATE = 'beforeMarkUpdate', + AFTER_MARK_UPDATE = 'afterMarkUpdate', + BEFORE_MARK_STATE = 'beforeMarkState', + AFTER_MARK_STATE = 'afterMarkState', + BEFORE_MARK_ENCODE = 'beforeMarkEncode', + AFTER_MARK_ENCODE = 'afterMarkEncode', + + BEFORE_DO_LAYOUT = 'beforeDoLayout', + AFTER_DO_LAYOUT = 'afterDoLayout', + + BEFORE_MARK_LAYOUT_END = 'beforeMarkLayoutEnd', + AFTER_MARK_LAYOUT_END = 'afterMarkLayoutEnd', + + BEFORE_DO_RENDER = 'beforeDoRender', + AFTER_DO_RENDER = 'afterDoRender', + + BEFORE_MARK_RENDER_END = 'beforeMarkRenderEnd', + AFTER_MARK_RENDER_END = 'afterMarkRenderEnd', + + BEFORE_CREATE_VRENDER_MARK = 'beforeCreateVRenderMark', + AFTER_CREATE_VRENDER_MARK = 'afterCreateVRenderMark', + + BEFORE_ADD_VRENDER_MARK = 'beforeAddVRenderMark', + AFTER_ADD_VRENDER_MARK = 'afterAddVRenderMark', + + AFTER_VRENDER_NEXT_RENDER = 'afterVRenderNextRender', + + BEFORE_ELEMENT_UPDATE_DATA = 'beforeElementUpdateData', + AFTER_ELEMENT_UPDATE_DATA = 'afterElementUpdateData', + + BEFORE_ELEMENT_STATE = 'beforeElementState', + AFTER_ELEMENT_STATE = 'afterElementState', + + BEFORE_ELEMENT_ENCODE = 'beforeElementEncode', + AFTER_ELEMENT_ENCODE = 'afterElementEncode', + + ANIMATION_START = 'animationStart', + ANIMATION_END = 'animationEnd', + + ELEMENT_ANIMATION_START = 'elementAnimationStart', + ELEMENT_ANIMATION_END = 'elementAnimationEnd', + + ALL_ANIMATION_START = 'allAnimationStart', + ALL_ANIMATION_END = 'allAnimationEnd' +} +``` + + +## DataLinkAxis + +来源：`packages/vchart/src/core/interface.ts`，VChart 2.1.7 + +```typescript +export type DataLinkAxis = { + /** + * 关联的轴 id，目前仅支持直角坐标轴 + * the binding axis id + */ + axisId?: StringOrNumber; + /** + * 关联的轴索引，目前仅支持直角坐标轴 + * the binding axis index + */ + axisIndex?: number; +}; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## DataLinkSeries + +来源：`packages/vchart/src/core/interface.ts`，VChart 2.1.7 + +```typescript +export type DataLinkSeries = { + /** + * 关联的系列 id + * the binding series id + */ + seriesId?: StringOrNumber; + /** + * 关联的系列索引 + * the binding series index + */ + seriesIndex?: number; +}; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IVChart + +来源：`packages/vchart/src/core/interface.ts`，VChart 2.1.7 + +```typescript +export interface IVChart { + readonly id: number; + + /** + * **同步**渲染图表。 + * @param morphConfig 图表 morph 动画配置，可选 + * @returns VChart 实例 + */ + renderSync: (morphConfig?: IMorphConfig) => IVChart; + + /** + * **异步**渲染图表。 + * @async + * @param morphConfig 图表 morph 动画配置，可选 + * @returns VChart 实例 + */ + renderAsync: (morphConfig?: IMorphConfig) => Promise; + + /** + * **异步**更新数据。 + * @async + * @param id 数据 id + * @param data 数据值 + * @param options 数据参数 + * @returns VChart 实例 + */ + updateData: (id: StringOrNumber, data: Datum[] | string, options?: IParserOptions) => Promise; + + /** + * **异步**批量更新数据。 + * @async + * @param list 待更新的数据列表 + * @returns VChart 实例 + */ + updateDataInBatches: (list: { id: string; data: Datum[]; options?: IParserOptions }[]) => Promise; + + /** + * **同步**更新数据。 + * @param id 数据 id + * @param data 数据值 + * @param options 数据参数 + * @returns VChart 实例 + */ + updateDataSync: (id: StringOrNumber, data: Datum[], options?: IParserOptions) => IVChart; + + /** + * **同步方法** 更新数据 + * @async + * @param data 图表配置结构中的数据对象 + * @returns VChart 实例 + */ + updateFullDataSync: (data: IDataValues | IDataValues[], reRender?: boolean) => IVChart; + + /** + * **同步方法** 更新数据 + * @param data 图表配置结构中的数据对象 + * @returns VChart 实例 + */ + updateFullData: (data: IDataValues | IDataValues[], reRender?: boolean) => Promise; + + /** + * **异步**spec 更新。 + * @sync + * @param spec + * @param forceMerge + * @returns + */ + updateSpec: ( + spec: ISpec, + forceMerge?: boolean, + morphConfig?: IMorphConfig, + userUpdateOptions?: IUpdateSpecResult + ) => Promise; + + /** + * **同步方法**spec 更新。 + * @param spec + * @param forceMerge + * @returns + */ + updateSpecSync: ( + spec: ISpec, + forceMerge?: boolean, + morphConfig?: IMorphConfig, + userUpdateOptions?: IUpdateSpecResult + ) => void; + + /** + * **同步方法** 模块 spec 更新 + * @param filter + * @param spec + * @param forceMerge + * @returns + * @since 1.4.0 + */ + updateModelSpecSync: ( + filter: string | { type: string; index: number }, + spec: unknown, + forceMerge?: boolean, + morphConfig?: IMorphConfig + ) => IVChart; + + /** + * **异步方法** 模块 spec 更新 + * @async + * @param filter + * @param spec + * @param forceMerge + * @returns + * @since 1.4.0 + */ + updateModelSpec: ( + filter: string | { type: string; index: number }, + spec: unknown, + forceMerge?: boolean, + morphConfig?: IMorphConfig + ) => Promise; + + /** 更新 spec 并重新编译（不渲染），返回是否成功 */ + updateSpecAndRecompile: (spec: ISpec, forceMerge: boolean, option: IVChartRenderOption) => boolean; + + /** + * 更新绘制区域。 + * @param viewBox 绘制区域 + * @param reRender 是否重新渲染，默认为 true + * @returns + */ + updateViewBox: (viewBox: IBoundsLike, reRender?: boolean) => IVChart; + + /** + * **异步方法**，图表尺寸更新方法。 + * @async + * @param width 宽度 + * @param height 高度 + * @returns VChart 当前实例 + */ + resize: (width: number, height: number) => Promise; + + /** + * 销毁图表。 + */ + release: () => void; + + /** + * 事件监听 + */ + on: ((eType: EventType, handler: EventCallback) => void) & + ((eType: EventType, query: EventQuery, handler: EventCallback) => void); + off: (eType: EventType, handler?: EventCallback) => void; + + /** + * 更新或设置图元状态。 + * @param state 状态筛选器 + * @param filter 筛选器 + */ + updateState: ( + state: Record, 'style'>>, + filter?: (series: ISeries, mark: IMark, stateKey: string) => boolean //series + mark 筛选 + ) => void; + + /** + * 更新图元选中状态。 + * @param datum hover 图元数据 + * @param filter 筛选器 用来筛选系列与mark + * @param region region 筛选器 + */ + setSelected: ( + datum: MaybeArray | null, + filter?: (series: ISeries, mark: IMark) => boolean, + region?: IRegionQuerier + ) => void; + + /** + * 更新图元 hover 状态 + * @param datum hover 图元数据 + * @param filter 筛选器 用来筛选系列与mark + * @param region region 筛选器 + */ + setHovered: ( + datum: MaybeArray | null, + filter?: (series: ISeries, mark: IMark) => boolean, + region?: IRegionQuerier + ) => void; + + /** + * 清除所有图元的状态 + * @param state 状态名 + * + * @since 1.11.0 + */ + clearState: (state: string) => void; + + /** + * 清除所有图元的选中状态 + * + * @since 1.11.0 + */ + clearSelected: () => void; + + /** + * 清除所有图元的hover状态 + * + * @since 1.11.0 + */ + clearHovered: () => void; + + /** + * 获取当前主题，会返回完整的主题配置（只能获取用户通过`setCurrentTheme`方法设置过的主题，默认值为`ThemeManager`统一设置的主题） + * */ + getCurrentTheme: () => ITheme; + + /** + * 获取当前主题名称（只能获取用户通过`setCurrentTheme`方法设置过的主题，默认值为`ThemeManager`统一设置的主题） + */ + getCurrentThemeName: () => string; + + /** + * **异步方法**， 设置当前主题。 + * @param name 主题名称 + * @returns + */ + setCurrentTheme: (name: string) => Promise; + + /** + * 自定义 TooltipHandler。 + * @param tooltipHandler + */ + setTooltipHandler: (tooltipHandler: ITooltipHandler) => void; + + /** + * 获取用户定义的 TooltipHandler + * @returns ITooltipHandler + */ + getTooltipHandlerByUser: () => ITooltipHandler | undefined; + + /** + * 获取 TooltipHandler + * @returns + */ + getTooltipHandler: () => ITooltipHandler | undefined; + + /** + * 手动调用展示 tooltip + * @param datum 原始数据 + * @param options + * @returns + */ + showTooltip: (datum: Datum, options: IShowTooltipOption) => boolean; + + /** + * 手动调用，关闭 tooltip + * @returns + */ + hideTooltip: () => boolean; + + // 图例相关 api + /** + * 根据图例组件 id 获取图例数据 + * @param id 组件 id + * @returns + */ + getLegendDataById: (id: string) => Datum[]; + + /** + * 根据图例组件索引获取图例数据 + * @param index 图例索引，默认为 0 + * @returns + */ + getLegendDataByIndex: (index?: number) => Datum[]; + + /** + * 根据图例组件 id 获取当前图例的选中项 + * @param id 组件 id + * @returns + */ + getLegendSelectedDataById: (id: string) => StringOrNumber[]; + + /** + * 根据图例组件索引获取当前图例的选中项 + * @param index 图例索引，默认为 0 + * @returns + */ + getLegendSelectedDataByIndex: (index?: number) => StringOrNumber[]; + + /** + * 根据图例组件 id 更新图例选中数据 + * @param id + * @returns + */ + setLegendSelectedDataById: (id: string, selectedData: StringOrNumber[]) => void; + + /** + * 根据图例组件索引更新图例选中数据 + * @param index 图例索引，默认为 0 + * @returns + */ + setLegendSelectedDataByIndex: (index: number, selectedData: StringOrNumber[]) => void; + + /** + * **异步方法**返回一个包含图片展示的 data URI。 + * @returns data URI + */ + getDataURL: () => Promise; + + /** + * **异步方法** 导出图表图片，只支持浏览器端。 + * @param name 保存的图片名称 + * @returns + */ + exportImg: (name?: string) => Promise; + + /** + * 导出绘制了图表内容的 canvas + * @returns HTMLCanvasElement + * @since 1.5.2 + */ + exportCanvas: () => HTMLCanvasElement | undefined; + + /** + * 目前仅支持 node 环境，用于 node 端的图片导出 + * @returns + */ + getImageBuffer: () => void; + /** + * 设置自定义布局 + */ + setLayout: (layout: LayoutCallBack) => void; + /** + * 强制重新布局 + */ + reLayout: () => void; + + /** + * 获取编译器实例 + * @returns + */ + getCompiler: () => ICompiler; + + /** + * Get the chart instance + * 获取 Chart 图表实例。 + * @returns Chart 实例 + */ + getChart: () => Maybe; + + /** + * Get the renderer instance. + * 获取渲染引擎实例。 + * @returns the instance of VRender Stage + */ + getStage: () => IStage; + + /** + * 获取 canvas dom + * @returns HTMLCanvasElement | undefined + */ + getCanvas: () => HTMLCanvasElement | undefined; + + /** + * 获取图表的 dom 容器 + * @returns + */ + getContainer: () => Maybe; + + /** + * 获取图表所有的组件实例 + * @returns 组件实例 + */ + getComponents: () => IComponent[]; + + /** + * 获取图表的 DataSet 实例 + * @returns DataSet 实例 + */ + getDataSet: () => Maybe; + + /** + * 获取图表的 Scale 实例 + * @param scaleId scale 的id + * @returns Scale 实例 + * @since 1.10.4 + */ + getScale: (scaleId: string) => IBaseScale | null; + + /** + * 手动调用触发 dimension 交互效果。 + * @param datum dimension 值 + * @param options 触发配置 + * @returns + */ + setDimensionIndex: (value: StringOrNumber, options?: DimensionIndexOption) => void; + + /** + * 如果传入参数, 则禁用/开启 dimension 交互事件 + * 如果不传入参数, 获取当前是否禁用 dimension 交互事件 + */ + disableDimensionHoverEvent: (disabled?: boolean) => void; + + /** + * 禁用/开启 crosshair + */ + disableCrossHair: (disabled: boolean) => void; + + /** + * 禁用/开启 tooltip + */ + disableTooltip: (disabled: boolean) => void; + + // 数据转换相关的 api + /** + * Convert the data to coordinate position + * @param datum the datum to convert + * @param dataLinkInfo the data link info, could be seriesId or seriesIndex, default is { seriesIndex: 0 } + * @param isRelativeToCanvas 是否相对画布坐标，默认为 false Whether relative to canvas coordinates, default is false + * @param checkInViewData 是否检查数据对应的图元是否在视图中，如果不在视图中，返回 null + * @returns + */ + convertDatumToPosition: ( + datum: Datum, + dataLinkInfo?: DataLinkSeries, + isRelativeToCanvas?: boolean, + checkInViewData?: boolean + ) => IPoint | null; + + /** + * Convert the value to coordinate position + * @param value number | [number, number], the value to convert + * @param dataLinkInfo the data link info, could be seriesId,seriesIndex,axisId,axisIndex + * @param isRelativeToCanvas 是否相对画布坐标，默认为 false Whether relative to canvas coordinates, default is false + * returns + */ + convertValueToPosition: (( + value: StringOrNumber, + dataLinkInfo: DataLinkAxis, + isRelativeToCanvas?: boolean + ) => number | null) & + (( + value: [StringOrNumber, StringOrNumber], + dataLinkInfo: DataLinkSeries, + isRelativeToCanvas?: boolean + ) => IPoint | null); + + /** + * 根据 indicator 组件 id 更新 indicator 数据 + * @param id spec 中定义的 indicator id + * @param datum 具体数据项 + * @since 1.11.7 + */ + updateIndicatorDataById: (id: string, datum?: Datum) => void; + + /** + * 根据 indicator 组件 id 更新 indicator 数据 + * @param index indicator 索引下标 + * @param datum 具体数据项 + * @since 1.11.7 + */ + updateIndicatorDataByIndex: (index?: number, datum?: Datum) => void; + + /** + * 地图缩放 API + * @param [regionIndex=0] 根据索引顺序指定某个 region 区域的地图坐标系进行缩放 + * @param zoom 缩放比例 + * @param center 缩放中心 + * @since 1.11.10 + */ + geoZoomByIndex: (regionIndex: number, zoom: number, center?: { x: number; y: number }) => void; + + /** + * 地图缩放 API + * @param 根据 region id 指定某个 region 区域的地图坐标系进行缩放 + * @param zoom 缩放比例 + * @param center 缩放中心 + * @since 1.11.10 + */ + geoZoomById: (regionId: string | number, zoom: number, center?: { x: number; y: number }) => void; + /** + * @since 2.0.3 + * 当前图表是否开启了动画功能 + */ + isAnimationEnable: () => boolean; + /** 停止正在进行的所有动画 */ + stopAnimation: () => void; + + /** 暂停正在进行的所有动画 */ + pauseAnimation: () => void; + + /** 恢复暂停时正在进行的所有动画 */ + resumeAnimation: () => void; + + /** 注册实例函数 */ + registerFunction: (key: string, fun: Function) => void; + + /** 注销实例函数 */ + unregisterFunction: (key: string) => void; + + /** 获取实例函数 */ + getFunction: (key: string) => Function | null; + + /** 获取实例函数列表 */ + getFunctionList: () => string[] | null; + + /** 获取图表 spec 详细信息 */ + getSpecInfo: () => IChartSpecInfo; + + /** 设置运行时 spec */ + setRuntimeSpec: (spec: any) => void; + + /** 获取运行时 spec */ + getSpec: () => any; + + /** 获取当前容器宽高 */ + getCurrentSize: () => IContainerSize; + + /** 旋转图表 需要注册插件 */ + rotate90WithTransform?: (rotateDom: HTMLElement) => void; + + /** 取消图表旋转 */ + cancelTransform?: (rotateDom: HTMLElement) => void; +} +``` + +相关定义：[IMorphConfig](AdditionalTypes-Type-Definition.md#type-bffef8c15a00)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IParserOptions](AdditionalTypes-Type-Definition.md#type-63f1dbc535e0)、[IDataValues](AdditionalTypes-Type-Definition.md#type-218b08963b1d)、[ISpec](AdditionalTypes-Type-Definition.md#type-c3727b86f632)、[IUpdateSpecResult](AdditionalTypes-Type-Definition.md#type-646a207a21dd)、[IVChartRenderOption](AdditionalTypes-Type-Definition.md#type-88e49d0ebe2f)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[EventType](AdditionalTypes-Type-Definition.md#type-a71637b330ab)、[EventCallback](AdditionalTypes-Type-Definition.md#type-bc53e0f9fdb2)、[ExtendEventParam](AdditionalTypes-Type-Definition.md#type-577e7fff4950)、[EventQuery](AdditionalTypes-Type-Definition.md#type-61ce50950087)、[IMarkStateSpec](AdditionalTypes-Type-Definition.md#type-4d46c5681360)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[MaybeArray](AdditionalTypes-Type-Definition.md#type-915c1abd7543)、[IRegionQuerier](AdditionalTypes-Type-Definition.md#type-a826f89dd07b)、[ITheme](ITheme-Type-Definition.md)、[ITooltipHandler](AdditionalTypes-Type-Definition.md#type-73b5fb837aea)、[IShowTooltipOption](AdditionalTypes-Type-Definition.md#type-b4df769a6b46)、[LayoutCallBack](AdditionalTypes-Type-Definition.md#type-0bf7cec9094c)、[ICompiler](AdditionalTypes-Type-Definition.md#type-cbf1a5d7de9b)、[Maybe](AdditionalTypes-Type-Definition.md#type-644c0bc1509c)、[IChart](AdditionalTypes-Type-Definition.md#type-d27fa13b0c29)、[IStage](AdditionalTypes-Type-Definition.md#type-454a11518dd1)、[IComponent](AdditionalTypes-Type-Definition.md#type-5d7fe81ad96c)、[DataSet](AdditionalTypes-Type-Definition.md#type-8d2b64638b97)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[DimensionIndexOption](AdditionalTypes-Type-Definition.md#type-5b5f8e33e6e1)、[DataLinkSeries](AdditionalTypes-Type-Definition.md#type-84a00f86d855)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[DataLinkAxis](AdditionalTypes-Type-Definition.md#type-803024406435)、[IChartSpecInfo](AdditionalTypes-Type-Definition.md#type-618e9dfe06cf)、[IContainerSize](AdditionalTypes-Type-Definition.md#type-5c34c2234a2c) + + +## IVChartRenderOption + +来源：`packages/vchart/src/core/interface.ts`，VChart 2.1.7 + +```typescript +export interface IVChartRenderOption { + /** morphing 动画 spec */ + morphConfig?: IMorphConfig; + /** 是否重新转换图表 spec */ + transformSpec?: boolean; + actionSource?: VChartRenderActionSource; +} +``` + +相关定义：[IMorphConfig](AdditionalTypes-Type-Definition.md#type-bffef8c15a00)、[VChartRenderActionSource](AdditionalTypes-Type-Definition.md#type-3bb499134256) + + +## VChartRenderActionSource + +来源：`packages/vchart/src/core/interface.ts`，VChart 2.1.7 + +```typescript +export type VChartRenderActionSource = + | 'render' + | 'updateSpec' + | 'updateModelSpec' + | 'setCurrentTheme' + | 'updateSpecAndRecompile'; +``` + + +## StatisticOperations + +来源：`packages/vchart/src/data/transforms/interface.ts`，VChart 2.1.7 + +```typescript +export type StatisticOperations = Array<'max' | 'min' | 'values' | 'array-max' | 'array-min' | 'allValid'>; +``` + + +## DimensionEventParams + +来源：`packages/vchart/src/event/events/dimension/interface.ts`，VChart 2.1.7 + +```typescript +export type DimensionEventParams = BaseEventParams & { + action: 'enter' | 'leave' | 'move' | 'click'; + dimensionInfo: IDimensionInfo[]; +}; +``` + +相关定义：[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f)、[IDimensionInfo](AdditionalTypes-Type-Definition.md#type-06b8a10af7b9) + + +## IDimensionData + +来源：`packages/vchart/src/event/events/dimension/interface.ts`，VChart 2.1.7 + +```typescript +export interface IDimensionData { + /** 图元上的原始数据（考虑到有多个图元的情况，实际为数组类型） */ + datum: Datum[]; + /** 图元所在的系列实例 */ + series: ISeries; + /** 该数据项的 hash 值 */ + key?: string; +} +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0) + + +## IDimensionInfo + +来源：`packages/vchart/src/event/events/dimension/interface.ts`，VChart 2.1.7 + +```typescript +export interface IDimensionInfo { + /** 维度项索引，在连续轴上不存在 */ + index?: number; + /** 维度项原始值，在离散轴上为维度标签，在连续轴上为数字 */ + value: string | number; + /** 维度项所在坐标（scale 执行后的值） */ + position?: number; + /** 维度项所在轴 */ + axis?: IAxis; + /** 维度项对应数据 */ + data: IDimensionData[]; + /** 维度对应的类型 */ + dimType?: string; +} +``` + +相关定义：[IAxis](AdditionalTypes-Type-Definition.md#type-9cbd2aefe72d)、[IDimensionData](AdditionalTypes-Type-Definition.md#type-5b72dbd75644) + + +## BaseEventParams + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type BaseEventParams = EventParams & { + /** + * 事件对象 + */ + event: SuperEvent; + item: IMarkGraphic; + datum: Datum; + source: EventSourceType; +}; +``` + +相关定义：[EventParams](AdditionalTypes-Type-Definition.md#type-d0b5c8774949)、[SuperEvent](AdditionalTypes-Type-Definition.md#type-6c02331b393a)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d) + + +## ComponentType + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type ComponentType = + | 'axis' + | 'dataZoom' + | 'indicator' + | 'legend' + | 'markLine' + | 'markArea' + | 'markPoint' + | 'tooltip' + | 'title' + | 'label' + | 'totalLabel' + | 'customMark'; +``` + + +## EventBubbleLevel + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventBubbleLevel = keyof typeof Event_Bubble_Level; +``` + +相关定义：[Event_Bubble_Level](AdditionalTypes-Type-Definition.md#type-c7b3d3b6b38f) + + +## EventCallback + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventCallback = (params: Params) => boolean | void; +``` + +相关定义：[EventParams](AdditionalTypes-Type-Definition.md#type-d0b5c8774949) + + +## EventFilter + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventFilter = { + source: EventSourceType; + level: EventBubbleLevel; + type: string | null; + markName: string | null; + nodeName: string | null; + userId: StringOrNumber | null; + filter: (params: Partial) => boolean | null; +}; +``` + +相关定义：[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d)、[EventBubbleLevel](AdditionalTypes-Type-Definition.md#type-3e4576b7a2a4)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f) + + +## EventHandler + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventHandler = { + callback: EventCallback; + query: EventQuery | null; + // 如果有 debounce/throttle 配置则需要封装原始回调函数 + wrappedCallback?: EventCallback; + // 转换后的事件筛选配置 + filter?: EventFilter; + // handler 是否被禁止触发 + prevented?: boolean; +}; +``` + +相关定义：[EventCallback](AdditionalTypes-Type-Definition.md#type-bc53e0f9fdb2)、[EventQuery](AdditionalTypes-Type-Definition.md#type-61ce50950087)、[EventFilter](AdditionalTypes-Type-Definition.md#type-b46fb265f1d7)、[EventParams](AdditionalTypes-Type-Definition.md#type-d0b5c8774949) + + +## EventParams + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventParams = { + /** + * 事件对象 + */ + event?: SuperEvent; + /** + * 供不同的事件用于存储期望携带的数据 + */ + value?: any; + /** + * 事件来源的 mark + */ + mark?: IMark; + /** + * 事件来源的 model + */ + model?: IModel; + /** + * 事件来源的 chart + */ + chart?: IChart; + /** + * 事件拾取到的图元的数据 + */ + datum?: Datum; + /** + * 拾取到的图形节点 + */ + node?: IGraphic; + /** + * @since 1.10.4 + * 生命周期相关事件，包括： + * - 'rendered' + * - 'initialized' + * - 'animationFinished' + * - 'renderFinished' + * - 'layoutStart' + * - 'layoutEnd' + * 会返回vchart实例 + */ + vchart?: IVChart; +}; +``` + +相关定义：[SuperEvent](AdditionalTypes-Type-Definition.md#type-6c02331b393a)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[IChart](AdditionalTypes-Type-Definition.md#type-d27fa13b0c29)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201) + + +## EventParamsDefinition + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventParamsDefinition = { + // 基础事件回调参数 + pointerdown: BaseEventParams; + pointerup: BaseEventParams; + pointerupoutside: BaseEventParams; + pointertap: BaseEventParams; + pointerover: BaseEventParams; + pointermove: BaseEventParams; + pointerenter: BaseEventParams; + pointerleave: BaseEventParams; + pointerout: BaseEventParams; + mousedown: BaseEventParams; + mouseup: BaseEventParams; + mouseupoutside: BaseEventParams; + rightdown: BaseEventParams; + rightup: BaseEventParams; + rightupoutside: BaseEventParams; + click: BaseEventParams; + dblclick: BaseEventParams; + mousemove: BaseEventParams; + mouseover: BaseEventParams; + mouseout: BaseEventParams; + mouseenter: BaseEventParams; + mouseleave: BaseEventParams; + wheel: BaseEventParams; + touchstart: BaseEventParams; + touchend: BaseEventParams; + touchendoutside: BaseEventParams; + touchmove: BaseEventParams; + touchcancel: BaseEventParams; + + dragstart: BaseEventParams; + drag: BaseEventParams; + dragenter: BaseEventParams; + dragleave: BaseEventParams; + dragover: BaseEventParams; + dragend: BaseEventParams; + drop: BaseEventParams; + + tap: BaseEventParams; + pan: BaseEventParams; + panstart: BaseEventParams; + panend: BaseEventParams; + press: BaseEventParams; + pressup: BaseEventParams; + pressend: BaseEventParams; + pinch: BaseEventParams; + pinchstart: BaseEventParams; + pinchend: BaseEventParams; + swipe: BaseEventParams; + + // VChart 内置的扩展组合事件 + dimensionHover: DimensionEventParams; + dimensionClick: DimensionEventParams; + tooltipShow: TooltipEventParams; + tooltipHide: TooltipEventParams; + tooltipRelease: TooltipEventParams; + afterLayout: LayoutEventParam; + + // 交互相关事件 + 'element-select:start': InteractionEventParam; + 'element-select:reset': InteractionEventParam; + 'element-highlight:start': InteractionEventParam; + 'element-highlight:reset': InteractionEventParam; + + // 扩展事件参数 + [key: string]: ExtendEventParam; +}; +``` + +相关定义：[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f)、[DimensionEventParams](AdditionalTypes-Type-Definition.md#type-15e7376683b8)、[TooltipEventParams](AdditionalTypes-Type-Definition.md#type-e5c2cb9ed465)、[LayoutEventParam](AdditionalTypes-Type-Definition.md#type-e80f4120aa8f)、[InteractionEventParam](AdditionalTypes-Type-Definition.md#type-27175d2429ec)、[ExtendEventParam](AdditionalTypes-Type-Definition.md#type-577e7fff4950) + + +## EventQuery + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventQuery = { + /** + * 事件的冒泡层级配置，其中 model 指的是图表的内部模型，包括 region、series 以及 component + */ + level?: EventBubbleLevel; + /** + * 事件来源配置。 + * - `window`: window 事件 + * - `chart`: 图表事件 + */ + source?: EventSourceType; + + /** + * vrender 图形节点名称 + */ + nodeName?: string; + /** + * mark 图元名称 + */ + markName?: string; + /** + * 仅在 level 为 'mark' 或者 'model' 的场景下使用，用于筛选 mark 类型或者图表组成元素模型类型 + */ + type?: EventTargetType; + /** + * 用户在 spec 上配置的 id + */ + id?: StringOrNumber; + /** + * 自定义过滤函数 + * @param params + * @returns + */ + filter?: (params: Partial) => boolean; + + throttle?: number; + debounce?: number; + /** + * 是否阻止冒泡 + */ + consume?: boolean; +}; +``` + +相关定义：[EventBubbleLevel](AdditionalTypes-Type-Definition.md#type-3e4576b7a2a4)、[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d)、[EventTargetType](AdditionalTypes-Type-Definition.md#type-5c354e2dcaad)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f) + + +## EventSourceType + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventSourceType = keyof typeof Event_Source_Type; +``` + +相关定义：[Event_Source_Type](AdditionalTypes-Type-Definition.md#type-e0819375e8e5) + + +## EventTargetType + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventTargetType = MarkType | ComponentType | SeriesType; +``` + +相关定义：[MarkType](AdditionalTypes-Type-Definition.md#type-15c62fdeb46b)、[ComponentType](AdditionalTypes-Type-Definition.md#type-30b50e7b9294)、[SeriesType](AdditionalTypes-Type-Definition.md#type-43422e48d197) + + +## EventType + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type EventType = + | 'pointerdown' + | 'pointerup' + | 'pointerupoutside' + | 'pointertap' + | 'pointerover' + | 'pointermove' + | 'pointerenter' + | 'pointerleave' + | 'pointerout' + | 'mousedown' + | 'mouseup' + | 'mouseupoutside' + | 'rightdown' + | 'rightup' + | 'rightupoutside' + | 'click' + | 'dblclick' + | 'mousemove' + | 'mouseover' + | 'mouseout' + | 'mouseenter' + | 'mouseleave' + | 'wheel' + | 'touchstart' + | 'touchend' + | 'touchendoutside' + | 'touchmove' + | 'touchcancel' + | 'tap' + | 'dragstart' + | 'drag' + | 'dragenter' + | 'dragleave' + | 'dragover' + | 'dragend' + | 'drop' + | 'pan' + | 'panstart' + | 'panend' + | 'press' + | 'pressup' + | 'pressend' + | 'pinch' + | 'pinchstart' + | 'pinchend' + | 'swipe' + | keyof typeof ChartEvent + | keyof typeof HOOK_EVENT + | string; +``` + +相关定义：[ChartEvent](AdditionalTypes-Type-Definition.md#type-4c68f24bfcad)、[HOOK_EVENT](AdditionalTypes-Type-Definition.md#type-f58080efc74b) + + +## ExtendEventParam + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type ExtendEventParam = EventParams & { + event?: Event; + item?: IMarkGraphic; + datum?: Datum; + source?: EventSourceType; +}; +``` + +相关定义：[EventParams](AdditionalTypes-Type-Definition.md#type-d0b5c8774949)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[EventSourceType](AdditionalTypes-Type-Definition.md#type-1c63b5fdb81d) + + +## IComposedEvent + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export interface IComposedEvent { + register: (eType: Evt, handler: EventHandler) => void; + unregister: () => void; + dispatch: (v: unknown, opt: unknown) => unknown; +} +``` + +相关定义：[EventType](AdditionalTypes-Type-Definition.md#type-a71637b330ab)、[EventHandler](AdditionalTypes-Type-Definition.md#type-9dde9b52a754)、[EventParamsDefinition](AdditionalTypes-Type-Definition.md#type-bb8c7f815cf1) + + +## IEvent + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export interface IEvent { + on: ((eType: Evt, callback: EventCallback) => this) & + (( + eType: Evt, + query: EventQuery, + callback: EventCallback + ) => this); + off: ((eType: Evt, callback?: EventCallback) => this) & + (( + eType: Evt, + query: EventQuery, + callback: EventCallback + ) => this); + emit: (eType: Evt, params: EventParamsDefinition[Evt], level?: EventBubbleLevel) => void; + release: () => void; + + getComposedEventMap: () => Map, { eventType: EventType; event: IComposedEvent }>; + prevent: ( + eType: Evt, + except?: { + handler: EventCallback; + level: EventBubbleLevel; + } + ) => void; + allow: (eType: Evt) => void; +} +``` + +相关定义：[EventType](AdditionalTypes-Type-Definition.md#type-a71637b330ab)、[EventCallback](AdditionalTypes-Type-Definition.md#type-bc53e0f9fdb2)、[EventParamsDefinition](AdditionalTypes-Type-Definition.md#type-bb8c7f815cf1)、[EventQuery](AdditionalTypes-Type-Definition.md#type-61ce50950087)、[EventBubbleLevel](AdditionalTypes-Type-Definition.md#type-3e4576b7a2a4)、[EventParams](AdditionalTypes-Type-Definition.md#type-d0b5c8774949)、[IComposedEvent](AdditionalTypes-Type-Definition.md#type-4860a71f1f46) + + +## IEventDispatcher + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export interface IEventDispatcher { + globalInstance: IVChart; + register: (eType: Evt, handler: EventHandler) => this; + unregister: (eType: Evt, handler?: EventHandler) => this; + dispatch: (eType: Evt, params?: EventParamsDefinition[Evt], level?: EventBubbleLevel) => this; + clear: () => void; + release: () => void; + prevent: ( + eType: Evt, + except?: { + handler: EventCallback; + level: EventBubbleLevel; + } + ) => void; + allow: (eType: Evt) => void; +} +``` + +相关定义：[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201)、[EventType](AdditionalTypes-Type-Definition.md#type-a71637b330ab)、[EventHandler](AdditionalTypes-Type-Definition.md#type-9dde9b52a754)、[EventParamsDefinition](AdditionalTypes-Type-Definition.md#type-bb8c7f815cf1)、[EventBubbleLevel](AdditionalTypes-Type-Definition.md#type-3e4576b7a2a4)、[EventCallback](AdditionalTypes-Type-Definition.md#type-bc53e0f9fdb2) + + +## InteractionEventParam + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type InteractionEventParam = { + graphics?: IMarkGraphic[]; + datums?: Datum[]; +} & Partial; +``` + +相关定义：[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f) + + +## LayoutEventParam + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type LayoutEventParam = { + elements: (ILayoutItem & { type: string })[]; +} & Partial; +``` + +相关定义：[ILayoutItem](AdditionalTypes-Type-Definition.md#type-a23ec9ff5239)、[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f) + + +## PanEventParam + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type PanEventParam = ExtendEventParam & { + // x/y方向上的偏移值 + delta: [number, number]; +}; +``` + +相关定义：[ExtendEventParam](AdditionalTypes-Type-Definition.md#type-577e7fff4950) + + +## SuperEvent + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +type SuperEvent = Event & { + [key: string]: any; +}; +``` + + +## ZoomEventParam + +来源：`packages/vchart/src/event/interface.ts`，VChart 2.1.7 + +```typescript +export type ZoomEventParam = ExtendEventParam & { + // 缩放值 + scale: number; + // 缩放中心 + scaleCenter: IPoint; +}; +``` + +相关定义：[ExtendEventParam](AdditionalTypes-Type-Definition.md#type-577e7fff4950)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b) + + +## IInteraction + +来源：`packages/vchart/src/interaction/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IInteraction { + setDisableActiveEffect: (disable: boolean) => void; + addTrigger: (trigger: ITrigger) => void; + setStatedGraphics: (trigger: ITrigger, graphics: IMarkGraphic[]) => void; + getStatedGraphics: (trigger: ITrigger) => IMarkGraphic[]; + updateStates: ( + trigger: ITrigger, + newStatedGraphics: IMarkGraphic[], + prevStatedGraphics?: IMarkGraphic[], + state?: string, + reverseState?: string + ) => IMarkGraphic[]; + clearAllStates: () => void; + clearAllStatesOfTrigger: (trigger: ITrigger, state?: string, reverseState?: string) => void; + clearByState: (stateValue: string) => any; + updateStateOfGraphics: (stateValue: string, markGraphics: IMarkGraphic[]) => void; +} +``` + +相关定义：[ITrigger](AdditionalTypes-Type-Definition.md#type-4cc357381c0a)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3) + + +## IBaseTriggerOptions + +来源：`packages/vchart/src/interaction/interface/trigger.ts`，VChart 2.1.7 + +```typescript +export interface IBaseTriggerOptions { + type?: string; + /** + * 需要处理状态的所有图元 + */ + marks?: IMark[]; + mode?: RenderMode; + event: { + on: (eType: string, callback: ITriggerEventHandler) => void; + off: (eType: string, callback?: ITriggerEventHandler) => void; + emit: (eType: string, params: any) => void; + }; + interaction: IInteraction; + + id?: string; + + shouldStart?: (e: any) => boolean; + + shouldUpdate?: (e: any) => boolean; + + shouldEnd?: (e: any) => boolean; + + shouldReset?: (e: any) => boolean; + + onStart?: (e: any) => boolean; + + onUpdate?: (e: any) => boolean; + + onEnd?: (e: any) => boolean; + + onReset?: (e: any) => boolean; +} +``` + +相关定义：[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[RenderMode](AdditionalTypes-Type-Definition.md#type-875ef0d8fcf4)、[ITriggerEventHandler](AdditionalTypes-Type-Definition.md#type-f4836a1e3d12)、[IInteraction](AdditionalTypes-Type-Definition.md#type-8a888a648496) + + +## ITrigger + +来源：`packages/vchart/src/interaction/interface/trigger.ts`，VChart 2.1.7 + +```typescript +export interface ITrigger { + readonly options: TriggerOptions; + readonly type: string; + registerMark: (mark: IMark | IMark[]) => void; + release: () => void; + + init: () => void; + start: (g: any, e?: BaseEventParams) => void; + reset: (g?: IMarkGraphic) => void; + getStartState: () => string; + getResetState: () => string; + updateMarkIdByState: (states: string[]) => void; + getMarkIdByState: () => Record; + getMarks: () => IMark[]; + getMarksByState: (state: string) => IMark[]; +} +``` + +相关定义：[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[BaseEventParams](AdditionalTypes-Type-Definition.md#type-5ccfcc25894f)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[IBaseTriggerOptions](AdditionalTypes-Type-Definition.md#type-f51a72b7d484) + + +## ITriggerEventHandler + +来源：`packages/vchart/src/interaction/interface/trigger.ts`，VChart 2.1.7 + +```typescript +export type ITriggerEventHandler = (e: any, markGraphic?: IMarkGraphic) => void; +``` + +相关定义：[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3) + + +## ElementSpec + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export type ElementSpec = ( + | { + /** + * 组件对应的spec key，如'legends'表示图例 + */ + modelKey: string; + /** + * 组件对应的序号 + */ + modelIndex: number; + } + | { + /** + * 组件对应的id + */ + modelId: string; + } +) & { + /** + * 组件在grid布局中所在的列。从左向右，从 0 开始计数 + */ + col: number; + /** + * 组件在grid布局中所在的列跨度，即占了几列，默认值为1 + */ + colSpan?: number; + /** + * 组件在grid布局中所在的行。从上向下，从 0 开始计数。 + */ + row: number; + /** + * 组件在grid布局中所在的行跨度，即占了几行，默认值为1 + */ + rowSpan?: number; +}; +``` + + +## IBaseLayoutSpec + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBaseLayoutSpec extends ILayoutSpecBase { + /** + * 设置布局类型为默认布局 + */ + type: 'base'; + /** + * 是否在第一次布局完成后，再次布局一次，用于解决第一次布局时，元素宽度或高度为0的问题 + * @since 2.0.7 + */ + secondLayoutLeftRight?: boolean; +} +``` + +相关定义：[ILayoutSpecBase](AdditionalTypes-Type-Definition.md#type-a40f94687b59) + + +## IGridLayoutSpec + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGridLayoutSpec extends ILayoutSpecBase { + /** + * 设置布局类型为grid布局 + */ + type: 'grid'; + /** + * grid布局的总列数 + */ + col: number; + /** + * grid布局的总行数 + */ + row: number; + /** + * 可选配置，指定某几列的宽度 + */ + colWidth?: { + /** + * 指定列数，序号从 0 开始 + */ + index: number; + /** + * 设置指定列的宽度，单位为像素 + */ + size: number | ((maxSize: number) => number); + }[]; + /** + * 可选配置，指定某几行的高度 + */ + rowHeight?: { + /** + * 指定行数，序号从 0 开始 + */ + index: number; + /** + * 设置指定行的高度，单位为像素 + */ + size: number | ((maxSize: number) => number); + }[]; + /** + * + * 指定所有图表元素所在位置，图表元素的位置起点和占几行几列，可以占多行多列 + * 图表元素位置允许配置重叠。 + */ + elements: ElementSpec[]; +} +``` + +相关定义：[ILayoutSpecBase](AdditionalTypes-Type-Definition.md#type-a40f94687b59)、[ElementSpec](AdditionalTypes-Type-Definition.md#type-6b92034e666e) + + +## ILayoutItem + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutItem { + readonly type: string; + /** + * 标记当前布局元素是否需要重新计算布局属性 + * 图表模块可能部分需要重新布局，部分不需要，根据这个tag在布局过程中进行优化 + */ + readonly willLayoutTag: boolean; + /** + * 上一次布局的布局尺寸 + */ + readonly lastComputeRect: ILayoutRect; + /** + * 标记这个布局Item的方向（left->right, right->left, top->bottom, bottom->top） + */ + directionStr?: 'l2r' | 'r2l' | 't2b' | 'b2t'; + layoutClip: boolean; + layoutType: ILayoutType; + layoutBindRegionID: number | number[]; + layoutOrient: IOrientType; + /** 是否自动缩进 */ + autoIndent: boolean; + + /** + * inline元素和其他同行元素的对齐方式 + * 顶部的inline元素，'start' - 顶部对齐；'end' - '底部对齐'; 'middle' - 居中对齐 + * 底部的inline元素，'start' - 底部对齐；'end' - '顶部对齐'; 'middle' - 居中对齐 + * 左侧的inline元素，'start' - 左侧对齐；'end' - '右侧对齐'; 'middle' - 居中对齐 + * 右侧的inline元素，'start' - 右侧对齐；'end' - '左侧对齐'; 'middle' - 居中对齐 + */ + alignSelf?: 'start' | 'end' | 'middle'; + + layoutPaddingLeft: number; + layoutPaddingTop: number; + layoutPaddingRight: number; + layoutPaddingBottom: number; + + layoutOffsetX: number; + layoutOffsetY: number; + + // 越大越先处理 + layoutLevel: number; + + chartLayoutRect: ILayoutRect; + + readonly layoutRectLevelMap: ILayoutRect; + minWidth: number; + maxWidth: number; + minHeight: number; + maxHeight: number; + + readonly model: ILayoutModel; + + getModelId: () => StringOrNumber; + getModelVisible: () => boolean; + + getSpec?: () => any; + setAttrFromSpec: (spec: ILayoutItemSpec, chartViewRect: ILayoutRect) => void; + + setRectInSpec: (rect: ILayoutRect) => ILayoutRect; + + getLayoutStartPoint: () => ILayoutPoint; + getLayoutRect: () => ILayoutRect; + getLayout: () => IRect; + getLastComputeOutBounds: () => IBoundsLike; + + /** 生命周期 */ + onLayoutStart: (layoutRect: IRect, viewRect: ILayoutRect) => void; + onLayoutEnd: () => void; + + /** + * 更新元素布局的 layoutRect 大小，用来更新指定布局空间 + */ + setLayoutRect: (rect: Partial, levelMap?: Partial) => void; + /** + * 基于元素内部逻辑计算占位空间，rect表示可用空间 + */ + computeBoundsInRect: (rect: ILayoutRect) => ILayoutRect; + /** + * 更新元素布局的起始点位置 + */ + setLayoutStartPosition: (pos: Partial) => void; + /** + * 更新绝对布局元素的位置信息 + */ + absoluteLayoutInRect: (rect: IRect) => void; + /** + * 布局完成后，清楚标记 + */ + clearWillLayoutTag: () => void; + /** + * 标记要重新布局 + */ + setWillLayoutTag: () => void; +} +``` + +相关定义：[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[ILayoutType](AdditionalTypes-Type-Definition.md#type-7ececfbaa390)、[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[ILayoutModel](AdditionalTypes-Type-Definition.md#type-b788a1bf7960)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[ILayoutItemSpec](AdditionalTypes-Type-Definition.md#type-31e5f8b69a13)、[ILayoutPoint](AdditionalTypes-Type-Definition.md#type-6dd6ef1acef0)、[IRect](AdditionalTypes-Type-Definition.md#type-51a55b549762)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b) + + +## ILayoutItemSpec + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutItemSpec { + /** 当前模块的布局类型，配置为 absolute 的话，当前元素会以图表左上角为原点进行绝对布局 */ + layoutType?: ILayoutType; + /** + * 布局顺序等级，等级越大的，越优先布局 + * 比如顶部同时有标题和图例的场景，期望标题先放在顶部，然后放置图例。 + */ + layoutLevel?: number; + + /** + * inline元素和其他同行元素的对齐方式 + * 顶部的inline元素，'start' - 顶部对齐；'end' - '底部对齐'; 'middle' - 居中对齐 + * 底部的inline元素，'start' - 底部对齐；'end' - '顶部对齐'; 'middle' - 居中对齐 + * 左侧的inline元素，'start' - 左侧对齐；'end' - '右侧对齐'; 'middle' - 居中对齐 + * 右侧的inline元素，'start' - 右侧对齐；'end' - '左侧对齐'; 'middle' - 居中对齐 + */ + alignSelf?: 'start' | 'end' | 'middle'; + + // 基础的布局配置 + /** 模块布局位置 */ + orient?: IOrientType; + /** 模块的布局间距 */ + padding?: ILayoutPaddingSpec; + /** 是否按照 orient 自动修改 padding，隐藏位于外侧的 padding。目前只在组件上生效 */ + noOuterPadding?: boolean; + /** 模块的布局大小：宽度 */ + width?: ILayoutNumber; + /** 模块的布局最大宽度 */ + maxWidth?: ILayoutNumber; + /** 模块的布局最小宽度 */ + minWidth?: ILayoutNumber; + /** 模块的布局大小：高度 */ + height?: ILayoutNumber; + /** 模块的布局最大高度 */ + maxHeight?: ILayoutNumber; + /** 模块的布局最小高度 */ + minHeight?: ILayoutNumber; + /** 模块的布局位置偏移：X */ + offsetX?: ILayoutNumber; + /** 模块的布局位置偏移：Y */ + offsetY?: ILayoutNumber; + + /** 模块的展示层级，当2个模块重叠时，层级较大的展示在上方 */ + zIndex?: number; + /** 模块是否裁剪超出布局区域外的绘图内容 */ + clip?: boolean; + + // 绝对布局下的对齐设置 + + /** 模块绝对布局下，与图表左侧的距离。注意仅在 layoutType === 'absolute' 时生效 */ + left?: ILayoutNumber; + /** 模块绝对布局下，与图表右侧的距离。注意仅在 layoutType === 'absolute' 时生效 */ + right?: ILayoutNumber; + /** 模块绝对布局下，与图表顶部的距离。注意仅在 layoutType === 'absolute' 时生效 */ + top?: ILayoutNumber; + /** 模块绝对布局下，与图表底部的距离。注意仅在 layoutType === 'absolute' 时生效 */ + bottom?: ILayoutNumber; + /** 模块绝对布局下，元素将放置在图表的正中间。注意仅在 layoutType === 'absolute' 时生效，同时将忽略 padding 属性 */ + center?: boolean; +} +``` + +相关定义：[ILayoutType](AdditionalTypes-Type-Definition.md#type-7ececfbaa390)、[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[ILayoutPaddingSpec](ILayoutPaddingSpec-Type-Definition.md)、[ILayoutNumber](AdditionalTypes-Type-Definition.md#type-9638d3997297) + + +## ILayoutSpecBase + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutSpecBase { + /** + * 布局的类型，现在支持 grid布局和默认布局（基于占位的布局） + */ + type: string; +} +``` + + +## LayoutCallBack + +来源：`packages/vchart/src/layout/interface.ts`，VChart 2.1.7 + +```typescript +export type LayoutCallBack = ( + chart: any, + item: ILayoutItem[], + chartLayoutRect: IRect, + chartViewBox: IBoundsLike +) => void; +``` + +相关定义：[ILayoutItem](AdditionalTypes-Type-Definition.md#type-a23ec9ff5239)、[IRect](AdditionalTypes-Type-Definition.md#type-51a55b549762)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c) + + +## AnimationStateValues + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type AnimationStateValues = 'appear' | 'enter' | 'update' | 'exit' | 'disappear' | 'none' | 'state'; +``` + + +## DiffStateValues + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type DiffStateValues = 'update' | 'enter' | 'exit'; +``` + + +## IAttrConfig + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IAttrConfig { + level: number; + style: StyleConvert; + referer?: IMarkRaw; + postProcess?: (result: A, ...args: Parameters>) => A; +} +``` + +相关定义：[StyleConvert](AdditionalTypes-Type-Definition.md#type-f616fecb91f8)、[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[FunctionType](FunctionType-Type-Definition.md)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## IAttrs + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IAttrs = { + [K in keyof T]: IAttrConfig; +}; +``` + +相关定义：[IAttrConfig](AdditionalTypes-Type-Definition.md#type-597b323ab9ea)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## IDataSamping + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IDataSamping { + /** + * 是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点 + * @default false + * @since 1.3.0 + */ + activePoint?: boolean; + /** + * 数据采样 - 采样方法 + * @since 1.6.0 + */ + sampling?: ISamplingMethod; + /** + * 数据采样 - 采样系数 + * @since 1.6.0 + * @default 1 + */ + samplingFactor?: number; +} +``` + +相关定义：[ISamplingMethod](AdditionalTypes-Type-Definition.md#type-0ce27198f72d) + + +## IGraphicContext + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IGraphicContext { + /** + * 编译器 + */ + compiler: ICompiler; + /** + * mark的类型 + */ + markType: MarkTypeEnum; + /** + * 图形所属mark对应的id，自增id + */ + markId: number; + /** + * 图形所属model对应的id，自增id + */ + modelId: number; + /** + * 图形所属mark对应的用户设置id + */ + markUserId?: number | string; + /** + * 图形所属model对应的用户设置id + */ + modelUserId?: number | string; + /** + * 数据对比状态 + */ + diffState?: DiffStateValues; + /** + * 是否正在被复用的图元 + */ + reusing?: boolean; + /** + * 复用图元时，保存的上一次的旧属性（用于平滑的过渡动画） + */ + lastAttrs?: Record; + /** + * 用于判定这个图元是第几个，在OneByOne动画中控制顺序 + */ + indexKey?: string; + /** + * 差异的属性 + */ + diffAttrs?: Record; + /** + * VChart encode/transform 后、应用到 VRender graphic 前的下一轮属性快照。 + * 用于 VChart 的 afterEncode transform、diffAttrs 与动画参数，不等同于 VRender finalAttribute。 + */ + finalAttrs?: Record; + /** + * 用于保存mark对应series的fieldX + */ + fieldX?: string[]; + /** + * 用于保存mark对应series的fieldX + */ + originalFieldX?: string[]; + /** + * 用于保存mark对应series的fieldY + */ + fieldY?: string[]; + /** + * 用于保存mark对应series的fieldY + */ + originalFieldY?: string[]; + /** + * 动画状态管理: 'appear' / 'enter' / 'update' / 'exit' / 'disappear' + */ + animationState?: AnimationStateValues; + /** + * 数据 + */ + data?: Datum[]; + /** + * 用于区分图形的唯一key， + * 对于line/mark而言，和`groupKey` 是一致的 + * 对于其他图元，由 `groupKey` 和 `key` 拼装得到 + */ + uniqueKey?: string; + /** + * 唯一key + */ + key?: string; + /** + * 分组key + */ + groupKey?: string; + /** + * 状态 + */ + states?: string[]; + /** + * 图元总数量 + */ + graphicCount?: number; + /** + * 图元索引顺序 + */ + graphicIndex?: number; + /** + * 状态动画配置 + */ + stateAnimateConfig?: IAnimationConfig | IAnimationConfig[]; +} +``` + +相关定义：[ICompiler](AdditionalTypes-Type-Definition.md#type-cbf1a5d7de9b)、[MarkTypeEnum](AdditionalTypes-Type-Definition.md#type-f61b3242139b)、[DiffStateValues](AdditionalTypes-Type-Definition.md#type-1352ed6c1d81)、[AnimationStateValues](AdditionalTypes-Type-Definition.md#type-0460768bb02c)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IAnimationConfig](IAnimationConfig-Type-Definition.md) + + +## IMark + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IMark = IMarkRaw; +``` + +相关定义：[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## IMarkGraphic + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IMarkGraphic extends IGraphic { + /** + * 缓存运行时的状态编码数据 + */ + runtimeStateCache?: Record; + + /** + * 上下文数据 + */ + context?: IGraphicContext; + + /** + * 是否正在退场 + */ + isExiting?: boolean; +} +``` + +相关定义：[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IGraphicContext](AdditionalTypes-Type-Definition.md#type-ff3da46fbc1c) + + +## IMarkOverlap + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IMarkOverlap { + /** + * 标记点之间的距离，px + * @since 1.6.0 + */ + pointDis?: number; + /** + * 标记点之间的距离， pointSize 的倍数 + * @since 1.6.0 + * @default 1 + */ + pointDisMul?: number; + /** + * 是否允许标记图形相互覆盖 + * @since 1.6.0 + * @default false + */ + markOverlap?: boolean; +} +``` + + +## IMarkProgressiveConfig + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IMarkProgressiveConfig = { + /** 是否开启大数据渲染模式，开启后会降低渲染的精度 */ + large?: boolean; + /** 开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold */ + largeThreshold?: number; + /** 分片长度 */ + progressiveStep?: number; + /** 开启分片渲染的阀值，对应的是单系列data的长度 */ + progressiveThreshold?: number; +}; +``` + + +## IMarkRaw + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface IMarkRaw extends ICompilableMark { + readonly stateStyle: IMarkStateStyle; + + getAttributesOfState: (datum: Datum, state?: StateValueType) => Partial; + getAttribute: (key: U, datum: any, state?: StateValueType) => unknown; + setAttribute: (attr: U, style: StyleConvert, state?: StateValueType, level?: number) => void; + + // 需要支持优先级并且可以使用优先级覆盖 + /** @deprecated VChart 层尽量使用 IModel.setMarkStyle() */ + setStyle: (style: Partial>, state?: StateValueType, level?: number) => void; + setSimpleStyle: (s: T) => void; + getSimpleStyle: () => T; + + setReferer: (mark: IMarkRaw, styleKey?: string, state?: StateValueType) => void; + + /** @deprecated VChart 层尽量使用 IModel.initMarkStyleWithSpec() */ + initStyleWithSpec: (spec: any) => void; + + created: () => void; + + setPostProcess: ( + key: U, + postProcessFunc: IAttrConfig['postProcess'], + state?: StateValueType + ) => void; + + /** 更新某一个状态 */ + updateMarkState: (key: string) => void; + + render: () => void; + renderInner: () => void; + + getGraphics: () => IMarkGraphic[]; + + reuse: (mark: IMark) => void; + prepareMorph: (mark: IMark) => void; + + clearExitGraphics: () => void; + + /** 是否启动了增量渲染模式 */ + isProgressive: () => boolean; + /** 是否正在执行增量渲染 */ + isDoingProgressive: () => boolean; + /** 清除增量渲染相关状态 */ + clearProgressive: () => void; + /** 从第一帧开始增量计算 */ + restartProgressive: () => void; + /** 分片执行 */ + renderProgressive: () => void; + /** 增量流程后，是否执行动画 */ + canAnimateAfterProgressive: () => boolean; + /** 执行动画 */ + runAnimation: () => void; + /** 获取动画状态 */ + getAnimationState: () => AnimationStateValues; + /** 是否需要清除旧的数据 */ + needClear?: boolean; + /** 禁用状态动画 */ + disableAnimationByState: (state: string | string[]) => void; + /** 启用状态动画 */ + enableAnimationByState: (state: string | string[]) => void; + /** 重新加载前清除缓存 */ + clearBeforeReInit: () => void; +} +``` + +相关定义：[ICompilableMark](AdditionalTypes-Type-Definition.md#type-fb1ce8327f06)、[IMarkStateStyle](AdditionalTypes-Type-Definition.md#type-103f402e7251)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[StateValueType](AdditionalTypes-Type-Definition.md#type-17574edeab90)、[StyleConvert](AdditionalTypes-Type-Definition.md#type-f616fecb91f8)、[IMarkStyle](AdditionalTypes-Type-Definition.md#type-574e4d23d491)、[IAttrConfig](AdditionalTypes-Type-Definition.md#type-597b323ab9ea)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[AnimationStateValues](AdditionalTypes-Type-Definition.md#type-0460768bb02c)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## IMarkStateStyle + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IMarkStateStyle = Record>>; +``` + +相关定义：[StateValueType](AdditionalTypes-Type-Definition.md#type-17574edeab90)、[IAttrs](AdditionalTypes-Type-Definition.md#type-26f957d91e5c)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## IMarkStyle + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type IMarkStyle = { + [key in keyof T]: MarkInputStyle; +}; +``` + +相关定义：[MarkInputStyle](AdditionalTypes-Type-Definition.md#type-b04af6888dbd)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7) + + +## ISamplingMethod + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type ISamplingMethod = 'lttb' | 'min' | 'max' | 'sum' | 'average'; +``` + + +## MarkInputStyle + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type MarkInputStyle = StyleConvert | VisualType; +``` + +相关定义：[StyleConvert](AdditionalTypes-Type-Definition.md#type-f616fecb91f8)、[VisualType](AdditionalTypes-Type-Definition.md#type-e295ec9bce6b) + + +## StyleConvert + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export type StyleConvert = ValueType | FunctionType | VisualScaleType; +``` + +相关定义：[ValueType](AdditionalTypes-Type-Definition.md#type-979efd9d6b47)、[FunctionType](FunctionType-Type-Definition.md)、[VisualScaleType](AdditionalTypes-Type-Definition.md#type-a7e81495b9fc) + + +## VisualScaleType + +来源：`packages/vchart/src/mark/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface VisualScaleType { + scale: IBaseScale; + field: StringOrNumber; + changeDomain?: 'none' | 'replace' | 'expand'; //default 'none' +} +``` + +相关定义：[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IComponentMark + +来源：`packages/vchart/src/mark/interface/mark.ts`，VChart 2.1.7 + +```typescript +export interface IComponentMark extends IMarkRaw { + getComponent: () => IGraphic; + clearComponent: () => void; + releaseWithExitAnimation: () => boolean; + forceReleaseExitAnimation: () => void; + setAttributeTransform: (t: (attrs: any) => any) => any; +} +``` + +相关定义：[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3) + + +## IGroupMark + +来源：`packages/vchart/src/mark/interface/mark.ts`，VChart 2.1.7 + +```typescript +export interface IGroupMark extends IMarkRaw { + // groupMark的zIndex只能配在外层，encode里不生效，且无法写成signal + // {type:'group', zIndex: 100} ✅ + // {type:'group', encode:{enter:{zIndex:{value:100}}}} ❌ + // {type:'group', zIndex: {signal: }} ❌ + + addMark: (m: IMark) => boolean; + removeMark: (m: IMark) => boolean; + // TODO: 这里可能会出现mark嵌套的问题 + getMarks: () => IMark[]; + getMarkInType: (type: MarkType) => IMark[]; + getMarkInId: (id: number) => IMark | undefined; + getMarkInName: (name: string) => IMark[] | undefined; +} +``` + +相关定义：[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[IGroupMarkSpec](IGroupMarkSpec-Type-Definition.md)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[MarkType](AdditionalTypes-Type-Definition.md#type-15c62fdeb46b) + + +## ILabelMark + +来源：`packages/vchart/src/mark/interface/mark.ts`，VChart 2.1.7 + +```typescript +export interface ILabelMark extends ITextMark { + skipEncode: boolean; + + getRule: () => string; + setRule: (rule: string) => void; + + getTarget: () => IMark; + setTarget: (target: IMark) => void; + + getComponent: () => IComponentMark; + setComponent: (component: IComponentMark) => void; +} +``` + +相关定义：[ITextMark](AdditionalTypes-Type-Definition.md#type-fef57d2925f9)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IComponentMark](AdditionalTypes-Type-Definition.md#type-642b39fa286c) + + +## ISymbolMark + +来源：`packages/vchart/src/mark/interface/mark.ts`，VChart 2.1.7 + +```typescript +export type ISymbolMark = IMarkRaw; +``` + +相关定义：[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md) + + +## ITextMark + +来源：`packages/vchart/src/mark/interface/mark.ts`，VChart 2.1.7 + +```typescript +export type ITextMark = IMarkRaw & { getTextType: () => 'text' | 'rich' }; +``` + +相关定义：[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[IComposedTextMarkSpec](AdditionalTypes-Type-Definition.md#type-3cdc9715d892) + + +## MarkType + +来源：`packages/vchart/src/mark/interface/type.ts`，VChart 2.1.7 + +```typescript +export type MarkType = keyof typeof MarkTypeEnum | string; +``` + +相关定义：[MarkTypeEnum](AdditionalTypes-Type-Definition.md#type-f61b3242139b) + + +## MarkTypeEnum + +来源：`packages/vchart/src/mark/interface/type.ts`，VChart 2.1.7 + +```typescript +export const enum MarkTypeEnum { + group = 'group', + + symbol = 'symbol', + rule = 'rule', + line = 'line', + text = 'text', + rect = 'rect', + image = 'image', + path = 'path', + area = 'area', + arc = 'arc', + polygon = 'polygon', + boxPlot = 'boxPlot', + linkPath = 'linkPath', + cell = 'cell', + ripple = 'ripple', + liquid = 'liquid', + + component = 'component', + dataLabel = 'dataLabel', + label = 'label', + + pictogram = 'pictogram' +} +``` + + +## IBaseModelSpecTransformer + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBaseModelSpecTransformer { + getTheme: (spec: any, chartSpec: any) => any; + transformSpec: ( + spec: any, + chartSpec: any, + chartSpecInfo?: IChartSpecInfo + ) => IBaseModelSpecTransformerResult; +} +``` + +相关定义：[IChartSpecInfo](AdditionalTypes-Type-Definition.md#type-618e9dfe06cf)、[IBaseModelSpecTransformerResult](AdditionalTypes-Type-Definition.md#type-9be6c667e373) + + +## IBaseModelSpecTransformerOption + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export type IBaseModelSpecTransformerOption = IChartSpecTransformerOption; +``` + +相关定义：[IChartSpecTransformerOption](AdditionalTypes-Type-Definition.md#type-42469e396d0c) + + +## IBaseModelSpecTransformerResult + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBaseModelSpecTransformerResult { + spec: T; + theme: K; +} +``` + + +## IEffect + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IEffect { + [key: string]: (e?: any) => any; +} +``` + + +## ILayoutModel + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutModel extends IModel { + // 布局相关 + getLayoutStartPoint: () => IPoint; + setLayoutStartPosition: (pos: Partial) => void; + getLayoutRect: () => ILayoutRect; + setLayoutRect: (rect: Partial, levelMap?: Partial) => void; + + getLastComputeOutBounds: () => IBoundsLike; + + getBoundsInRect: (rect: ILayoutRect, fullRect: ILayoutRect) => IBoundsLike; + + //布局周期 + afterSetLayoutStartPoint: (pos: ILayoutPoint) => void; +} +``` + +相关定义：[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IBoundsLike](AdditionalTypes-Type-Definition.md#type-e61ecce4e47c)、[ILayoutPoint](AdditionalTypes-Type-Definition.md#type-6dd6ef1acef0) + + +## IModel + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModel extends ICompilable { + readonly modelType: string; + readonly type: string; + readonly specKey: string; + readonly transformerConstructor: new (option: IBaseModelSpecTransformerOption) => IBaseModelSpecTransformer; + + readonly id: number; + + readonly userId?: StringOrNumber; + + // 事件 + readonly event: IEvent; + + // 副作用 + readonly effect: IEffect; + + coordinate?: CoordinateType; + + // 布局 + layout?: ILayoutItem; + + /** 是否可见 */ + getVisible: () => boolean; + + // 初始化参数 + getOption: () => IModelOption; + + getMarks: () => IMark[]; + getMarkNameMap: () => Record; + + getData: () => ICompilableData; + + getChart: () => IChart; + + //生命周期 + // 创建模块自身内容，设置自身属性 + created: () => void; + // 用来处理与其他图表模块的联系 + init: (option: IModelInitOption) => void; + /** updateSpec 或者切换主题后，根据新 spec 执行的初始化过程 */ + reInit: (spec?: any) => void; + beforeRelease: () => void; + + onEvaluateEnd: (ctx: IModelEvaluateOption) => void; + onDataUpdate: () => void; + onBeforeRender: () => void; + + updateSpec: (spec: any, totalSpec?: any) => IUpdateSpecResult; + getSpec?: () => any; + getSpecIndex: () => number; + getSpecPath: () => Array; + + //布局周期 + onLayoutStart: (layoutRect: IRect, viewRect: ILayoutRect) => void; + onLayoutEnd: () => void; + + getColorScheme: () => IThemeColorScheme | undefined; + + setMarkStyle: ( + mark?: IMarkRaw, + style?: Partial | ConvertToMarkStyleSpec>, + state?: StateValueType, + level?: number + ) => void; + + initMarkStyleWithSpec: (mark?: IMark, spec?: any) => void; + + getSpecInfo: () => IModelSpecInfo; + + updateAnimateStateCallback: (callback: (graphic: IMarkGraphic) => AnimationStateValues) => void; + getAnimationStateCallback: () => (graphic: IMarkGraphic) => AnimationStateValues; +} +``` + +相关定义：[ICompilable](AdditionalTypes-Type-Definition.md#type-590d0c32ce42)、[IBaseModelSpecTransformerOption](AdditionalTypes-Type-Definition.md#type-a06278aae67d)、[IBaseModelSpecTransformer](AdditionalTypes-Type-Definition.md#type-d0389b7c19ac)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IEvent](AdditionalTypes-Type-Definition.md#type-17583cb7e08d)、[IEffect](AdditionalTypes-Type-Definition.md#type-2ef752cff22f)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b)、[ILayoutItem](AdditionalTypes-Type-Definition.md#type-a23ec9ff5239)、[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[ICompilableData](AdditionalTypes-Type-Definition.md#type-bac9ca204677)、[IChart](AdditionalTypes-Type-Definition.md#type-d27fa13b0c29)、[IModelInitOption](AdditionalTypes-Type-Definition.md#type-d5cf5deb27b7)、[IModelEvaluateOption](AdditionalTypes-Type-Definition.md#type-680368166ca8)、[IUpdateSpecResult](AdditionalTypes-Type-Definition.md#type-646a207a21dd)、[IRect](AdditionalTypes-Type-Definition.md#type-51a55b549762)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IThemeColorScheme](AdditionalTypes-Type-Definition.md#type-45344180023e)、[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7)、[IMarkRaw](AdditionalTypes-Type-Definition.md#type-8245181df7c4)、[IMarkStyle](AdditionalTypes-Type-Definition.md#type-574e4d23d491)、[ConvertToMarkStyleSpec](AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5)、[StateValueType](AdditionalTypes-Type-Definition.md#type-17574edeab90)、[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a)、[IMarkGraphic](AdditionalTypes-Type-Definition.md#type-6b98396ffcb3)、[AnimationStateValues](AdditionalTypes-Type-Definition.md#type-0460768bb02c) + + +## IModelConstructor + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelConstructor { + readonly builtInTheme?: any; + readonly transformerConstructor: new (option: IBaseModelSpecTransformerOption) => IBaseModelSpecTransformer; +} +``` + +相关定义：[IBaseModelSpecTransformerOption](AdditionalTypes-Type-Definition.md#type-a06278aae67d)、[IBaseModelSpecTransformer](AdditionalTypes-Type-Definition.md#type-d0389b7c19ac) + + +## IModelEvaluateOption + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelEvaluateOption {} +``` + + +## IModelInitOption + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelInitOption {} +``` + + +## IModelMarkInfo + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelMarkInfo { + /** mark 类型 */ + type: MarkTypeEnum | string | (MarkTypeEnum | string)[]; + /** mark 名称 */ + name: string; +} +``` + +相关定义：[MarkTypeEnum](AdditionalTypes-Type-Definition.md#type-f61b3242139b) + + +## IModelOption + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelOption extends ICompilableInitOption { + type: string; + eventDispatcher: IEventDispatcher; + dataSet: DataSet; + map: Map; + mode: RenderMode; + globalInstance: IVChart; + regionIndexes?: Array; + specKey?: string; + specPath?: Array; + specInfoPath?: Array; + + getTheme?: (...keys: string[]) => any; + getSpecInfo?: () => IChartSpecInfo; + getChartLayoutRect: () => IRect; + getChartViewRect: () => ILayoutRect; + + getChart: () => IChart; + getSeriesData: (id: StringOrNumber | undefined, index: number | undefined) => DataView | undefined; + + globalScale: IGlobalScale; + animation?: boolean; + /** + * 错误消息回调函数 + */ + onError: (...args: any[]) => void; + + /** + * 是否关闭交互效果 + */ + disableTriggerEvent?: boolean; + + /** + * 组件内容展示配置 + * @since 2.0.11 + */ + componentShowContent?: { + /** + * tooltip 是否关闭内容展示 + * @default false + */ + tooltip?: boolean | Partial>; + // crosshair 组件是否展示 + crosshair?: boolean; + }; + + getDimensionInfo?: (chart: IChart | undefined, pos: ILayoutPoint, isTooltip?: boolean) => IDimensionInfo[] | null; + getDimensionInfoByValue?: (axis: IAxis, value: any) => IDimensionInfo | null; + getRectByDimensionData?: (dimensionData: IDimensionData, layoutStartPoint: ILayoutPoint) => any; + + dispatchEvent?: (key: string, params?: any) => void; +} +``` + +相关定义：[ICompilableInitOption](AdditionalTypes-Type-Definition.md#type-f33e72c56cee)、[IEventDispatcher](AdditionalTypes-Type-Definition.md#type-e3c12fa8de7f)、[DataSet](AdditionalTypes-Type-Definition.md#type-8d2b64638b97)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[RenderMode](AdditionalTypes-Type-Definition.md#type-875ef0d8fcf4)、[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201)、[IChartSpecInfo](AdditionalTypes-Type-Definition.md#type-618e9dfe06cf)、[IRect](AdditionalTypes-Type-Definition.md#type-51a55b549762)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IChart](AdditionalTypes-Type-Definition.md#type-d27fa13b0c29)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[IGlobalScale](AdditionalTypes-Type-Definition.md#type-86e42efb33dd)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[ILayoutPoint](AdditionalTypes-Type-Definition.md#type-6dd6ef1acef0)、[IDimensionInfo](AdditionalTypes-Type-Definition.md#type-06b8a10af7b9)、[IAxis](AdditionalTypes-Type-Definition.md#type-9cbd2aefe72d)、[IDimensionData](AdditionalTypes-Type-Definition.md#type-5b72dbd75644) + + +## IModelSpec + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export type IModelSpec = ILayoutItemSpec & { id?: StringOrNumber }; +``` + +相关定义：[ILayoutItemSpec](AdditionalTypes-Type-Definition.md#type-31e5f8b69a13)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IModelSpecInfo + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IModelSpecInfo = any> { + /** model 具体类型 */ + type: string | ComponentTypeEnum | SeriesTypeEnum; + /** model spec */ + spec: T; + /** 该 spec 在图表 spec 上的路径 */ + specPath?: Array; + /** 该 spec 在图表 spec info 上的路径 */ + specInfoPath?: Array; + /** model 当前主题 */ + theme?: any; + /** model 对应的 region 索引 */ + regionIndexes?: number[]; + /** model 对应的 series 索引 */ + seriesIndexes?: number[]; +} +``` + +相关定义：[ComponentTypeEnum](AdditionalTypes-Type-Definition.md#type-da1c88fe2ca8)、[SeriesTypeEnum](AdditionalTypes-Type-Definition.md#type-11db701f3ba0) + + +## ITooltipHelper + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipHelper { + /** tooltip对应spec */ + spec: ITooltipSpec | undefined; + + /** 实际生效的tooltip activeType */ + activeType: TooltipActiveType[]; + + /** 可以响应mark tooltip或者dimension tooltip的对象 */ + activeTriggerSet: { + mark?: Set; + group?: Set; + }; + /** 不响应tooltip且不会影响已有tooltip的对象 */ + ignoreTriggerSet: { + mark?: Set; + }; + + /** 更新spec */ + updateTooltipSpec: () => void; +} +``` + +相关定义：[ITooltipSpec](ITooltipSpec-Type-Definition.md)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf) + + +## IUpdateSpecEffects + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IUpdateSpecEffects { + remake?: boolean; + compile?: boolean; + render?: boolean; + layout?: boolean; + data?: boolean; + scaleDomain?: boolean; + series?: boolean; + component?: boolean; + animation?: boolean; + localOnly?: boolean; +} +``` + + +## IUpdateSpecResult + +来源：`packages/vchart/src/model/interface.ts`，VChart 2.1.7 + +```typescript +export interface IUpdateSpecResult { + change: boolean; + reMake: boolean; + reRender?: boolean; + reSize?: boolean; + // TODO: compile 的判断应不应该出现在这里? + reCompile?: boolean; + reTransformSpec?: boolean; + effects?: IUpdateSpecEffects; + reAnimate?: boolean; + changeTheme?: boolean; + changeBackground?: boolean; +} +``` + +相关定义：[IUpdateSpecEffects](AdditionalTypes-Type-Definition.md#type-ebdfb7b1febc) + + +## IRegion + +来源：`packages/vchart/src/region/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRegion extends ILayoutModel { + //stack + getStackInverse: () => boolean; + getStackSort: () => boolean; + + getMaxWidth: () => number | undefined; + setMaxWidth: (value: number) => void; + getMaxHeight: () => number | undefined; + setMaxHeight: (value: number) => void; + + // 系列 + addSeries: (series: ISeries) => void; + removeSeries: (series: ISeries) => void; + + getSeries: (opt?: ISeriesFilter) => ISeries[]; + getSeriesInName: (name: string) => ISeries; + getSeriesInUserId: (userId: string) => ISeries; + getSeriesInId: (id: number) => ISeries; + getSeriesInType: (type: SeriesType) => ISeries[]; + getSeriesInCoordinateType: (type: CoordinateType) => ISeries[]; + getSeriesInDataName: (dataName: string) => ISeries[]; + + getMarks: () => IMark[]; + getGroupMark: () => IGroupMark; + getInteractionMark: () => IGroupMark; + + getSpecInfo: () => IRegionSpecInfo; +} +``` + +相关定义：[ILayoutModel](AdditionalTypes-Type-Definition.md#type-b788a1bf7960)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[ISeriesFilter](AdditionalTypes-Type-Definition.md#type-547a568e3f15)、[SeriesType](AdditionalTypes-Type-Definition.md#type-43422e48d197)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IGroupMark](AdditionalTypes-Type-Definition.md#type-8815337da68f)、[IRegionSpecInfo](AdditionalTypes-Type-Definition.md#type-dacf9d61a878) + + +## IRegionConstructor + +来源：`packages/vchart/src/region/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRegionConstructor extends IModelConstructor { + new (spec: IRegionSpec, ctx: IModelOption): IRegion; +} +``` + +相关定义：[IModelConstructor](AdditionalTypes-Type-Definition.md#type-b2886ff503c6)、[IRegionSpec](AdditionalTypes-Type-Definition.md#type-de53416bbb15)、[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24) + + +## IRegionSpec + +来源：`packages/vchart/src/region/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRegionSpec extends ILayoutItemSpec { + id?: StringOrNumber; + coordinate?: CoordinateType; + style?: ConvertToMarkStyleSpec; + /** + * 堆积时是否逆序 + * @default false + * @since 1.4.0 + */ + stackInverse?: boolean; + /** + * 堆积时是否排序 + * @default false + * @since 1.10.4 + */ + stackSort?: boolean; +} +``` + +相关定义：[ILayoutItemSpec](AdditionalTypes-Type-Definition.md#type-31e5f8b69a13)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b)、[ConvertToMarkStyleSpec](AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md) + + +## IRegionSpecInfo + +来源：`packages/vchart/src/region/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRegionSpecInfo extends IModelSpecInfo { + /** model 具体类型 */ + type: 'region'; + /** model spec */ + spec: T; +} +``` + +相关定义：[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a)、[RegionSpec](RegionSpec-Type-Definition.md)、[IRegionSpec](AdditionalTypes-Type-Definition.md#type-de53416bbb15) + + +## ISeriesFilter + +来源：`packages/vchart/src/region/interface.ts`，VChart 2.1.7 + +```typescript +export type ISeriesFilter = { + name?: string; + userId?: StringOrNumber | StringOrNumber[]; + specIndex?: number | number[]; + id?: number; + type?: string; + coordinateType?: CoordinateType; + dataName?: string; +}; +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b) + + +## IGlobalScale + +来源：`packages/vchart/src/scale/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGlobalScale { + color?: any; + getScale: (user_id: string) => IBaseScale | null; + getScaleSpec: (user_id: string) => IVisualSpecScale | null; + getStatisticalFields: (dataId: string) => { + key: string; + operations: StatisticOperations; + }[]; + updateScaleDomain: (string: unknown[]) => void; + + registerMarkAttributeScale: (spec: IVisualScale, seriesId: number) => IBaseScale; + + /** + * model add & remove global scale + * 提供给图表模块按照需要添加全局 scale。目前的使用场景有 scatter series 的 sizeField 和 shapeField 配置。 + */ + registerModelScale: (spec: IVisualSpecScale) => void; + removeModelScale: (filter: (spec: IVisualSpecScale) => boolean) => void; + + updateSpec: (spec: IChartSpec['scales']) => IUpdateSpecResult; +} +``` + +相关定义：[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[IVisualSpecScale](IVisualSpecScale-Type-Definition.md)、[StatisticOperations](AdditionalTypes-Type-Definition.md#type-d92fd69b2371)、[IVisualScale](AdditionalTypes-Type-Definition.md#type-d2a6fed8edde)、[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09)、[IUpdateSpecResult](AdditionalTypes-Type-Definition.md#type-646a207a21dd) + + +## AreaAppearPreset + +来源：`packages/vchart/src/series/area/interface.ts`，VChart 2.1.7 + +```typescript +export type AreaAppearPreset = 'clipIn' | 'fadeIn' | 'grow'; +``` + + +## AreaMarks + +来源：`packages/vchart/src/series/area/interface.ts`，VChart 2.1.7 + +```typescript +type AreaMarks = 'point' | 'line' | 'area'; +``` + + +## IAreaSeriesSpec + +来源：`packages/vchart/src/series/area/interface.ts`，VChart 2.1.7 + +```typescript +export interface IAreaSeriesSpec + extends ICartesianSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig, + IDataSamping, + IMarkOverlap { + /** + * 系列类型 + */ + type: 'area'; + /** + * x轴字段 + */ + xField?: string | string[]; + /** + * y轴字段 + */ + yField?: string | string[]; + /** + * 点图元配置 + */ + [SeriesMarkNameEnum.point]?: IMarkSpec; + /** + * 线图元配置 + */ + [SeriesMarkNameEnum.line]?: IMarkSpec; + /** + * 面积图元配置 + */ + [SeriesMarkNameEnum.area]?: IMarkSpec; + /** + * 标签配置 + * @since 1.13.1 新增支持 inside-middle 标签位置 + */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec< + Omit & { + /** + * 标签位置，面积图元支持的标签位置 + * */ + position: + | 'top' + | 'bottom' + | 'left' + | 'right' + | 'top-right' + | 'top-left' + | 'bottom-right' + | 'bottom-left' + | 'center' + | 'inside-middle'; + } + >; + /** + * 面积图元标签配置 + * @since 1.7.0 + */ + [SeriesMarkNameEnum.areaLabel]?: Omit & { + /** + * 面积图元标签的位置配置，支持两种位置： + * - start：面积图元的起点 + * - end：面积图元的终点 + */ + position?: 'start' | 'end'; + }; + /** + * 系列主 mark 类型配置，该配置会影响图例的展示 + * @default 'area' + * @since 1.2.0 + */ + seriesMark?: 'point' | 'line' | 'area'; + /** + * 是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点 + * @default false + * @since 1.3.0 + */ + activePoint?: boolean; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[AreaMarks](AdditionalTypes-Type-Definition.md#type-6b16760e15b0)、[AreaAppearPreset](AdditionalTypes-Type-Definition.md#type-1632d0cf5560)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IDataSamping](AdditionalTypes-Type-Definition.md#type-e33013d66ce5)、[IMarkOverlap](AdditionalTypes-Type-Definition.md#type-bed88451c0c6)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[IAreaMarkSpec](IAreaMarkSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILineLikeLabelSpec](ILineLikeLabelSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## BarAppearPreset + +来源：`packages/vchart/src/series/bar/interface.ts`，VChart 2.1.7 + +```typescript +export type BarAppearPreset = 'grow' | 'fadeIn' | 'scaleIn'; +``` + + +## BarMarks + +来源：`packages/vchart/src/series/bar/interface.ts`，VChart 2.1.7 + +```typescript +type BarMarks = 'bar'; +``` + + +## IBarBackgroundSpec + +来源：`packages/vchart/src/series/bar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBarBackgroundSpec { + /** + * 决定柱状背景图元是否显示在组的层级上，以及显示在哪个层级上。 + * 例如：在分组柱状图中，xField 为 `['A', 'B', 'C']`，如果配置为 0，则以 'A' 划分的每个组对应一个整体的 barBackground；如果配置为 1，则以 'B' 划分的每个组对应一个整体的 barBackground；如果配置为 2，则每个柱条对应一个 barBackground。 + * @since 1.9.0 + */ + fieldLevel?: number; +} +``` + + +## IBarSeriesSpec + +来源：`packages/vchart/src/series/bar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBarSeriesSpec + extends ICartesianSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig, + IDataSamping { + /** + * 系列类型 + */ + type: 'bar'; + /** + * x轴字段 + */ + xField?: string | string[]; + /** + * y轴字段 + */ + yField?: string | string[]; + /** + * 图元配置 + */ + [SeriesMarkNameEnum.bar]?: IMarkSpec; + /** + * 柱状背景图元 + * @since 1.6.0 + */ + [SeriesMarkNameEnum.barBackground]?: IMarkSpec & IBarBackgroundSpec; + /** 标签配置*/ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec< + Omit & { + /** + * 标签位置 + * @since 1.6.0 + * 支持'top-right' | 'top-left'| 'bottom-right' | 'bottom-left'，以及函数形式配置 + * */ + position?: Functional< + | 'outside' + | 'top' + | 'bottom' + | 'left' + | 'right' + | 'inside' + | 'inside-top' + | 'inside-bottom' + | 'inside-right' + | 'inside-left' + | 'top-right' + | 'top-left' + | 'bottom-right' + | 'bottom-left' + >; + } + >; + /** + * 柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale) + */ + barWidth?: number | string; + /** + * 柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale) + */ + barMinWidth?: number | string; + /** + * 柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale) + */ + barMaxWidth?: number | string; + /** + * 分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。 + * 当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。 + * 如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。 + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale) + * @since 1.2.0 + */ + barGapInGroup?: number | string | (number | string)[]; + + /** + * 柱条最小高度，可用于防止某数据项的值过小的视觉调整。 + * @since 1.4.0 + */ + barMinHeight?: number; + + /** + * 堆叠柱整体的圆角 @since 1.10.0 + * 圆角支持回调配置 @since 1.12.4 + */ + stackCornerRadius?: number | number[] | IStackCornerRadiusCallback; + + /** + * 柱条间 gap 值 @since 1.13.11 + */ + barGap?: number; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[BarMarks](AdditionalTypes-Type-Definition.md#type-d2964854c2a3)、[BarAppearPreset](AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IDataSamping](AdditionalTypes-Type-Definition.md#type-e33013d66ce5)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IBarBackgroundSpec](AdditionalTypes-Type-Definition.md#type-659e249e0870)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[Functional](AdditionalTypes-Type-Definition.md#type-2535a2dd9530)、[IStackCornerRadiusCallback](IStackCornerRadiusCallback-Type-Definition.md) + + +## IBoxPlotSeriesSpec + +来源：`packages/vchart/src/series/box-plot/interface.ts`，VChart 2.1.7 + +```typescript +export interface IBoxPlotSeriesSpec + extends Omit, + // TODO: 补充动画类型 @chengda + IAnimationSpec, + IMarkProgressiveConfig { + /** 系列类型 */ + type: 'boxPlot'; + direction?: DirectionType; + /** + *x轴字段（direction=vertical时生效） + */ + xField?: string | string[]; + /** + *y轴字段（direction=horizontal时生效） + */ + yField?: string | string[]; + /** + *最小值字段 + */ + minField?: string; + /** + *最大值字段 + */ + maxField?: string; + /** + *q1字段 + */ + q1Field?: string; + /** + *中位数字段 + */ + medianField?: string; + /** + *q3字段 + */ + q3Field?: string; + /** + * 异常值字段 + */ + outliersField?: string; + /** + * 图元配置 + */ + [SeriesMarkNameEnum.boxPlot]?: IMarkSpec; + /** + * 异常值图元配置 + * @since 2.0.10 + */ + [SeriesMarkNameEnum.outlier]?: IMarkSpec; + /** + * 异常值样式配置 + * @todo 将在未来版本中废弃，请使用 outlier 配置项代替 + */ + outliersStyle?: IOutlierMarkSpec; + + /** + * 宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比 + * @since 2.0.10 + */ + boxWidth?: number | string; + /** + * 最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比 + * @since 2.0.10 + */ + boxMinWidth?: number | string; + /** + * 最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比 + * @since 2.0.10 + */ + boxMaxWidth?: number | string; + + /** + * 分组箱线图中各个分组内的间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。 + * 1. number 类型，表示像素值 + * 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比 + * @since 2.0.10 + */ + boxGapInGroup?: number | string | (number | string)[]; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[SeriesMarkNameEnum.boxPlot](AdditionalTypes-Type-Definition.md#type-3b9e5d5f1ab0)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IBoxPlotMarkSpec](IBoxPlotMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IOutlierMarkSpec](IOutlierMarkSpec-Type-Definition.md) + + +## ICartesianSeriesSpec + +来源：`packages/vchart/src/series/cartesian/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICartesianSeriesSpec extends ISeriesSpec { + /** + * direction + * row means layout by rows，col means layout by columns + */ + direction?: DirectionType; + /** + * x轴字段 + */ + xField?: string | string[]; + /** + * 用于区间数据，声明区间末尾的数据字段。 + */ + x2Field?: string; + // 因为存在 direction + /** + * y轴字段 + * 运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度 + */ + yField?: string | string[]; + /** + * 用于区间数据，声明区间末尾的数据字段。 + */ + y2Field?: string; + + /** + * z轴字段 + * 用于3d散点图等 + */ + zField?: string | string[]; + + /** 是否将数据按照数轴排序 + * @default false + * @since 1.3.0 + */ + sortDataByAxis?: boolean; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9) + + +## CirclePackingAppearPreset + +来源：`packages/vchart/src/series/circle-packing/interface.ts`，VChart 2.1.7 + +```typescript +export type CirclePackingAppearPreset = 'growIn' | 'fadeIn'; +``` + + +## CirclePackingMark + +来源：`packages/vchart/src/series/circle-packing/interface.ts`，VChart 2.1.7 + +```typescript +export type CirclePackingMark = 'leaf' | 'nonLeaf' | 'label' | 'nonLeafLabel'; +``` + + +## ICirclePackingSeriesSpec + +来源：`packages/vchart/src/series/circle-packing/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICirclePackingSeriesSpec + extends ISeriesSpec, + IAnimationSpec { + type: 'circlePacking'; + + /** + * 分类字段 + * @requires + */ + categoryField: string; + + /** + * 权重字段 + * @requires + */ + valueField: string; + + /** + * 层内边距 + * @default 5 + * @description 支持传入数组, 单独控制某一层的内边距 + */ + layoutPadding?: number | number[]; + + /** + * 标签配置 + * @description 对所有层生效 + */ + [SeriesMarkNameEnum.label]?: IMarkSpec; + + /** + * 图元配置 + */ + [SeriesMarkNameEnum.circlePacking]?: IMarkSpec; + + /** + * 下钻配置 + * @default false + * @description 下钻功能开关 + */ + drill?: boolean; + /** + * 钻取字段的field + * @default DEFAULT_DATA_KEY + * @description 通过API进行钻取, 需要此配置项. + */ + drillField?: string; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[CirclePackingMark](AdditionalTypes-Type-Definition.md#type-c5aa6f08af16)、[CirclePackingAppearPreset](AdditionalTypes-Type-Definition.md#type-b9b1dad57548)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md) + + +## CorrelationAppearPreset + +来源：`packages/vchart/src/series/correlation/interface.ts`，VChart 2.1.7 + +```typescript +export type CorrelationAppearPreset = 'scaleIn' | 'fadeIn'; +``` + + +## CorrelationMarks + +来源：`packages/vchart/src/series/correlation/interface.ts`，VChart 2.1.7 + +```typescript +export type CorrelationMarks = 'point' | 'label'; +``` + + +## ICorrelationSeriesSpec + +来源：`packages/vchart/src/series/correlation/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICorrelationSeriesSpec + extends Omit, + IAnimationSpec { + /** + * @since 1.5.1 + * 系列类型 + */ + type: 'correlation'; + + /** + * 数据字段配置 + */ + /** 节点名称字段配置 */ + categoryField: string; + /** 相关性数据字段配置 */ + valueField: string; + /** 节点系列字段配置 */ + seriesField?: string; + /** 节点尺寸数据字段配置 */ + sizeField?: string; + /** 节点尺寸映射范围 */ + sizeRange?: number[]; + + /** + * layout & position + */ + /** 图表中心点位置X坐标 */ + centerX?: number; + /** 图表中心点位置Y坐标 */ + centerY?: number; + /** 节点分布内半径 */ + innerRadius?: string | number; + /** 节点分布外半径 */ + outerRadius?: string | number; + /** 图表起始角度 */ + startAngle?: number; + /** 图表终止角度 */ + endAngle?: number; + + /** + * 图元配置 + */ + /** 中心点图元属性 **/ + [SeriesMarkNameEnum.centerPoint]?: IMarkSpec; + /** 水波纹图元属性 **/ + [SeriesMarkNameEnum.ripplePoint]?: IMarkSpec; + /** 中心点label属性 **/ + [SeriesMarkNameEnum.centerLabel]?: ILabelSpec & { + /** 标签位置 */ + position?: + | 'top' + | 'bottom' + | 'left' + | 'right' + | 'top-right' + | 'top-left' + | 'bottom-right' + | 'bottom-left' + | 'center'; + }; + + /** 节点图元属性 **/ + [SeriesMarkNameEnum.nodePoint]?: IMarkSpec; + /** 标签配置 */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec< + ILabelSpec & { + /** 标签位置 */ + position?: + | 'top' + | 'bottom' + | 'left' + | 'right' + | 'top-right' + | 'top-left' + | 'bottom-right' + | 'bottom-left' + | 'center'; + } + >; +} +``` + +相关定义：[IPolarSeriesSpec](AdditionalTypes-Type-Definition.md#type-1ed415b7c25f)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[CorrelationMarks](AdditionalTypes-Type-Definition.md#type-bdf6cade9a59)、[CorrelationAppearPreset](AdditionalTypes-Type-Definition.md#type-9e370720e4c3)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IRippleMarkSpec](IRippleMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md) + + +## FunnelAppearPreset + +来源：`packages/vchart/src/series/funnel/interface.ts`，VChart 2.1.7 + +```typescript +export type FunnelAppearPreset = 'clipIn' | 'fadeIn'; +``` + + +## FunnelMarks + +来源：`packages/vchart/src/series/funnel/interface.ts`，VChart 2.1.7 + +```typescript +type FunnelMarks = 'funnel'; +``` + + +## IFunnelSeriesSpec + +来源：`packages/vchart/src/series/funnel/interface.ts`，VChart 2.1.7 + +```typescript +export interface IFunnelSeriesSpec extends ISeriesSpec, IAnimationSpec { + type: 'funnel'; + /** + * 分类字段 + */ + categoryField: string; + /** + * 数值字段 + */ + valueField: string; + /** + * 漏斗图朝向。 + * @default 'top' + */ + funnelOrient?: IOrientType; + /** + * 图元形状。转化漏斗图仅支持 'rect' + * @default 'trapezoid' + */ + shape?: 'rect' | 'trapezoid'; + /** + * 是否是转化漏斗图 + * @default false + */ + isTransform?: boolean; + /** + * 漏斗图最下层是否尖角。shape为`rect`时不生效 + * @default true + */ + isCone?: boolean; + /** + * 漏斗图对齐方式。转化漏斗图仅支持'center' + * @default 'center' + */ + funnelAlign?: 'left' | 'center' | 'right'; + /** + * 漏斗层之间的像素间隔。转化漏斗图不支持gap配置。 + * @default 0 + */ + gap?: number; + /** + * 指定数值映射范围，range.min 映射到 minSize，range.max 映射到 maxSize。 + * range.min 默认为 0，range.max 默认为数据最大值。 + */ + range?: { + min?: number; + max?: number; + }; + /** + * 漏斗图最大宽度，支持配置像素值和百分比字符串。 + * @default '80%' + */ + maxSize?: number | IPercent; + /** + * 漏斗图最小宽度，支持配置像素值和百分比字符串。 + * @default 0 + */ + minSize?: number | IPercent; + /** + * 漏斗层与转化层的图形高度比例 + * The height ratio between the funnel graphic and the transform graphic + * @default 0.5 + * @since 1.10.1 + */ + heightRatio?: number; + /** + * 漏斗图转化率文案，用于转化层 tooltip key 的显示内容 + * @since 1.13.6 + * @default '转化率' + * */ + transformRatioText?: string; + /** + * 漏斗层样式 + */ + [SeriesMarkNameEnum.funnel]?: IMarkSpec; + /** + * 转化层样式 + */ + [SeriesMarkNameEnum.transform]?: IMarkSpec; + /** + * 漏斗层标签配置 + */ + [SeriesMarkNameEnum.label]?: IFunnelLabelSpec; + /** + * 漏斗层外部标签配置 + */ + [SeriesMarkNameEnum.outerLabel]?: IFunnelOuterLabelSpec; + /** + * 转化层标签配置 + */ + [SeriesMarkNameEnum.transformLabel]?: IFunnelLabelSpec; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[FunnelMarks](AdditionalTypes-Type-Definition.md#type-c0065cc5144e)、[FunnelAppearPreset](AdditionalTypes-Type-Definition.md#type-ca0d8e9e8ab0)、[IOrientType](AdditionalTypes-Type-Definition.md#type-1c1f18d62ff6)、[IPercent](IPercent-Type-Definition.md)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md)、[IFunnelLabelSpec](IFunnelLabelSpec-Type-Definition.md)、[IFunnelOuterLabelSpec](IFunnelOuterLabelSpec-Type-Definition.md) + + +## GaugeMarks + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export type GaugeMarks = 'segment' | 'track'; +``` + + +## GaugePointerMarks + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export type GaugePointerMarks = 'pointer' | 'pin' | 'pinBackground'; +``` + + +## IGaugeLabelSpec + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export type IGaugeLabelSpec = ILabelSpec; +``` + +相关定义：[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## IGaugePointerSeriesSpec + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGaugePointerSeriesSpec + extends IProgressLikeSeriesSpec, + IAnimationSpec { + type: 'gaugePointer'; + + /** 数值字段（可影响指针角度） */ + valueField: string | string[]; + + /** 半径字段（可影响指针长度，GaugePointerSeries 没有 categoryField） */ + radiusField: string; + + /** 图钉前景样式 */ + [SeriesMarkNameEnum.pin]?: IMarkSpec & PinMarkSpec; + /** 图钉背景样式 */ + [SeriesMarkNameEnum.pinBackground]?: IMarkSpec & PinMarkSpec; + /** 指针样式 */ + [SeriesMarkNameEnum.pointer]?: IMarkSpec & PointerMarkSpec; +} +``` + +相关定义：[IProgressLikeSeriesSpec](AdditionalTypes-Type-Definition.md#type-d7ad84462ce9)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[GaugePointerMarks](AdditionalTypes-Type-Definition.md#type-1acef37a74c3)、[ProgressLikeAppearPreset](AdditionalTypes-Type-Definition.md#type-eb112c7e9a22)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md)、[PinMarkSpec](AdditionalTypes-Type-Definition.md#type-d46655d2cdbe)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[PointerMarkSpec](AdditionalTypes-Type-Definition.md#type-f4b734667103) + + +## IGaugeSeriesSpec + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export interface IGaugeSeriesSpec + extends IProgressLikeSeriesSpec, + IAnimationSpec { + type: 'gauge'; + + /** 扇区间隔角度 */ + padAngle?: number; + + /** 扇区样式 */ + [SeriesMarkNameEnum.segment]?: IMarkSpec; + /** 背景样式 */ + [SeriesMarkNameEnum.track]?: IMarkSpec; + /** 标签样式 */ + [SeriesMarkNameEnum.label]?: IGaugeLabelSpec; +} +``` + +相关定义：[IProgressLikeSeriesSpec](AdditionalTypes-Type-Definition.md#type-d7ad84462ce9)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[GaugeMarks](AdditionalTypes-Type-Definition.md#type-258bf98aa33b)、[ProgressLikeAppearPreset](AdditionalTypes-Type-Definition.md#type-eb112c7e9a22)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IGaugeLabelSpec](AdditionalTypes-Type-Definition.md#type-a11bb56c1a44) + + +## PinMarkSpec + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export type PinMarkSpec = { + /** 宽度 */ + width?: number; + /** 高度 */ + height?: number; + /** 是否定位于极坐标系的中心，默认为 true。如果为 false，则位置受 innerRadius 影响 */ + isOnCenter?: boolean; +}; +``` + + +## PointerMarkSpec + +来源：`packages/vchart/src/series/gauge/interface.ts`，VChart 2.1.7 + +```typescript +export type PointerMarkSpec = { + type?: 'path' | 'rect'; + + /** 指针宽度比例（0~1） */ + width?: number; + /** 指针长度比例（0~1）（为空则挂载 radius） */ + height?: number; + /** 指针靠近圆心的一端离圆心的距离 */ + innerPadding?: number; + /** 指针靠近边缘的一端离边缘的距离 */ + outerPadding?: number; + + /** 中心点坐标（0~1） */ + center?: [number, number]; + + /** 是否定位于极坐标系的中心，默认为 true。如果为 false，则位置受 innerRadius 影响 */ + isOnCenter?: boolean; +}; +``` + + +## HeatmapAppearPreset + +来源：`packages/vchart/src/series/heatmap/interface.ts`，VChart 2.1.7 + +```typescript +export type HeatmapAppearPreset = 'fadeIn'; +``` + + +## HeatmapMarks + +来源：`packages/vchart/src/series/heatmap/interface.ts`，VChart 2.1.7 + +```typescript +type HeatmapMarks = 'cell' | 'background' | 'label'; +``` + + +## IHeatmapSeriesSpec + +来源：`packages/vchart/src/series/heatmap/interface.ts`，VChart 2.1.7 + +```typescript +export interface IHeatmapSeriesSpec + extends ICartesianSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig { + /** + * 系列类型 + */ + type: 'heatmap'; + + /** 值 field */ + valueField?: string; + + /** 图元配置 */ + [SeriesMarkNameEnum.cell]?: IMarkSpec; + + /** 图元背景配置 */ + [SeriesMarkNameEnum.cellBackground]?: IMarkSpec; + + /** 标签配置*/ + [SeriesMarkNameEnum.label]?: ILabelSpec & { + /** 标签位置 */ + position?: 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left'; + }; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[HeatmapMarks](AdditionalTypes-Type-Definition.md#type-5bfb84e5033a)、[HeatmapAppearPreset](AdditionalTypes-Type-Definition.md#type-a73edb9100ac)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## ISeriesConstructor + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesConstructor extends IModelConstructor { + readonly type: string; + mark?: SeriesMarkMap; + new (spec: any, options: ISeriesOption): ISeries; +} +``` + +相关定义：[IModelConstructor](AdditionalTypes-Type-Definition.md#type-b2886ff503c6)、[SeriesMarkMap](AdditionalTypes-Type-Definition.md#type-90c30713a8c3)、[ISeriesOption](AdditionalTypes-Type-Definition.md#type-12b6b1d47870)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0) + + +## ISeriesMarkInfo + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesMarkInfo extends IModelMarkInfo { + /** mark 名称 */ + name: SeriesMarkNameEnum | string; +} +``` + +相关定义：[IModelMarkInfo](AdditionalTypes-Type-Definition.md#type-c6d245a05c0a)、[SeriesMarkNameEnum](AdditionalTypes-Type-Definition.md#type-df86033a747f) + + +## ISeriesOption + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesOption extends IModelOption { + mode: RenderMode; + region: IRegion; + sourceDataList: DataView[]; + getSeriesData: (id: StringOrNumber | undefined, index: number | undefined) => DataView | undefined; +} +``` + +相关定义：[IModelOption](AdditionalTypes-Type-Definition.md#type-f2d5e89f0268)、[RenderMode](AdditionalTypes-Type-Definition.md#type-875ef0d8fcf4)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## ISeriesSeriesInfo + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesSeriesInfo { + key: string; + /** 直接取 datum 里的原始值 */ + originalKey: any; + datum?: Datum; + index?: number; + // 样式的值类型可能是 StringOrNumber | number[] | xxxx + style: (attribute: string) => any; + /** series 对应的缩略图类型 */ + shapeType: string; +} +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61) + + +## ISeriesSpecInfo + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesSpecInfo + extends IModelSpecInfo, + ISeriesSpecTransformerResult { + /** model 具体类型 */ + type: string | SeriesTypeEnum; + /** model spec */ + spec: T; + /** model theme */ + theme: any; +} +``` + +相关定义：[IModelSpecInfo](AdditionalTypes-Type-Definition.md#type-854f78cb6f0a)、[ISeriesSpecTransformerResult](AdditionalTypes-Type-Definition.md#type-bcafdba3ac92)、[SeriesTypeEnum](AdditionalTypes-Type-Definition.md#type-11db701f3ba0)、[ISeriesSpec](ISeriesSpec-Type-Definition.md) + + +## ISeriesSpecTransformerResult + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesSpecTransformerResult extends IBaseModelSpecTransformerResult { + /** 当前的 mark 标签 spec */ + markLabelSpec?: Partial>; + /** 是否堆叠 */ + stack?: boolean; +} +``` + +相关定义：[IBaseModelSpecTransformerResult](AdditionalTypes-Type-Definition.md#type-9be6c667e373)、[SeriesMarkNameEnum](AdditionalTypes-Type-Definition.md#type-df86033a747f)、[TransformedLabelSpec](AdditionalTypes-Type-Definition.md#type-cc4522eb0b63) + + +## ISeriesStackData + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export type ISeriesStackData = ISeriesStackDataNode; +``` + +相关定义：[ISeriesStackDataNode](AdditionalTypes-Type-Definition.md#type-234297d4a62a) + + +## ISeriesStackDataLeaf + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesStackDataLeaf { + groupField?: string; + values: any[]; + total?: number; +} +``` + + +## ISeriesStackDataMeta + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export type ISeriesStackDataMeta = ISeriesStackDataNode | ISeriesStackDataLeaf; +``` + +相关定义：[ISeriesStackDataNode](AdditionalTypes-Type-Definition.md#type-234297d4a62a)、[ISeriesStackDataLeaf](AdditionalTypes-Type-Definition.md#type-17aca4fa17c9) + + +## ISeriesStackDataNode + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesStackDataNode { + groupField?: string; + nodes: { + [key: string]: ISeriesStackDataMeta; + }; +} +``` + +相关定义：[ISeriesStackDataMeta](AdditionalTypes-Type-Definition.md#type-9aad3a641385) + + +## SeriesMarkMap + +来源：`packages/vchart/src/series/interface/common.ts`，VChart 2.1.7 + +```typescript +export type SeriesMarkMap = Partial>; +``` + +相关定义：[SeriesMarkNameEnum](AdditionalTypes-Type-Definition.md#type-df86033a747f)、[ISeriesMarkInfo](AdditionalTypes-Type-Definition.md#type-2d3d647d41bf) + + +## ICartesianSeries + +来源：`packages/vchart/src/series/interface/series.ts`，VChart 2.1.7 + +```typescript +export interface ICartesianSeries extends ISeries { + readonly coordinate: 'cartesian'; + readonly direction: DirectionType; + + scaleX: IBaseScale; + setScaleX: (s: IBaseScale) => void; + scaleY: IBaseScale; + setScaleY: (s: IBaseScale) => void; + scaleZ?: IBaseScale; + setScaleZ: (s: IBaseScale) => void; + // 要考虑基于多个field的场景 + fieldX: string[]; + setFieldX: (field: string | string[], level?: number) => void; + fieldX2: string; + setFieldX2: (field: string) => void; + fieldY: string[]; + setFieldY: (field: string | string[], level?: number) => void; + fieldY2: string; + setFieldY2: (field: string) => void; + fieldZ?: string[]; + setFieldZ: (field: string | string[], level?: number) => void; + + positionToData: (p: IPoint) => any | null; + positionToDataX: (xPos: number) => any | null; + positionToDataY: (yPos: number) => any | null; + + // 轴API + getXAxisHelper: () => IAxisHelper; + setXAxisHelper: (h: IAxisHelper) => void; + getYAxisHelper: () => IAxisHelper; + setYAxisHelper: (h: IAxisHelper) => void; + getZAxisHelper: () => IAxisHelper | undefined; + setZAxisHelper: (h: IAxisHelper) => void; + + dataToPositionX1: (datum: Datum) => number | null; + dataToPositionY1: (datum: Datum) => number | null; + + valueToPosition: (value1: any, value2: any) => IPoint; + valueToPositionX: (value: StringOrNumber | StringOrNumber[], datum?: any) => any; + valueToPositionY: (value: StringOrNumber | StringOrNumber[], datum?: any) => any; +} +``` + +相关定义：[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[IAxisHelper](AdditionalTypes-Type-Definition.md#type-a26561e1568e)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IGeoSeries + +来源：`packages/vchart/src/series/interface/series.ts`，VChart 2.1.7 + +```typescript +export interface IGeoSeries extends ISeries { + readonly coordinate: 'geo'; + + nameField?: string; + valueField?: string; + + getMapViewData: () => DataView; + getNameProperty: () => string; + + dataToPosition: (datum: any, checkInViewData?: boolean) => IPoint | null; + dataToLatitude: (latValue: any) => number | null; + dataToLongitude: (lonValue: any) => number | null; + nameValueToPosition: (name: string) => IPoint | null; + + positionToData: (p: IPoint) => any; + latitudeToData: (lat: number) => any; + longitudeToData: (lon: number) => any; + + getCoordinateHelper: () => IGeoCoordinateHelper; + setCoordinateHelper: (helper: IGeoCoordinateHelper) => void; + + valueToPosition: (value1: any, value2: any) => IPoint; + getDatumCenter: (datum: any) => [number, number]; +} +``` + +相关定义：[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[IGeoCoordinateHelper](AdditionalTypes-Type-Definition.md#type-73cca056070b) + + +## IPolarSeries + +来源：`packages/vchart/src/series/interface/series.ts`，VChart 2.1.7 + +```typescript +export interface IPolarSeries extends ISeries { + readonly coordinate: 'polar'; + + outerRadius: number; + innerRadius: number; + + getRadiusField: () => string[]; + setRadiusField: (field: string | string[], level?: number) => void; + getAngleField: () => string[]; + setAngleField: (field: string | string[], level?: number) => void; + + // 轴将是一个实现了 scale 的组件。这里接收的可以是一个轴 + radiusScale: IBaseScale; + setRadiusScale: (s: IBaseScale) => void; + angleScale: IBaseScale; + setAngleScale: (s: IBaseScale) => void; + + // TODO: + positionToData: (point: IPolarPoint) => any; + radiusToData: (radius: number) => any; + angleToData: (angle: number) => any; + + // 轴 + radiusAxisHelper: IPolarAxisHelper; + angleAxisHelper: IPolarAxisHelper; + + valueToPosition: (value1: any, value2: any) => IPoint; +} +``` + +相关定义：[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[IPolarPoint](AdditionalTypes-Type-Definition.md#type-d403c828183d)、[IPolarAxisHelper](AdditionalTypes-Type-Definition.md#type-2617700989c6)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b) + + +## ISeries + +来源：`packages/vchart/src/series/interface/series.ts`，VChart 2.1.7 + +```typescript +export interface ISeries extends IModel { + readonly type: string; + readonly name?: string; + + // tooltip + tooltipHelper: ISeriesTooltipHelper; + + // 配置 + getSpec: () => any; + + // 坐标系信息 + readonly coordinate: CoordinateType; + + // layout + onLayoutEnd: () => void; + + // 数据 + getRawData: () => DataView | undefined; + getViewDataFilter: () => DataView | undefined; + getViewData: () => DataView | undefined; + getViewDataProductId: () => string | undefined; + getRawDataStatisticsByField: (field: string, isNumeric?: boolean) => { values?: any[]; min?: number; max?: number }; + getViewDataStatistics?: () => DataView | undefined; + getDataSet?: () => DataSet; + getFieldAlias: (field: string) => string; + // 更新原始数据 + updateRawData: (d: any) => void; + setData?: (dv: DataView) => void; + rawDataUpdate: (d: DataView) => void; + viewDataUpdate: (d: DataView) => void; + viewDataStatisticsUpdate: (d: DataView) => void; + addViewDataFilter: (option: ITransformOptions) => void; + reFilterViewData: () => void; + reTransformViewData: () => void; + fillData: () => void; + isHierarchyData?: () => boolean; + getMarkData?: (d: Datum) => Datum; + + /** + * 常见数据使用问题 + * + * 一、使用图表最终展示数据 + * 比如 markline，数值轴 这样的组件 + * 需要操作展示数据，做 筛选 ｜ 变换 的 + * 比如图例，datazoom + series.getViewData().transform({},false) + * 需要获取展示数据，生成自身数据做自身展示的 使用消息机制。比如 轴 + series.event.on('viewDataStatisticsUpdate' ｜ 'viewDataUpdate', { filter: ({ model }) => model?.id === series.id }, () => { + this.updateData(); + }); + * + * 二、使用图表原始数据 + * 比如图例，datazoom + * 需要使用原始数据信息，生成自身数据 + * 比如图例，datazoom + series.getRawData().parserData ｜ latestData // parserData latestData 区别见下面说明 + series.getRawDataStatistics().latestData + + series.event.on('rawDataUpdate', { filter: ({ model }) => model?.id === series.id }, () => { + this.updateData(); + }); + * 或者使用系列自身的特殊api 特殊情况外不建议这样用 + series.getSeriesInfoList() + + * 建议：使用数据时需要注意数据更新，使用系列数据更新组件数据的场景，只建议使用消息监听 + series.event.on( + 'viewDataStatisticsUpdate' ｜ + 'viewDataUpdate' | + 'rawDataUpdate', + { filter: ({ model }) => model?.id === series.id }) + */ + + // 区域 + getRegion: () => IRegion; + + // mark + initMark: () => void; + getMarks: () => IMark[]; + getMarksWithoutRoot: () => IMark[]; + getMarkNameMap: () => Record; + getMarksInType: (type: string | string[]) => IMark[]; + getMarkInName: (name: string) => IMark | undefined; + getMarkInId: (id: number) => IMark | undefined; + + getRootMark: () => IGroupMark; + getActiveMarks: () => IMark[]; + getSeriesMark: () => IMark; + + // example + /** + * [ + * { + * fields: { + * x: '周一', + * __VChart_STACK: 'stack' + * }, + * valueField: 'y', + * values: [{x: '周一', y: 20}]; + * }, + * { + * fields: { + * x: '周一', + * stack: 'stackA' + * }, + * valueField: 'y', + * values: [{x: '周一', y: 20, stack: 'stackA'}]; + * }, + * { + * fields: { + * x: '周一', + * stack: 'stackB' + * }, + * valueField: 'y', + * values: [{x: '周一', y: 20, stack: 'stackB'}]; + * }, + * ] + */ + getStackData: () => ISeriesStackData; + + getStack: () => boolean; + getStackValue: () => StringOrNumber | undefined; + getPercent: () => boolean; + getStackOffsetSilhouette: () => boolean; + + getStackValueField: () => string; + setValueFieldToStack: () => void; + setValueFieldToPercent: () => void; + setValueFieldToStackOffsetSilhouette: () => void; + + getStackGroupFields: () => string[]; + getSeriesField: () => string | undefined; + getSeriesKeys: () => string[]; + getSeriesStyle: (datum: Datum) => ISeriesSeriesInfo['style']; + getSeriesInfoInField: (field: string) => ISeriesSeriesInfo[]; + getSeriesInfoList: () => ISeriesSeriesInfo[]; + getGroups: () => IGroup | undefined; + getDimensionField: () => string[]; + getMeasureField: () => string[]; + getStatisticFields: () => { key: string; operations: StatisticOperations }[]; + getDatumPositionValues: (datum: Datum, fields: string | string[]) => any[]; + getDatumPositionValue: (datum: Datum, field: string) => any; + + setSeriesField: (field: string) => void; + handleZoom?: (e: ZoomEventParam) => void; + handlePan?: (e: PanEventParam) => void; + + // 数据映射 + dataToPosition: (datum: Datum, checkInViewData?: boolean) => IPoint | null; + dataToPositionX: (datum: Datum) => number | null; + dataToPositionY: (datum: Datum) => number | null; + dataToPositionZ?: (datum: Datum) => number | null; + valueToPosition: (value1: any, value2?: any) => IPoint; + + getColorAttribute: () => { scale: IBaseScale; field: string }; + getDefaultColorDomain: () => any[]; + + getInvalidType: () => IInvalidType; + + // 交互 + + /** + * 获取系列默认的缩略图形 + * @returns 默认的缩略图形 + */ + getDefaultShapeType: () => string; + /** 获取系列标签配置 */ + initLabelMarkStyle?: (labelMark: ILabelMark, labelSpec: ILabelSpec) => void; + /** 设置总计标签配置 */ + initTotalLabelMarkStyle?: (labelMark: ILabelMark) => void; + getTotalLabelComponentStyle?: (info: Pick) => any; + + getGroupFields: () => string[]; + + getSpecInfo: () => ISeriesSpecInfo; + getMarkAttributeContext: () => ISeriesMarkAttributeContext; + + getSeriesFieldValue: (datum: Datum, seriesField?: string) => any; + + legendSelectedFilter?: (component: ILegend, selectedKeys: StringOrNumber[]) => StringOrNumber[]; + parseLabelStyle?: (labelStyle: any, labelSpec: any, labelMark?: ILabelMark) => any; + + getInteractionTriggers?: () => { trigger: Partial; marks: IMark[] }[]; +} +``` + +相关定义：[IModel](AdditionalTypes-Type-Definition.md#type-2854a5da67ea)、[ISeriesTooltipHelper](AdditionalTypes-Type-Definition.md#type-bdf90758165d)、[CoordinateType](AdditionalTypes-Type-Definition.md#type-f14ee29f7b8b)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[DataSet](AdditionalTypes-Type-Definition.md#type-8d2b64638b97)、[ITransformOptions](AdditionalTypes-Type-Definition.md#type-f4b40ca0e8cc)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IRegion](AdditionalTypes-Type-Definition.md#type-a83d28f54f24)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf)、[IGroupMark](AdditionalTypes-Type-Definition.md#type-8815337da68f)、[ISeriesStackData](AdditionalTypes-Type-Definition.md#type-7770159e04bb)、[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[ISeriesSeriesInfo](AdditionalTypes-Type-Definition.md#type-4d7144f1b638)、[IGroup](AdditionalTypes-Type-Definition.md#type-7066ab370b9d)、[StatisticOperations](AdditionalTypes-Type-Definition.md#type-d92fd69b2371)、[ZoomEventParam](AdditionalTypes-Type-Definition.md#type-e212628531e0)、[PanEventParam](AdditionalTypes-Type-Definition.md#type-fd27c5f76824)、[IPoint](AdditionalTypes-Type-Definition.md#type-58fdfd9a6a7b)、[IBaseScale](AdditionalTypes-Type-Definition.md#type-f4ea6ab4e67d)、[IInvalidType](AdditionalTypes-Type-Definition.md#type-5ea94ba3721c)、[ILabelMark](AdditionalTypes-Type-Definition.md#type-e9520a36483b)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[ILabelInfo](AdditionalTypes-Type-Definition.md#type-c5e997daff79)、[ISeriesSpecInfo](AdditionalTypes-Type-Definition.md#type-94e8317ff02e)、[ISeriesMarkAttributeContext](AdditionalTypes-Type-Definition.md#type-57ff7f1e0f2e)、[ILegend](AdditionalTypes-Type-Definition.md#type-a385f1cab926)、[IBaseTriggerOptions](AdditionalTypes-Type-Definition.md#type-f51a72b7d484) + + +## SeriesTypeForThemeEnum + +来源：`packages/vchart/src/series/interface/theme.ts`，VChart 2.1.7 + +```typescript +export enum SeriesTypeForThemeEnum { + area_horizontal = 'area_horizontal', + area_vertical = 'area_vertical', + area_stack = 'area_stack', + + line_horizontal = 'line_horizontal', + line_vertical = 'line_vertical', + line_stack = 'line_stack', + + bar_horizontal = 'bar_horizontal', + bar_vertical = 'bar_vertical', + bar_stack = 'bar_stack', + + rangeColumn_horizontal = 'rangeColumn_horizontal', + rangeColumn_vertical = 'rangeColumn_vertical', + + rangeArea_horizontal = 'rangeArea_horizontal', + rangeArea_vertical = 'rangeArea_vertical', + + linearProgress_horizontal = 'linearProgress_horizontal', + linearProgress_vertical = 'linearProgress_vertical', + linearProgress_stack = 'linearProgress_stack', + + boxPlot_horizontal = 'boxPlot_horizontal', + boxPlot_vertical = 'boxPlot_vertical', + + sankey_horizontal = 'sankey_horizontal', + sankey_vertical = 'sankey_vertical', + + waterfall_horizontal = 'waterfall_horizontal', + waterfall_vertical = 'waterfall_vertical', + + circularProgress_stack = 'circularProgress_stack', + + radar_stack = 'radar_stack', + rose_stack = 'rose_stack' +} +``` + + +## ISeriesTooltipHelper + +来源：`packages/vchart/src/series/interface/tooltip-helper.ts`，VChart 2.1.7 + +```typescript +export interface ISeriesTooltipHelper extends ITooltipHelper { + /** 对应系列 */ + series: ISeries; + + getTooltipData: ( + activeType: TooltipActiveType, + chartTooltipSpec?: ITooltipSpec, + allData?: TooltipData, + datum?: Datum[], + params?: TooltipHandlerParams + ) => ITooltipActual | null; + + // 可以继承的原子化回调 + markTooltipKeyCallback: TooltipContentCallback; + markTooltipValueCallback: TooltipContentCallback; + shapeTypeCallback: TooltipContentCallback; + shapeColorCallback: TooltipContentCallback; + shapeStrokeCallback: TooltipContentCallback; + dimensionTooltipTitleCallback: TooltipContentCallback; + groupTooltipTitleCallback: TooltipContentCallback; + groupTooltipKeyCallback: TooltipContentCallback; +} +``` + +相关定义：[ITooltipHelper](AdditionalTypes-Type-Definition.md#type-47faea1d542e)、[ISeries](AdditionalTypes-Type-Definition.md#type-29ca9e871dc0)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[ITooltipSpec](ITooltipSpec-Type-Definition.md)、[TooltipData](AdditionalTypes-Type-Definition.md#type-2020c8fc6cbe)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[TooltipHandlerParams](AdditionalTypes-Type-Definition.md#type-82517d84c2af)、[ITooltipActual](AdditionalTypes-Type-Definition.md#type-b6803f56a729)、[TooltipContentCallback](AdditionalTypes-Type-Definition.md#type-bb854deb9020)、[ShapeType](ShapeType-Type-Definition.md) + + +## SeriesMarkNameEnum + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +export const enum SeriesMarkNameEnum { + label = 'label', + point = 'point', + line = 'line', + area = 'area', + bar = 'bar', + boxPlot = 'boxPlot', + outlier = 'outlier', + circlePacking = 'circlePacking', + group = 'group', + gridBackground = 'gridBackground', + grid = 'grid', + dot = 'dot', + title = 'title', + subTitle = 'subTitle', + symbol = 'symbol', + funnel = 'funnel', + transform = 'transform', + transformLabel = 'transformLabel', + outerLabel = 'outerLabel', + outerLabelLine = 'outerLabelLine', + pin = 'pin', + pinBackground = 'pinBackground', + pointer = 'pointer', + segment = 'segment', + track = 'track', + cell = 'cell', + cellBackground = 'cellBackground', + link = 'link', + curveLink = 'curveLink', + imageLabel = 'imageLabel', + arrow = 'arrow', + pie = 'pie', + labelLine = 'labelLine', + progress = 'progress', + minLabel = 'minLabel', + maxLabel = 'maxLabel', + rose = 'rose', + node = 'node', + sunburst = 'sunburst', + nonLeaf = 'nonLeaf', + leaf = 'leaf', + nonLeafLabel = 'nonLeafLabel', + leaderLine = 'leaderLine', + stackLabel = 'stackLabel', + word = 'word', + fillingWord = 'fillingWord', + wordMask = 'wordMask', + nodePoint = 'nodePoint', + ripplePoint = 'ripplePoint', + centerPoint = 'centerPoint', + centerLabel = 'centerLabel', + barBackground = 'barBackground', + lineLabel = 'lineLabel', + areaLabel = 'areaLabel', + liquidGroup = 'liquidGroup', + liquid = 'liquid', + liquidBackground = 'liquidBackground', + liquidOutline = 'liquidOutline', + circle = 'circle', + overlap = 'overlap', + overlapLabel = 'overlapLabel' +} +``` + + +## boxPlot + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +boxPlot = 'boxPlot' +``` + + +## progress + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +progress = 'progress' +``` + + +## track + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +track = 'track' +``` + + +## word + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +word = 'word' +``` + + +## SeriesType + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +export type SeriesType = keyof typeof SeriesTypeEnum | string; +``` + +相关定义：[SeriesTypeEnum](AdditionalTypes-Type-Definition.md#type-11db701f3ba0) + + +## SeriesTypeEnum + +来源：`packages/vchart/src/series/interface/type.ts`，VChart 2.1.7 + +```typescript +export enum SeriesTypeEnum { + area = 'area', + line = 'line', + bar = 'bar', + rangeColumn = 'rangeColumn', + rangeArea = 'rangeArea', + dot = 'dot', + geo = 'geo', + link = 'link', + curveLink = 'curveLink', + map = 'map', + pie = 'pie', + radar = 'radar', + rose = 'rose', + scatter = 'scatter', + circularProgress = 'circularProgress', + wordCloud = 'wordCloud', + funnel = 'funnel', + linearProgress = 'linearProgress', + boxPlot = 'boxPlot', + sankey = 'sankey', + gaugePointer = 'gaugePointer', + gauge = 'gauge', + treemap = 'treemap', + sunburst = 'sunburst', + circlePacking = 'circlePacking', + waterfall = 'waterfall', + heatmap = 'heatmap', + correlation = 'correlation', + liquid = 'liquid', + venn = 'venn', + mosaic = 'mosaic', + pictogram = 'pictogram' +} +``` + + +## ILineSeriesSpec + +来源：`packages/vchart/src/series/line/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILineSeriesSpec + extends ICartesianSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig, + IDataSamping, + IMarkOverlap { + /** 系列类型 */ + type: 'line'; + /** + * x轴字段 + */ + xField?: string | string[]; + /** + * y轴字段 + */ + yField?: string | string[]; + /** + * 点图元配置 + */ + [SeriesMarkNameEnum.point]?: IMarkSpec; + /** + * 线图元配置 + */ + [SeriesMarkNameEnum.line]?: IMarkSpec; + /** + * 标签配置 + */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec; + /** + * 折线标签配置 + * @since 1.7.0 + */ + [SeriesMarkNameEnum.lineLabel]?: Omit & { + position?: 'start' | 'end'; + }; + /** + * 系列主 mark 类型配置，该配置会影响图例的展示 + * @default 'line' + * @since 1.2.0 + */ + seriesMark?: 'line' | 'point'; + + /** + * 是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点 + * @default false + * @since 1.3.0 + */ + activePoint?: boolean; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[LineMarks](AdditionalTypes-Type-Definition.md#type-da75180b071f)、[LineAppearPreset](AdditionalTypes-Type-Definition.md#type-6966f849b7c7)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IDataSamping](AdditionalTypes-Type-Definition.md#type-e33013d66ce5)、[IMarkOverlap](AdditionalTypes-Type-Definition.md#type-bed88451c0c6)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILineLikeLabelSpec](ILineLikeLabelSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## LineAppearPreset + +来源：`packages/vchart/src/series/line/interface.ts`，VChart 2.1.7 + +```typescript +export type LineAppearPreset = 'clipIn' | 'fadeIn' | 'grow'; +``` + + +## LineMarks + +来源：`packages/vchart/src/series/line/interface.ts`，VChart 2.1.7 + +```typescript +type LineMarks = 'point' | 'line'; +``` + + +## ILiquidPadding + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export type ILiquidPadding = { + left?: number; + right?: number; + top?: number; + bottom?: number; +}; +``` + + +## ILiquidPaddingSpec + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export type ILiquidPaddingSpec = ILiquidPadding | number | number[]; +``` + +相关定义：[ILiquidPadding](AdditionalTypes-Type-Definition.md#type-bef15b2fe03b) + + +## ILiquidSeriesSpec + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILiquidSeriesSpec extends IAnimationSpec { + /** 系列类型 */ + type: 'liquid'; + /** + * value字段 + */ + valueField?: string; + /** + * 轮廓形状 + * @default 'circle' + */ + maskShape?: LiquidShapeType; + /** + * 外轮廓与region边界之间的padding + */ + outlineMargin?: ILiquidPaddingSpec; + /** + * 内轮廓与外轮廓之间的padding + */ + outlinePadding?: ILiquidPaddingSpec; + /** + * 是否开启指标智能反色 + * @default false + */ + indicatorSmartInvert?: boolean; + /** + * 是否反向绘制 + * @default false + * @since 1.11.10 + */ + reverse?: boolean; + /** + * 水波图元配置 + */ + [SeriesMarkNameEnum.liquid]?: IMarkSpec; + /** + * 水波背景图元配置 + */ + [SeriesMarkNameEnum.liquidBackground]?: IMarkSpec; + /** + * 水波外轮廓配置 + */ + [SeriesMarkNameEnum.liquidOutline]?: IMarkSpec; +} +``` + +相关定义：[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[LiquidMarks](AdditionalTypes-Type-Definition.md#type-3527d2d11421)、[LiquidAppearPreset](AdditionalTypes-Type-Definition.md#type-e2f6a6a53711)、[LiquidShapeType](AdditionalTypes-Type-Definition.md#type-02af83268c9f)、[ILiquidPaddingSpec](AdditionalTypes-Type-Definition.md#type-a2cf44bad013)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ILiquidMarkSpec](ILiquidMarkSpec-Type-Definition.md)、[IGroupMarkSpec](IGroupMarkSpec-Type-Definition.md)、[ISymbolMark](AdditionalTypes-Type-Definition.md#type-dd0f2569fc22) + + +## LiquidAppearPreset + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export type LiquidAppearPreset = 'wave' | 'grow' | 'waveGrow'; +``` + + +## LiquidMarks + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +type LiquidMarks = 'liquid'; +``` + + +## LiquidShapeType + +来源：`packages/vchart/src/series/liquid/interface.ts`，VChart 2.1.7 + +```typescript +export type LiquidShapeType = SymbolType | 'drop'; +``` + +相关定义：[SymbolType](AdditionalTypes-Type-Definition.md#type-4dccce8cd4d7) + + +## IMapSeriesSpec + +来源：`packages/vchart/src/series/map/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMapSeriesSpec extends ISeriesSpec, IAnimationSpec { + /** + * 系列类型 + */ + type: 'map'; + /** + * 地图数据源 + */ + map: string; + /** + * 名称维度 + */ + nameField?: string; + /** + * 值维度 + */ + valueField?: string; + /** + * 名称映射字段 + * @default 'name' + */ + nameProperty?: string; + /** + * 中心坐标映射字段 + * @default undefined + * @since 1.5.1 + */ + centroidProperty?: string; + /** + * 名称映射表 + */ + nameMap?: { [key: string]: string }; + /** + * 图元配置 + */ + area?: IMarkSpec>; + + /** + * 默认填充颜色 + */ + defaultFillColor?: string; + + /** + * 是否显示数据中没有的地区名称 + * @default false + * @since 1.10.3 + */ + showDefaultName?: boolean; + + /** 标签配置 */ + label?: Omit; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[LineMarks](AdditionalTypes-Type-Definition.md#type-7872a83a9a39)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## LineMarks + +来源：`packages/vchart/src/series/map/interface.ts`，VChart 2.1.7 + +```typescript +type LineMarks = 'area'; +``` + + +## IMosaicSeriesSpec + +来源：`packages/vchart/src/series/mosaic/interface.ts`，VChart 2.1.7 + +```typescript +export interface IMosaicSeriesSpec extends Omit { + /** 系列类型 */ + type: 'mosaic'; + [SeriesMarkNameEnum.label]?: IMultiLabelSpec< + Omit & { + /** + * 是否根据分组字段过滤标签 + */ + filterByGroup?: { + field: string; + type?: 'min' | 'max'; + filter?: (d: any) => boolean; + }; + + /** + * 标签位置 + * @since 1.6.0 + * 支持'top-right' | 'top-left'| 'bottom-right' | 'bottom-left'，以及函数形式配置 + * */ + position?: Functional< + | 'outside' + | 'top' + | 'bottom' + | 'left' + | 'right' + | 'inside' + | 'inside-top' + | 'inside-bottom' + | 'inside-right' + | 'inside-left' + | 'top-right' + | 'top-left' + | 'bottom-right' + | 'bottom-left' + >; + } + >; + /** + * 柱子尺寸映射字段，如果不声明默认会根据相同维度下的总值占比进行映射 + * - 条形图方向时自动映射高度 + * - 竖形图方向时自动映射宽度 + * @since 1.13.10 + */ + bandWidthField?: string; +} +``` + +相关定义：[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[Functional](AdditionalTypes-Type-Definition.md#type-2535a2dd9530) + + +## IPieSeriesSpec + +来源：`packages/vchart/src/series/pie/interface.ts`，VChart 2.1.7 + +```typescript +export interface IPieSeriesSpec extends IPolarSeriesSpec, IAnimationSpec { + type: 'pie'; + /** + * 分类字段 + * @description 饼图每个扇区为独立的系列 + */ + categoryField: string; + /** 数值字段 */ + valueField: string; + /** 饼图中心点 x 坐标 */ + centerX?: number | IPercent; + /** 饼图中心点 y 坐标 */ + centerY?: number | IPercent; + /** 饼图扇区中心偏移 */ + centerOffset?: number; + + /** + * 饼图扇区半径 + * @default 0.6 + * @deprecated use outerRadius instead + */ + radius?: number; + + /** + * 饼图扇区外半径 + * @default 0.6 + */ + outerRadius?: number; + + /** + * 饼图扇区内半径 + * @default 0 + */ + innerRadius?: number; + + /** + * 饼图扇区圆角半径 + * @default 0 + */ + cornerRadius?: number; + /** + * 饼图的起始角度（0 ~ 360） + * @default -90 + */ + startAngle?: number; + /** + * 饼图的结束角度（0 ~ 360） + * @default 270 + */ + endAngle?: number; + /** + * 扇区之间的间隔角度 + */ + padAngle?: number; + + /** + * 最小的扇区角度（0 ~ 360），用于防止某个值过小导致扇区太小影响交互。 + * @default 0 + * @since 1.4.0 + */ + minAngle?: number; + + /** + * @since 1.11.12 + */ + layoutRadius?: 'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number); + + /** 扇区样式 */ + [SeriesMarkNameEnum.pie]?: IMarkSpec; + /** 标签配置 */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec; + + /** 数据为空时显示的占位图形 */ + emptyPlaceholder?: { + /** 是否显示占位圆 + * @default false + */ + showEmptyCircle?: boolean; + + /** 占位圆样式 */ + emptyCircle?: IMarkSpec; + }; + + /** + * 是否在数据均为0时显示均分扇区。 + * @default false + */ + showAllZero?: boolean; + + /** + * 是否将负数按照绝对值进行处理。 + * @default false + */ + supportNegative?: boolean; +} +``` + +相关定义：[IPolarSeriesSpec](AdditionalTypes-Type-Definition.md#type-1ed415b7c25f)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[PieMarks](AdditionalTypes-Type-Definition.md#type-b04753817bef)、[PieAppearPreset](AdditionalTypes-Type-Definition.md#type-c560860d2a3d)、[IPercent](IPercent-Type-Definition.md)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IPointLike](AdditionalTypes-Type-Definition.md#type-e25b463f6cfe)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[IArcLabelSpec](IArcLabelSpec-Type-Definition.md) + + +## PieAppearPreset + +来源：`packages/vchart/src/series/pie/interface.ts`，VChart 2.1.7 + +```typescript +export type PieAppearPreset = 'growAngle' | 'growRadius' | 'fadeIn'; +``` + + +## PieMarks + +来源：`packages/vchart/src/series/pie/interface.ts`，VChart 2.1.7 + +```typescript +export type PieMarks = 'pie' | 'label' | 'labelLine'; +``` + + +## IPolarSeriesSpec + +来源：`packages/vchart/src/series/polar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IPolarSeriesSpec extends ISeriesSpec { + /** + * 中心点 x 坐标 + * @since 1.11.2 支持百分比字符串 + **/ + centerX?: number | string; + /** + * 中心点 y 坐标 + * @since 1.11.2 支持百分比字符串 + **/ + centerY?: number | string; + + /** + * 扇区外半径 + * @default 0.6 + */ + outerRadius?: number; + + /** + * 扇区内半径 + */ + innerRadius?: number; + + /** 扇区起始角度 */ + startAngle?: number; + /** 扇区结束角度 */ + endAngle?: number; + + /** 类别字段 */ + categoryField?: string | string[]; + + /** 数值字段 */ + valueField?: string | string[]; + + /** + * @deprecated 请使用 `valueField` + */ + radiusField?: string | string[]; + + /** + * @deprecated 请使用 `categoryField` + */ + angleField?: string | string[]; + + /** + * 扇区半径 + * @default 0.6 + * @deprecated use outerRadius instead + */ + radius?: number; + + /** 是否将数据按照数轴排序 + * @default false + * @since 1.3.0 + */ + sortDataByAxis?: boolean; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md) + + +## IProgressLikeSeriesSpec + +来源：`packages/vchart/src/series/polar/progress-like/interface.ts`，VChart 2.1.7 + +```typescript +export interface IProgressLikeSeriesSpec extends IPolarSeriesSpec { + /** 圆角部分是否突出（可分别设置左侧和右侧） */ + roundCap?: boolean | [boolean, boolean]; + + /** 圆角半径 */ + cornerRadius?: number; + + /** + * tick 模式显示 + * @since 1.4.0 + */ + tickMask?: Omit, 'state'> & ITickMaskSpec; + + /** + * 超出轴范围是否被裁剪（除tick模式外, 因为tick模式自带裁剪） + * @since 1.13.9 + * @default false + */ + clamp?: boolean; +} +``` + +相关定义：[IPolarSeriesSpec](AdditionalTypes-Type-Definition.md#type-1ed415b7c25f)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[ITickMaskSpec](AdditionalTypes-Type-Definition.md#type-ab1fc6a002d4) + + +## ITickMaskSpec + +来源：`packages/vchart/src/series/polar/progress-like/interface.ts`，VChart 2.1.7 + +```typescript +export interface ITickMaskSpec { + /** 单个 tick 的默认宽度，角度值 */ + angle?: number; + /** 单个 tick 的偏移角度，角度值 */ + offsetAngle?: number; + /** tick mask 下的图元是否强制和 tick 的边线对齐 */ + forceAlign?: boolean; +} +``` + + +## ProgressLikeAppearPreset + +来源：`packages/vchart/src/series/polar/progress-like/interface.ts`，VChart 2.1.7 + +```typescript +export type ProgressLikeAppearPreset = 'grow' | 'fadeIn'; +``` + + +## IRoseLikeSeriesSpec + +来源：`packages/vchart/src/series/polar/rose-like/interface.ts`，VChart 2.1.7 + +```typescript +export type IRoseLikeSeriesSpec = IPolarSeriesSpec; +``` + +相关定义：[IPolarSeriesSpec](AdditionalTypes-Type-Definition.md#type-1ed415b7c25f) + + +## CircularProgressMarks + +来源：`packages/vchart/src/series/progress/circular/interface.ts`，VChart 2.1.7 + +```typescript +export type CircularProgressMarks = 'progress' | 'track'; +``` + + +## ICircularProgressSeriesSpec + +来源：`packages/vchart/src/series/progress/circular/interface.ts`，VChart 2.1.7 + +```typescript +export interface ICircularProgressSeriesSpec + extends IProgressSeriesSpec, + IProgressLikeSeriesSpec, + IAnimationSpec { + type: 'circularProgress'; + + /** 分类字段 */ + categoryField?: string | string[]; + + radiusField?: string; + + /** 数据最大值，默认为 1 */ + maxValue?: number; + + /** 进度条样式 */ + [SeriesMarkNameEnum.progress]?: IMarkSpec; + + /** 背景样式 */ + [SeriesMarkNameEnum.track]?: IMarkSpec; +} +``` + +相关定义：[IProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-ea6a754e3de0)、[IProgressLikeSeriesSpec](AdditionalTypes-Type-Definition.md#type-d7ad84462ce9)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[CircularProgressMarks](AdditionalTypes-Type-Definition.md#type-26e9a8fad3db)、[ProgressLikeAppearPreset](AdditionalTypes-Type-Definition.md#type-eb112c7e9a22)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md) + + +## IProgressSeriesSpec + +来源：`packages/vchart/src/series/progress/interface.ts`，VChart 2.1.7 + +```typescript +export interface IProgressSeriesSpec extends ISeriesSpec { + /** + * 进度条圆角半径 + * @default 0 + */ + cornerRadius?: number; + + /** 进度条样式 */ + progress?: IMarkSpec | IMarkSpec; + /** 背景样式 */ + track?: IMarkSpec | IMarkSpec; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IGroupMarkSpec](IGroupMarkSpec-Type-Definition.md) + + +## ILinearProgressSeriesSpec + +来源：`packages/vchart/src/series/progress/linear/interface.ts`，VChart 2.1.7 + +```typescript +export interface ILinearProgressSeriesSpec + extends IProgressSeriesSpec, + // TODO: 补充MarkName类型 @liupei + IAnimationSpec { + type: 'linearProgress'; + /** + * coordinate: 'cartesian' + * x轴字段 + */ + xField: string | string[]; + /** + * y轴字段 + * 因为存在 direction，运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度 + */ + yField: string | string[]; + + /** + * 方向 + * @default Direction.horizontal + */ + direction?: DirectionType; + + /** + * 进度条宽度 + * 以像素值(px)为单位 + */ + bandWidth?: number; + + /** + * 超出轴范围是否被裁剪 + * @since 1.13.9 + * @default false + */ + clamp?: boolean; + + /** + * 进度条样式 + * TODO: 支持百分比作为padding, 类型为string + */ + [SeriesMarkNameEnum.progress]?: IMarkSpec & { + /** 进度条上侧 padding（水平生效） */ + topPadding?: number; + /** 进度条下侧 padding（水平生效） */ + bottomPadding?: number; + /** 进度条左侧 padding（垂直生效） */ + leftPadding?: number; + /** 进度条右侧 padding（垂直生效） */ + rightPadding?: number; + }; + + /** 背景条样式 */ + [SeriesMarkNameEnum.track]?: IMarkSpec; +} +``` + +相关定义：[IProgressSeriesSpec](AdditionalTypes-Type-Definition.md#type-ea6a754e3de0)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[SeriesMarkNameEnum.progress](AdditionalTypes-Type-Definition.md#type-a5db06e8dac0)、[SeriesMarkNameEnum.track](AdditionalTypes-Type-Definition.md#type-3720a45bf7f9)、[LinearProgressAppearPreset](AdditionalTypes-Type-Definition.md#type-1cff2ef63939)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md) + + +## LinearProgressAppearPreset + +来源：`packages/vchart/src/series/progress/linear/interface.ts`，VChart 2.1.7 + +```typescript +export type LinearProgressAppearPreset = 'grow' | 'fadeIn'; +``` + + +## IRadarSeriesSpec + +来源：`packages/vchart/src/series/radar/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRadarSeriesSpec + extends IRoseLikeSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig, + IMarkOverlap { + type: 'radar'; + + /** + * 点图元配置 + */ + [SeriesMarkNameEnum.point]?: IMarkSpec; + /** + * 线图元配置 + */ + [SeriesMarkNameEnum.line]?: IMarkSpec; + /** + * 面积图元配置 + */ + [SeriesMarkNameEnum.area]?: IMarkSpec; + /** + * 标签配置 + */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec; + /** + * 系列主 mark 类型配置，该配置会影响图例的展示 + * @default 'area' + * @since 1.2.0 + */ + seriesMark?: 'point' | 'line' | 'area'; + + /** + * 是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点 + * @default false + * @since 1.3.0 + */ + activePoint?: boolean; +} +``` + +相关定义：[IRoseLikeSeriesSpec](AdditionalTypes-Type-Definition.md#type-9e858d8f5809)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[RadarMarks](AdditionalTypes-Type-Definition.md#type-44fb5d824dc0)、[RadarAppearPreset](AdditionalTypes-Type-Definition.md#type-3ec398b9ec94)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IMarkOverlap](AdditionalTypes-Type-Definition.md#type-bed88451c0c6)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[IAreaMarkSpec](IAreaMarkSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILineLikeLabelSpec](ILineLikeLabelSpec-Type-Definition.md) + + +## RadarAppearPreset + +来源：`packages/vchart/src/series/radar/interface.ts`，VChart 2.1.7 + +```typescript +export type RadarAppearPreset = 'grow' | 'fadeIn' | 'clipIn'; +``` + + +## RadarMarks + +来源：`packages/vchart/src/series/radar/interface.ts`，VChart 2.1.7 + +```typescript +type RadarMarks = 'point' | 'line' | 'area'; +``` + + +## IRangeAreaSeriesSpec + +来源：`packages/vchart/src/series/range-area/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRangeAreaSeriesSpec extends Omit { + /** + * 系列类型 + */ + type: 'rangeArea'; + + /** + * 数据字段配置 + */ + /* 区间最小值字段 */ + minField?: string; + /* 区间最大值字段 */ + maxField?: string; +} +``` + +相关定义：[IAreaSeriesSpec](AdditionalTypes-Type-Definition.md#type-3c1aa405c767) + + +## IRangeColumnSeriesSpec + +来源：`packages/vchart/src/series/range-column/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRangeColumnSeriesSpec + extends Omit>, + IAnimationSpec { + /** 系列类型 */ + type: 'rangeColumn'; + + /** + * 数据字段配置 + */ + /* 区间最小值字段 */ + minField: string; + /* 区间最大值字段 */ + maxField: string; + + /** + * 图元配置 + */ + [SeriesMarkNameEnum.bar]?: IMarkSpec; + + /** + * 标签配置 + */ + [SeriesMarkNameEnum.label]?: Partial & { + /** 标签位置(支持两端显示 bothEnds) */ + position?: PositionEnum; + [SeriesMarkNameEnum.minLabel]?: IMarkSpec & { + /** 是否可见 */ + visible?: boolean; + /** 标签位置 */ + position?: keyof typeof minMaxPositionEnum; + /** 标签偏移量 */ + offset?: number; + /** + * 文本格式化函数 + * @param text 文本内容 + * @param datum 文本对应的数据记录 + * @returns 格式化后的文本 + */ + formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>; + }; + /** 最大值标签 */ + [SeriesMarkNameEnum.maxLabel]?: IMarkSpec & { + /** 是否可见 */ + visible?: boolean; + /** 标签位置 */ + position?: minMaxPositionEnum; + /** 标签偏移量 */ + offset?: number; + /** + * 文本格式化函数 + * @param text 文本内容 + * @param datum 文本对应的数据记录 + * @returns 格式化后的文本 + */ + formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>; + }; + }; +} +``` + +相关定义：[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[RangeColumnMarks](AdditionalTypes-Type-Definition.md#type-d32ba1b05901)、[RangeColumnAppearPreset](AdditionalTypes-Type-Definition.md#type-df0bef8e8bc4)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[PositionEnum](AdditionalTypes-Type-Definition.md#type-febd1be01553)、[IPositionedTextMarkSpec](AdditionalTypes-Type-Definition.md#type-62ea327d0fc7)、[minMaxPositionEnum](AdditionalTypes-Type-Definition.md#type-e105bd77edce)、[IFormatMethod](AdditionalTypes-Type-Definition.md#type-6375b3333257) + + +## minMaxPositionEnum + +来源：`packages/vchart/src/series/range-column/interface.ts`，VChart 2.1.7 + +```typescript +export const enum minMaxPositionEnum { + middle = 'middle', + start = 'start', + end = 'end' +} +``` + + +## PositionEnum + +来源：`packages/vchart/src/series/range-column/interface.ts`，VChart 2.1.7 + +```typescript +export const enum PositionEnum { + middle = 'middle', + start = 'start', + end = 'end', + bothEnd = 'bothEnd' +} +``` + + +## RangeColumnAppearPreset + +来源：`packages/vchart/src/series/range-column/interface.ts`，VChart 2.1.7 + +```typescript +export type RangeColumnAppearPreset = 'fadeIn' | 'grow'; +``` + + +## RangeColumnMarks + +来源：`packages/vchart/src/series/range-column/interface.ts`，VChart 2.1.7 + +```typescript +type RangeColumnMarks = 'rangeColumn'; +``` + + +## IRoseSeriesSpec + +来源：`packages/vchart/src/series/rose/interface.ts`，VChart 2.1.7 + +```typescript +export interface IRoseSeriesSpec extends IRoseLikeSeriesSpec, IAnimationSpec { + type: 'rose'; + /** + * 分类字段 + */ + categoryField: string | string[]; + /** + * 数值字段 + */ + valueField: string | string[]; + /** 扇区样式 */ + [SeriesMarkNameEnum.rose]?: IMarkSpec; + /** 标签配置 */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec; +} +``` + +相关定义：[IRoseLikeSeriesSpec](AdditionalTypes-Type-Definition.md#type-9e858d8f5809)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[RoseMarks](AdditionalTypes-Type-Definition.md#type-a5a601985dc4)、[RoseAppearPreset](AdditionalTypes-Type-Definition.md#type-c671df1145cb)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[IArcLabelSpec](IArcLabelSpec-Type-Definition.md) + + +## RoseAppearPreset + +来源：`packages/vchart/src/series/rose/interface.ts`，VChart 2.1.7 + +```typescript +export type RoseAppearPreset = 'growAngle' | 'growRadius' | 'fadeIn'; +``` + + +## RoseMarks + +来源：`packages/vchart/src/series/rose/interface.ts`，VChart 2.1.7 + +```typescript +export type RoseMarks = 'rose'; +``` + + +## ISankeySeriesSpec + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface ISankeySeriesSpec extends Omit, IAnimationSpec { + type: 'sankey'; + + /** + * 数据字段配置 + */ + /** 节点名称字段配置 */ + categoryField: string; + /** 节点之间关系的权重字段 */ + valueField: string; + /** 来源节点数据字段 + * 层级数据不提供 + */ + sourceField?: string; + /** 目标节点数据字段 + * 层级数据不提供 + */ + targetField?: string; + + /** + * 图表布局方向 + */ + direction?: DirectionType; + /** + * 节点的对齐类型，所有深度相同的节点，采用什么对齐方式，决定了节点在第几层： + * - 横向布局的桑基图，用于计算节点x坐标 + * - 纵向布局的桑基图，用于计算节点y坐标 + */ + nodeAlign?: 'left' | 'right' | 'center' | 'justify' | 'start' | 'end'; + /** + * 横向布局的桑基图，设置节点Y坐标的对齐方式： + * 'start' - '顶部对齐' + * 'end' - '底部对齐' + * 'middle' - '居中对齐' + * + * 纵向布局的桑基图，设置节点X坐标的对齐方式： + * 'start' - '左对齐' + * 'end' - '右对齐' + * 'middle' - '居中对齐' + * 'parent' - '父节点'，从1.12.14版本开始支持 + * + * @since 1.12.4 + */ + crossNodeAlign?: 'start' | 'end' | 'middle' | 'parent'; + /** + * 是否反向 + * @since 1.12.2 + */ + inverse?: boolean; + /** + * 同一层中两个节点之间的间隙大小 + */ + nodeGap?: number; + /** + * 每个节点的宽度，支持三种取值 + * 1. 百分比字符串，例如：{ nodeWidth: '12%' } + * 2. 以'px'为单位的简单数字，eg: { nodeWidth: 20 } + * 3. function，通过自定义计算指定nodeWidth + */ + nodeWidth?: string | number | ((node: SankeyNodeElement) => number); + /** + * link宽度，单位px + */ + linkWidth?: number | ((link: SankeyLinkElement) => number); + /** + * link + node 的最小宽度 + */ + minStepWidth?: number; + /** + * 数据不为零或空时节点的最小大小 + * - 这个配置可以用来避免数据太小时看不到太细的节点 + * - 建议小于5px + */ + minNodeHeight?: number; + /** + * 数据不为零或空时边的最小大小 + * - 这个配置可以用来避免数据太小的时候看不到太细的链接 + * - 建议小于5px + * - 当同时指定 `minNodeHeight` 和 `minLinkHeight` 两个选项时，此选项应小于 `minNodeHeight` + */ + minLinkHeight?: number; + /** + * 数据不为零或空时节点的最大大小 + * @since 1.12.14 + */ + maxNodeHeight?: number; + /** + * 数据不为零或空时边的最大大小 + * - 当同时指定 `maxNodeHeight` 和 `maxLinkHeight` 两个选项时，此选项应小于 `maxNodeHeight` + * @since 1.12.14 + */ + maxLinkHeight?: number; + /** 布局的迭代次数 */ + iterations?: number; + /** 解析node的key，defaultValue */ + nodeKey?: string | number | ((datum: SankeyNodeDatum) => string | number); + /** 按此funtion排序link */ + linkSortBy?: (a: SankeyLinkElement, b: SankeyLinkElement) => number; + /** 按此funtion排序node */ + nodeSortBy?: (a: SankeyNodeElement, b: SankeyNodeElement) => number; + /** 自定义指定节点层 */ + setNodeLayer?: (datum: SankeyNodeDatum) => number; + /** + * 是否丢弃孤立的节点 + * @since 1.11.0 + */ + dropIsolatedNode?: boolean; + /** + * set the height of node + * @since 1.11.0 + */ + nodeHeight?: number | ((node: SankeyNodeElement) => number); + /** + * set the height of link + * @since 1.11.0 + */ + linkHeight?: number | ((link: SankeyLinkElement, sourceNode: SankeyNodeElement, sourceNodeHeight: number) => number); + /** + * each node has same height + * @since 1.11.0 + */ + equalNodeHeight?: boolean; + /** + * the layout type of link + * @since 1.11.0 + */ + linkOverlap?: 'start' | 'center' | 'end'; + + /** 节点配置 */ + [SeriesMarkNameEnum.node]?: IMarkSpec; + + /** 边配置 */ + [SeriesMarkNameEnum.link]?: IMarkSpec; + + /** 联动交互配置 */ + emphasis?: { + /** 是否开启交互 */ + enable: boolean; + /** + * 交互触发类型 + * 默认为‘click' + */ + trigger?: 'click' | 'hover'; + /**桑基图提供3种在节点上的交互联动效果 + * self: 仅高亮当前节点。 + * adjacency: 高亮当前节点上下游节点和关联的边，淡化其它图形元素。 + * related： 高亮与当前节点相关的整条路径上的节点和边，淡化其它图形元素。 */ + effect: 'self' | 'adjacency' | 'related'; + }; + + /** 标签配置 */ + [SeriesMarkNameEnum.label]?: ISankeyLabelSpec | ISankeyLabelSpec[]; + + /** + * 当制定了节点、边的宽度的时候，可以配置这个属性 + * 当宽度大于图表region的宽度、高度大于图表resion高度的时候是否自动产生滚动条 + * @since 1.13.0 + */ + overflow?: 'scroll' | 'hidden' | 'scroll-x' | 'scroll-y'; + + /** 进度条配置 */ + // scroll?: IScrollSpec & { + // /** 是否开启进度条 */ + // enable: boolean; + // }; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[SankeyMark](AdditionalTypes-Type-Definition.md#type-2f12a706e2ad)、[SankeyAppearPreset](AdditionalTypes-Type-Definition.md#type-6997583ca0c0)、[DirectionType](AdditionalTypes-Type-Definition.md#type-244d188586b9)、[SankeyNodeElement](AdditionalTypes-Type-Definition.md#type-1474c7d432e5)、[SankeyLinkElement](AdditionalTypes-Type-Definition.md#type-e49f605dc3e0)、[SankeyNodeDatum](AdditionalTypes-Type-Definition.md#type-0e7c9dea40ba)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ILinkPathMarkSpec](ILinkPathMarkSpec-Type-Definition.md)、[ISankeyLabelSpec](ISankeyLabelSpec-Type-Definition.md) + + +## SankeyAppearPreset + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export type SankeyAppearPreset = 'growIn' | 'fadeIn'; +``` + + +## SankeyLinkDatum + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface SankeyLinkDatum { + source: string | number; + target: string | number; + value?: number; +} +``` + + +## SankeyLinkElement + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface SankeyLinkElement { + vertical?: boolean; + index: number; + source: string | number; + target: string | number; + value: number; + datum: SankeyLinkDatum | SankeyLinkDatum[]; + thickness?: number; + sourceRect?: { x0: number; x1: number; y0: number; y1: number }; + targetRect?: { x0: number; x1: number; y0: number; y1: number }; + /** this will only be generate in hierarchy node data*/ + parents?: (string | number)[]; + y0?: number; + y1?: number; + x0?: number; + x1?: number; +} +``` + +相关定义：[SankeyLinkDatum](AdditionalTypes-Type-Definition.md#type-5517b5c19b32) + + +## SankeyMark + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export type SankeyMark = 'node' | 'link' | 'label'; +``` + + +## SankeyNodeDatum + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface SankeyNodeDatum { + value?: number; +} +``` + + +## SankeyNodeElement + +来源：`packages/vchart/src/series/sankey/interface.ts`，VChart 2.1.7 + +```typescript +export interface SankeyNodeElement { + key: string | number; + index: number; + /** the depth of node, from source to target */ + depth: number; + + /** the depth of node, from target to source */ + endDepth?: number; + /** the final layer index after layout */ + layer?: number; + isLastLayer?: boolean; + value: number; + datum: SankeyNodeDatum; + sourceLinks: SankeyLinkElement[]; + targetLinks: SankeyLinkElement[]; + x0?: number; + y0?: number; + x1?: number; + y1?: number; +} +``` + +相关定义：[SankeyNodeDatum](AdditionalTypes-Type-Definition.md#type-0e7c9dea40ba)、[SankeyLinkElement](AdditionalTypes-Type-Definition.md#type-e49f605dc3e0) + + +## IScatterSeriesSpec + +来源：`packages/vchart/src/series/scatter/interface.ts`，VChart 2.1.7 + +```typescript +export interface IScatterSeriesSpec + extends ICartesianSeriesSpec, + IAnimationSpec, + IMarkProgressiveConfig { + /** + * 系列类型 + */ + type: 'scatter'; + /** + * x轴字段 + */ + xField?: string | string[]; + /** + * y轴字段 + */ + yField?: string | string[]; + /** + * 图元配置 + */ + [SeriesMarkNameEnum.point]?: IMarkSpec; + /** + * 尺寸 对应的数据字段。 + */ + sizeField?: string; + /** + * 设置尺寸的可选值，支持多种格式： + * - 单一数值：如 10，则所有点的大小都为 10 + * - 数组：如 [10, 30]，则根据尺寸数据字段映射到该范围 + * - 回调函数，自定义根据数据计算尺寸的逻辑 + * - scale配置，自定义尺寸对应的scale + */ + size?: number | number[] | FunctionType | IVisualSpecBase; + /** + * 设置形状对应的数据字段 + */ + shapeField?: string; + /** + * 形状配置，设置形状的可选值 + * - 单一形状：如 'circle'，则所有点的形状都为 'circle' + * - 数组：如 ['circle', 'square']，则根据形状数据字段映射到该范围 + * - 回调函数，自定义根据数据计算形状的逻辑 + * - scale配置，自定义形状对应的scale + */ + shape?: ShapeType | ShapeType[] | FunctionType | IVisualSpecBase; + /** + * 标签配置 + */ + [SeriesMarkNameEnum.label]?: IMultiLabelSpec; +} +``` + +相关定义：[ICartesianSeriesSpec](AdditionalTypes-Type-Definition.md#type-3814e1f2a8e7)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[ScatterMarks](AdditionalTypes-Type-Definition.md#type-fd1929cd17c5)、[ScatterAppearPreset](AdditionalTypes-Type-Definition.md#type-76d1da4aa75e)、[IMarkProgressiveConfig](AdditionalTypes-Type-Definition.md#type-059a3e6127d2)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[FunctionType](FunctionType-Type-Definition.md)、[IVisualSpecBase](IVisualSpecBase-Type-Definition.md)、[ShapeType](ShapeType-Type-Definition.md)、[IMultiLabelSpec](IMultiLabelSpec-Type-Definition.md)、[ILineLikeLabelSpec](ILineLikeLabelSpec-Type-Definition.md) + + +## ScatterAppearPreset + +来源：`packages/vchart/src/series/scatter/interface.ts`，VChart 2.1.7 + +```typescript +export type ScatterAppearPreset = 'scaleIn' | 'fadeIn'; +``` + + +## ScatterMarks + +来源：`packages/vchart/src/series/scatter/interface.ts`，VChart 2.1.7 + +```typescript +export type ScatterMarks = 'point' | 'label'; +``` + + +## SunburstAppearPreset + +来源：`packages/vchart/src/series/sunburst/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type SunburstAppearPreset = 'growAngle' | 'growRadius' | 'fadeIn'; +``` + + +## SunburstMark + +来源：`packages/vchart/src/series/sunburst/animation/interface.ts`，VChart 2.1.7 + +```typescript +export type SunburstMark = 'arc' | 'label'; +``` + + +## ISunburstSeriesSpec + +来源：`packages/vchart/src/series/sunburst/interface.ts`，VChart 2.1.7 + +```typescript +export interface ISunburstSeriesSpec + extends Omit, + IAnimationSpec { + type: 'sunburst'; + + /** + * 分类字段 + * @requires + */ + categoryField: string; + + /** + * 权重字段 + * @requires + */ + valueField: string; + + /** + * 旭日图中心点, x坐标. + * @default 正中心 + */ + centerX?: number; + + /** + * 旭日图中心点, y坐标. + * @default 正中心 + */ + centerY?: number; + + /** + * 旭日图中心点, x坐标偏移量. + * @default 0 + */ + offsetX?: number; + + /** + * 旭日图中心点, y坐标偏移量. + * @default 0 + */ + offsetY?: number; + + /** + * 起始角度 + * @default -90 + */ + startAngle?: number; + + /** + * 终止角度 + * @default startAngle + 360 + */ + endAngle?: number; + + /** + * 扇区半径 + * @default 0 + * @description 最内层 + */ + innerRadius?: number | number[]; + + /** + * 扇区外半径 + * @default 1 + * @description 最外层 + */ + outerRadius?: number | number[]; + + /** + * 层级间隔 + * @default 0 + * @description 对所有层生效 + */ + gap?: number | number[]; + + /** + * label布局相关参数 + */ + labelLayout?: SunburstLabelConfig | (SunburstLabelConfig | null)[]; + + /** + * 自动隐藏密集标签 + */ + labelAutoVisible?: LabelAutoVisibleType; + + /** + * 下钻配置 + * @default false + * @description 下钻功能开关 + */ + drill?: boolean; + + /** + * 钻取字段的field + * @default DEFAULT_DATA_KEY + * @description 通过API进行钻取, 需要此配置项. + */ + drillField?: string; + + /** + * 标签配置 + * @description 对所有层生效 + */ + [SeriesMarkNameEnum.label]?: IMarkSpec; + + /** + * 图元配置 + */ + [SeriesMarkNameEnum.sunburst]?: IMarkSpec; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[SunburstMark](AdditionalTypes-Type-Definition.md#type-97edc6635996)、[SunburstAppearPreset](AdditionalTypes-Type-Definition.md#type-9821e1ad4f86)、[SunburstLabelConfig](SunburstLabelConfig-Type-Definition.md)、[LabelAutoVisibleType](AdditionalTypes-Type-Definition.md#type-e60547cde037)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md) + + +## LabelAutoVisibleType + +来源：`packages/vchart/src/series/sunburst/interface.ts`，VChart 2.1.7 + +```typescript +export type LabelAutoVisibleType = { + /** + * 是否启用 + * @default false + */ + enable?: boolean; + + /** + * 周长阈值,扇区周长小于该值时, 则隐藏标签. + * @default 10 + */ + circumference?: number; +}; +``` + + +## ITreemapSeriesSpec + +来源：`packages/vchart/src/series/treemap/interface.ts`，VChart 2.1.7 + +```typescript +export interface ITreemapSeriesSpec + extends Omit, + IAnimationSpec { + type: 'treemap'; + /** + * 文本字段 + */ + categoryField: string; + /** + * 权重字段 + */ + valueField: string; + /** + * 数据 + */ + data: IHierarchyData; + /** + * 矩形分割比例 + * @default (1 + Math.sqrt(5)) / 2 + */ + aspectRatio?: number; + + /** + * 矩形分割算法 + * @default 'binary' + * @description + * 'binary': 递归地将指定的节点分割成一个近似平衡的二叉树，对宽的矩形选择水平分割，对高的矩形选择垂直分割。 + * + * 'dice': 根据指定节点的每个子节点的值水平划分由x0, y0, x1, y1指定的矩形区域。子节点按顺序定位，从给定矩形 + * 的左边缘（x0）开始。如果子节点的值之和小于指定节点的值（即，如果指定节点有一个非零的内部值），剩余的空位将被 + * 定位在给定矩形的右边缘（x1）。 + * + * 'slice': 和'dice'类似，方向为竖直方向分割。 + * + * 'sliceDice': 节点奇数深度，用'slice'；节点偶数深度，用'dice'。 + * + * 'squarify': 尽可能按照一个特定长宽比的分割矩形。 + */ + splitType?: TreemapOptions['splitType']; + /** + * 节点间距 + * @default 1 + */ + gapWidth?: TreemapOptions['gapWidth']; + /** + * 节点内边距 + * @default [5] + */ + nodePadding?: TreemapOptions['padding']; + /** + * 展示的最大层级 + * @description 当节点在层次数据中的深度大于 maxDepth 时，节点将不会被显示 + */ + maxDepth?: TreemapOptions['maxDepth']; + /** + * 当区域面积（px * px）小于设定值后，节点将被隐藏 + * @default 10 + */ + minVisibleArea?: TreemapOptions['minVisibleArea']; + /** + * 当区域面积（px * px）小于设定值后，节点的子节点将被隐藏 + */ + minChildrenVisibleArea?: TreemapOptions['minChildrenVisibleArea']; + /** + * 当区域宽或高（px）小于设定值后，节点的子节点将被隐藏 + */ + minChildrenVisibleSize?: TreemapOptions['minChildrenVisibleSize']; + /** + * 是否开启拖拽和缩放 + * @default false + */ + roam?: boolean; + /** + * 下钻配置 + * @default false + * @description 下钻功能开关 + */ + drill?: boolean; + /** + * 钻取字段的field + * @default DEFAULT_DATA_KEY + * @description 通过API进行钻取, 需要此配置项. + */ + drillField?: string; + /** + * 叶子节点样式配置 + */ + [SeriesMarkNameEnum.leaf]?: IMarkSpec; + /** + * 非叶子节点样式配置 + */ + [SeriesMarkNameEnum.nonLeaf]?: IMarkSpec; + /** + * 叶子节点标签样式配置，默认不显示 + */ + [SeriesMarkNameEnum.label]?: Omit; + /** + * 非叶子节点标签样式配置，默认不显示 + */ + [SeriesMarkNameEnum.nonLeafLabel]?: Omit & { + position?: TreemapOptions['labelPosition']; + padding?: TreemapOptions['labelPadding']; + }; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[TreemapMark](AdditionalTypes-Type-Definition.md#type-a996892adf6f)、[TreemapAppearPreset](AdditionalTypes-Type-Definition.md#type-24b5502879db)、[IHierarchyData](IHierarchyData-Type-Definition.md)、[TreemapOptions](AdditionalTypes-Type-Definition.md#type-5125620c5489)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## TreemapAppearPreset + +来源：`packages/vchart/src/series/treemap/interface.ts`，VChart 2.1.7 + +```typescript +export type TreemapAppearPreset = 'growIn' | 'fadeIn'; +``` + + +## TreemapMark + +来源：`packages/vchart/src/series/treemap/interface.ts`，VChart 2.1.7 + +```typescript +export type TreemapMark = 'leaf' | 'nonLeaf'; +``` + + +## IVennSeriesSpec + +来源：`packages/vchart/src/series/venn/interface.ts`，VChart 2.1.7 + +```typescript +export interface IVennSeriesSpec extends ISeriesSpec, IAnimationSpec { + type: 'venn'; + /** + * 类别字段 + */ + categoryField?: string; + /** + * 权重字段 + */ + valueField: string; + + /** + * 圆形图元配置 + */ + [SeriesMarkNameEnum.circle]?: IMarkSpec; + /** + * 重叠部分图元配置 + */ + [SeriesMarkNameEnum.overlap]?: IMarkSpec; + /** + * 圆形图元标签配置 + */ + [SeriesMarkNameEnum.label]?: Omit; + /** + * 重叠部分图元标签配置 + */ + [SeriesMarkNameEnum.overlapLabel]?: Omit; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[VennMark](AdditionalTypes-Type-Definition.md#type-d1fec4347076)、[VennAppearPreset](AdditionalTypes-Type-Definition.md#type-1a92a41b84da)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md) + + +## VennAppearPreset + +来源：`packages/vchart/src/series/venn/interface.ts`，VChart 2.1.7 + +```typescript +export type VennAppearPreset = 'growIn' | 'fadeIn' | 'scaleIn'; +``` + + +## VennMark + +来源：`packages/vchart/src/series/venn/interface.ts`，VChart 2.1.7 + +```typescript +export type VennMark = 'circle' | 'overlap'; +``` + + +## IWaterfallSeriesSpec + +来源：`packages/vchart/src/series/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWaterfallSeriesSpec + extends Omit, + IAnimationSpec { + /** + * 系列类型 + */ + type: 'waterfall'; + /** + * 总计配置 + */ + total?: IWaterfallTotalEnd | IWaterfallTotalField | IWaterfallTotalCustom; + /** + * 引导线配置 + */ + [SeriesMarkNameEnum.leaderLine]?: IMarkSpec; + /** + * 堆积值标签配置 + */ + [SeriesMarkNameEnum.stackLabel]?: ILabelSpec & { + /** 标签位置 */ + position?: IWaterfallStackLabelPosition; + /** 标签偏移量 */ + offset?: number; + /** 标签值 */ + valueType?: IWaterfallStackLabelValueType; + }; + + totalLabel?: ITotalLabelSpec & { + /** 标签位置 */ + position?: IWaterfallStackLabelPosition; + /** 标签偏移量 */ + offset?: number; + /** 标签值 */ + valueType?: IWaterfallStackLabelValueType; + }; + + /** + * 标签配置 + */ + [SeriesMarkNameEnum.label]?: ILabelSpec & { + /** 是否可见 */ + visible: boolean; + /** 标签位置(支持两端显示 bothEnds) */ + // position?: PositionEnum; + /** 标签偏移量 */ + offset?: number; + }; + + /** + * 瀑布图类型 + * 默认为 increase 增长瀑布图 + * @since 2.0.6 + */ + calculationMode?: 'increase' | 'decrease'; +} +``` + +相关定义：[IBarSeriesSpec](AdditionalTypes-Type-Definition.md#type-e01baddbd8aa)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[WaterfallMarks](AdditionalTypes-Type-Definition.md#type-bb1d273d83e6)、[WaterfallAppearPreset](AdditionalTypes-Type-Definition.md#type-8850f720f897)、[IWaterfallTotalEnd](IWaterfallTotalEnd-Type-Definition.md)、[IWaterfallTotalField](IWaterfallTotalField-Type-Definition.md)、[IWaterfallTotalCustom](IWaterfallTotalCustom-Type-Definition.md)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[ILabelSpec](ILabelSpec-Type-Definition.md)、[IWaterfallStackLabelPosition](AdditionalTypes-Type-Definition.md#type-000580d95d76)、[IWaterfallStackLabelValueType](AdditionalTypes-Type-Definition.md#type-bc167196a113)、[ITotalLabelSpec](ITotalLabelSpec-Type-Definition.md) + + +## IWaterfallStackLabelPosition + +来源：`packages/vchart/src/series/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +export type IWaterfallStackLabelPosition = 'withChange' | 'middle' | 'max' | 'min'; +``` + + +## IWaterfallStackLabelValueType + +来源：`packages/vchart/src/series/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +export type IWaterfallStackLabelValueType = 'change' | 'absolute'; +``` + + +## WaterfallAppearPreset + +来源：`packages/vchart/src/series/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +export type WaterfallAppearPreset = BarAppearPreset; +``` + +相关定义：[BarAppearPreset](AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc) + + +## WaterfallMarks + +来源：`packages/vchart/src/series/waterfall/interface.ts`，VChart 2.1.7 + +```typescript +type WaterfallMarks = 'bar'; +``` + + +## IWordCloudSeriesBaseSpec + +来源：`packages/vchart/src/series/word-cloud/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWordCloudSeriesBaseSpec + extends ISeriesSpec, + IAnimationSpec { + /** + * 文本字段 + */ + nameField: string; + /** + * 权重字段 + */ + valueField?: string; + /** + * 字体字段 + */ + fontFamilyField?: string; + /** + * 字重字段 + */ + fontWeightField?: string; + /** + * 字体样式字段 + */ + fontStyleField?: string; + /** + * 直接指定 hex 颜色字段 + */ + colorHexField?: string; + /** + * 颜色模式 + * TODO: 'linear' 待支持 + */ + colorMode?: 'ordinal'; + /** + * 颜色列表 + */ + colorList?: string[]; + /** + * 可旋转角度 随机取范围 + */ + rotateAngles?: number[]; + /** + * 字重范围 + * @default [200,500] + */ + fontWeightRange?: [number, number]; // 需要固定字重大小的话，数组里面的数就配置成一样的 + /** + * 字体大小范围 + * @description 当valueField存在时，默认值[20,40]; 当valueField不存在时，默认值[10, 10] + * @since 1.8.7 如果配置为'auto', 则fontSizeRange不传入, 字体大小会随画布大小改变而改变 + */ + fontSizeRange?: [number, number] | 'auto'; // 需要固定字体大小的话，数组里面的数就配置成一样的 + /** + * 词云形状 + * @default 'circle' + * + * 注意，文字类型和几何形状类型的shape自 1.12.0 版本开始支持 + */ + maskShape?: string | WordCloudShapeType | TextShapeMask | GeometricMaskShape; // url 或 svg字符串 或 base64，或shape字符串 + /** + * TODO: 缩放mask时是否保持比例 + */ + keepAspect?: boolean; + /** + * 是否开始随机摆放方向(顺时针｜逆时针), 主要用于spec测试 + */ + random?: boolean; + /** + * 词云特殊配置 + */ + wordCloudConfig?: WordCloudConfigType; + /** + * 形状词云特殊配置 + */ + wordCloudShapeConfig?: WordCloudShapeConfigType; + /** + * 词云文字图元配置 或 形状词云核心词文字图元配置 + * @description hover配置随图元state，此外增加padding: 字体间距 和 formatMethod: 文本格式化 + */ + [SeriesMarkNameEnum.word]?: IMarkSpec & { + padding?: number; + formatMethod?: ITextFormatMethod<[datum?: any]>; + }; + /** + * 形状词云填充词文字图元配置 + * @description hover配置随图元state，此外增加padding: 字体间距 + * @description 不增加formatMethod的原因：形状词云在做布局时，word和fillingWord用的是同一份数据，即text相同，所以fillingWords的format不会生效 + * @deprecated + */ + [SeriesMarkNameEnum.fillingWord]?: IMarkSpec & { + padding?: number; + }; + + /** + * 当形状词云的形状为文字类型和几何形状类型的时候，支持绘制形状轮廓 + * @since 1.12.0 + */ + [SeriesMarkNameEnum.wordMask]?: IMarkSpec; + + animationAppear?: + | boolean + | (IStateAnimateSpec & { + /** + * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整 + * prest为 'fadeIn' 时，则为总动画时长。 + */ + duration?: number; + /** + * 词云入场动画总时长，在默认prest('scaleIn')时生效。 + * @default 1000 + * @since 1.4.0 + */ + totalTime?: number; + }) + | IMarkAnimateSpec; +} +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[SeriesMarkNameEnum.word](AdditionalTypes-Type-Definition.md#type-dcab00960f46)、[WordcloudAppearPreset](AdditionalTypes-Type-Definition.md#type-230d77f59707)、[WordCloudShapeType](WordCloudShapeType-Type-Definition.md)、[TextShapeMask](TextShapeMask-Type-Definition.md)、[GeometricMaskShape](GeometricMaskShape-Type-Definition.md)、[WordCloudConfigType](WordCloudConfigType-Type-Definition.md)、[WordCloudShapeConfigType](WordCloudShapeConfigType-Type-Definition.md)、[IMarkSpec](IMarkSpec-Type-Definition.md)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[ITextFormatMethod](AdditionalTypes-Type-Definition.md#type-5a8994f84d7b)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IStateAnimateSpec](AdditionalTypes-Type-Definition.md#type-c689f8784df3)、[IMarkAnimateSpec](AdditionalTypes-Type-Definition.md#type-f077d8f2c125) + + +## IWordCloudSeriesSpec + +来源：`packages/vchart/src/series/word-cloud/interface.ts`，VChart 2.1.7 + +```typescript +export interface IWordCloudSeriesSpec extends IWordCloudSeriesBaseSpec { + type: 'wordCloud'; +} +``` + +相关定义：[IWordCloudSeriesBaseSpec](AdditionalTypes-Type-Definition.md#type-545e0cd34c67) + + +## WordcloudAppearPreset + +来源：`packages/vchart/src/series/word-cloud/interface.ts`，VChart 2.1.7 + +```typescript +export type WordcloudAppearPreset = 'scaleIn' | 'fadeIn'; +``` + + +## ColorScheme + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type ColorScheme = Array | ProgressiveDataScheme | IColorSchemeStruct; +``` + +相关定义：[ProgressiveDataScheme](AdditionalTypes-Type-Definition.md#type-d334d5b74366)、[IColorSchemeStruct](AdditionalTypes-Type-Definition.md#type-aaa1ea372a28) + + +## ColorSchemeItem + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type ColorSchemeItem = string | IGradient; +``` + +相关定义：[IGradient](AdditionalTypes-Type-Definition.md#type-4cdfc5286411) + + +## DataSchemeItem + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type DataSchemeItem = string | IColorKey; +``` + +相关定义：[IColorKey](AdditionalTypes-Type-Definition.md#type-a3c3eb9876a9) + + +## IColorKey + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export interface IColorKey { + /** 颜色type声明 */ + type: 'palette'; + + /** 颜色 token */ + key: string; + + /** 明度系数（可选，0~1） */ + l?: number; + + /** 透明度系数（可选，0~1） */ + a?: number; + + /** + * 默认色值，在没有取到 key 对应的色值时返回 + * @since 1.3.0 + */ + default?: ColorSchemeItem; +} +``` + +相关定义：[ColorSchemeItem](AdditionalTypes-Type-Definition.md#type-3b07bb001775) + + +## IColorSchemeStruct + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type IColorSchemeStruct = { + /** 数据色板 */ + dataScheme: Array | ProgressiveDataScheme; + + /** 语义色板 */ + palette?: { + /** 主色调（可选） */ + bandColor?: ColorSchemeItem; + /** 背景颜色（可选） */ + backgroundColor?: ColorSchemeItem; + /** 其他的语义化色值 */ + [key: string]: ColorSchemeItem; + }; +}; +``` + +相关定义：[DataSchemeItem](AdditionalTypes-Type-Definition.md#type-14c76aab7e3f)、[ProgressiveDataScheme](AdditionalTypes-Type-Definition.md#type-d334d5b74366)、[ColorSchemeItem](AdditionalTypes-Type-Definition.md#type-3b07bb001775) + + +## IProgressiveDataSchemeCase + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export interface IProgressiveDataSchemeCase { + /** 可选，适合此色板的 domain 数量 */ + maxDomainLength?: number; + /** 可选，自定义回调，返回是否应用此色板，将覆盖 maxDomainLength 等配置 */ + isAvailable?: boolean | IsProgressiveDataSchemeAvailableCallback; + /** 色板 */ + scheme: T[]; +} +``` + +相关定义：[IsProgressiveDataSchemeAvailableCallback](AdditionalTypes-Type-Definition.md#type-759e0317b6ff) + + +## IsProgressiveDataSchemeAvailableCallback + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type IsProgressiveDataSchemeAvailableCallback = (domain: any[]) => boolean; +``` + + +## IThemeColorScheme + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type IThemeColorScheme = { + /** 必选 */ + default: ColorScheme; +} & Partial> & + Partial>; +``` + +相关定义：[ColorScheme](AdditionalTypes-Type-Definition.md#type-56ac75a33cd8)、[SeriesTypeEnum](AdditionalTypes-Type-Definition.md#type-11db701f3ba0)、[SeriesTypeForThemeEnum](AdditionalTypes-Type-Definition.md#type-5683fd6b700a) + + +## ProgressiveDataScheme + +来源：`packages/vchart/src/theme/color-scheme/interface.ts`，VChart 2.1.7 + +```typescript +export type ProgressiveDataScheme = Array>; +``` + +相关定义：[IProgressiveDataSchemeCase](AdditionalTypes-Type-Definition.md#type-305e40988a2a) + + +## ITokenKey + +来源：`packages/vchart/src/theme/token/interface.ts`，VChart 2.1.7 + +```typescript +export interface ITokenKey { + /** type 声明 */ + type: 'token'; + /** token key */ + key: string; + /** 默认值，在没有取到 key 对应的值时返回 */ + default?: T; +} +``` + + +## Datum + +来源：`packages/vchart/src/typings/common.ts`，VChart 2.1.7 + +```typescript +export type Datum = { + [key: string]: any; +}; +``` + + +## Maybe + +来源：`packages/vchart/src/typings/common.ts`，VChart 2.1.7 + +```typescript +export type Maybe = T | undefined | null; +``` + + +## MaybeArray + +来源：`packages/vchart/src/typings/common.ts`，VChart 2.1.7 + +```typescript +export type MaybeArray = T | Array; +``` + + +## StringOrNumber + +来源：`packages/vchart/src/typings/common.ts`，VChart 2.1.7 + +```typescript +export type StringOrNumber = string | number; +``` + + +## CoordinateType + +来源：`packages/vchart/src/typings/coordinate.ts`，VChart 2.1.7 + +```typescript +export type CoordinateType = 'cartesian' | 'polar' | 'geo' | 'none'; +``` + + +## IPoint + +来源：`packages/vchart/src/typings/coordinate.ts`，VChart 2.1.7 + +```typescript +export interface IPoint { + x: number; + y: number; +} +``` + + +## IPolarPoint + +来源：`packages/vchart/src/typings/coordinate.ts`，VChart 2.1.7 + +```typescript +export interface IPolarPoint { + radius: number; + angle: number; +} +``` + + +## Cursor + +来源：`packages/vchart/src/typings/cursor.ts`，VChart 2.1.7 + +```typescript +export type Cursor = + | 'auto' + | 'default' + | 'none' + | 'context-menu' + | 'help' + | 'pointer' + | 'progress' + | 'wait' + | 'cell' + | 'crosshair' + | 'text' + | 'vertical-text' + | 'alias' + | 'copy' + | 'move' + | 'no-drop' + | 'not-allowed' + | 'e-resize' + | 'n-resize' + | 'ne-resize' + | 'nw-resize' + | 's-resize' + | 'se-resize' + | 'sw-resize' + | 'w-resize' + | 'ew-resize' + | 'ns-resize' + | 'nesw-resize' + | 'nwse-resize' + | 'col-resize' + | 'row-resize' + | 'all-scroll' + | 'zoom-in' + | 'zoom-out' + | 'grab' + | 'grabbing'; +``` + + +## IInvalidType + +来源：`packages/vchart/src/typings/data.ts`，VChart 2.1.7 + +```typescript +export type IInvalidType = 'zero' | 'ignore' | 'link' | 'break'; +``` + + +## IGroup + +来源：`packages/vchart/src/typings/group.ts`，VChart 2.1.7 + +```typescript +export interface IGroup { + fields?: string[]; + groupData?: DataView; + initData?: (viewData: DataView, dataSet: DataSet) => void; + groupDataUpdate?: () => void; + getGroupValueInField?: (field: string) => any[]; +} +``` + +相关定义：[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8)、[DataSet](AdditionalTypes-Type-Definition.md#type-8d2b64638b97) + + +## ILayoutNumber + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export type ILayoutNumber = number | IPercent | ((layoutRect: ILayoutRect) => number) | IPercentOffset; +``` + +相关定义：[IPercent](IPercent-Type-Definition.md)、[ILayoutRect](AdditionalTypes-Type-Definition.md#type-b4324e55ab6b)、[IPercentOffset](AdditionalTypes-Type-Definition.md#type-d014dbe57510) + + +## ILayoutOrientPadding + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export type ILayoutOrientPadding = { + /** + * 左侧边距配置 + */ + left?: ILayoutNumber; + /** + * 右侧边距配置 + */ + right?: ILayoutNumber; + /** + * 顶部边距配置 + */ + top?: ILayoutNumber; + /** + * 底部边距配置 + */ + bottom?: ILayoutNumber; +}; +``` + +相关定义：[ILayoutNumber](AdditionalTypes-Type-Definition.md#type-9638d3997297) + + +## ILayoutPoint + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutPoint { + x: number; + y: number; +} +``` + + +## ILayoutRect + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export interface ILayoutRect { + width: number; + height: number; +} +``` + + +## ILayoutType + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export type ILayoutType = + | 'region-relative' // 独立占位，不重合 + | 'region-relative-overlap' // 允许重合放置 + | 'region' + | 'normal' + | 'absolute' + | 'normal-inline'; +``` + + +## IPercentOffset + +来源：`packages/vchart/src/typings/layout.ts`，VChart 2.1.7 + +```typescript +export type IPercentOffset = { + /** + * 百分比值，取值范围为0-1 + */ + percent?: number; + /** + * 偏移量，偏移的像素值 + */ + offset?: number; +}; +``` + + +## IRegionQuerier + +来源：`packages/vchart/src/typings/params.ts`，VChart 2.1.7 + +```typescript +export interface IRegionQuerier { + regionId?: StringOrNumber; + regionIndex?: number; +} +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IShowTooltipOption + +来源：`packages/vchart/src/typings/params.ts`，VChart 2.1.7 + +```typescript +export interface IShowTooltipOption extends IRegionQuerier { + /* tooltip预期显示的x坐标（为空则在图元附近） */ + x?: number; + /* tooltip预期显示的y坐标（为空则在图元附近） */ + y?: number; + /* 是否常显（如果为false或空的话，手动触发tooltip之后，tooltip可能被自动触发的别的tooltip替代） */ + alwaysShow?: boolean; + /* tooltip类型（为空则自动判断） */ + activeType?: TooltipActiveType; +} +``` + +相关定义：[IRegionQuerier](AdditionalTypes-Type-Definition.md#type-a826f89dd07b)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af) + + +## Direction + +来源：`packages/vchart/src/typings/space.ts`，VChart 2.1.7 + +```typescript +export const enum Direction { + vertical = 'vertical', + horizontal = 'horizontal' +} +``` + + +## DirectionType + +来源：`packages/vchart/src/typings/space.ts`，VChart 2.1.7 + +```typescript +export type DirectionType = keyof typeof Direction; +``` + +相关定义：[Direction](AdditionalTypes-Type-Definition.md#type-0eaca977a05a) + + +## IOrientType + +来源：`packages/vchart/src/typings/space.ts`，VChart 2.1.7 + +```typescript +export type IOrientType = 'left' | 'top' | 'right' | 'bottom' | 'z'; +``` + + +## IPolarOrientType + +来源：`packages/vchart/src/typings/space.ts`，VChart 2.1.7 + +```typescript +export type IPolarOrientType = 'radius' | 'angle'; +``` + + +## IRect + +来源：`packages/vchart/src/typings/space.ts`，VChart 2.1.7 + +```typescript +export interface IRect { + x: number; + y: number; + width: number; + height: number; +} +``` + + +## ChartSpecMap + +来源：`packages/vchart/src/typings/spec/chart.ts`，VChart 2.1.7 + +```typescript +export interface ChartSpecMap { + readonly common: ICommonChartSpec; + readonly area: IAreaChartSpec; + readonly line: ILineChartSpec; + readonly bar: IBarChartSpec; + readonly histogram: IHistogramChartSpec; + readonly rangeColumn: IRangeColumnChartSpec; + readonly rangeArea: IRangeAreaChartSpec; + readonly map: IMapChartSpec; + readonly pie: IPieChartSpec; + readonly radar: IRadarChartSpec; + readonly rose: IRoseChartSpec; + readonly scatter: IScatterChartSpec; + readonly circleProgress: ICircularProgressChartSpec; + readonly linearProgress: ILinearProgressChartSpec; + readonly wordCloud: IWordCloudChartSpec; + readonly funnel: IFunnelChartSpec; + readonly waterfall: IWaterfallChartSpec; + readonly boxplot: IBoxPlotChartSpec; + readonly gauge: IGaugeChartSpec; + readonly sankey: ISankeyChartSpec; + readonly treemap: ITreemapChartSpec; + readonly sunburst: ISunburstChartSpec; + readonly circlePacking: ICirclePackingChartSpec; + readonly heatmap: IHeatmapChartSpec; + readonly correlation: ICorrelationChartSpec; + readonly liquid: ILiquidChartSpec; +} +``` + +相关定义：[ICommonChartSpec](AdditionalTypes-Type-Definition.md#type-2e8825d02f34)、[IAreaChartSpec](AdditionalTypes-Type-Definition.md#type-496aab7cbbc3)、[ILineChartSpec](AdditionalTypes-Type-Definition.md#type-de20dddcc338)、[IBarChartSpec](AdditionalTypes-Type-Definition.md#type-1b991bebaeb5)、[IHistogramChartSpec](AdditionalTypes-Type-Definition.md#type-50577849394e)、[IRangeColumnChartSpec](AdditionalTypes-Type-Definition.md#type-da04864ad35f)、[IRangeAreaChartSpec](AdditionalTypes-Type-Definition.md#type-3a7b7d9563aa)、[IMapChartSpec](AdditionalTypes-Type-Definition.md#type-2cc8eadf4a78)、[IPieChartSpec](AdditionalTypes-Type-Definition.md#type-b89687ec6565)、[IRadarChartSpec](AdditionalTypes-Type-Definition.md#type-63b572eee0ca)、[IRoseChartSpec](AdditionalTypes-Type-Definition.md#type-92bd0cd597bd)、[IScatterChartSpec](AdditionalTypes-Type-Definition.md#type-b4c1e7d7be5c)、[ICircularProgressChartSpec](AdditionalTypes-Type-Definition.md#type-162adbb6da6d)、[ILinearProgressChartSpec](AdditionalTypes-Type-Definition.md#type-aa5844c337ee)、[IWordCloudChartSpec](AdditionalTypes-Type-Definition.md#type-5e23d784e4af)、[IFunnelChartSpec](AdditionalTypes-Type-Definition.md#type-87520a24cdd6)、[IWaterfallChartSpec](AdditionalTypes-Type-Definition.md#type-8f8a21509020)、[IBoxPlotChartSpec](AdditionalTypes-Type-Definition.md#type-20eb03e0dbfa)、[IGaugeChartSpec](AdditionalTypes-Type-Definition.md#type-80ddbd318ef0)、[ISankeyChartSpec](AdditionalTypes-Type-Definition.md#type-f326797c9091)、[ITreemapChartSpec](AdditionalTypes-Type-Definition.md#type-f80911626a1e)、[ISunburstChartSpec](AdditionalTypes-Type-Definition.md#type-fa66e1c21317)、[ICirclePackingChartSpec](AdditionalTypes-Type-Definition.md#type-6e93443171dd)、[IHeatmapChartSpec](AdditionalTypes-Type-Definition.md#type-d5e9ad106fbf)、[ICorrelationChartSpec](AdditionalTypes-Type-Definition.md#type-717abb97a652)、[ILiquidChartSpec](AdditionalTypes-Type-Definition.md#type-53e84bdd56cd) + + +## ISpec + +来源：`packages/vchart/src/typings/spec/chart.ts`，VChart 2.1.7 + +```typescript +export type ISpec = ChartSpecMap[keyof ChartSpecMap] | IChartSpec; +``` + +相关定义：[ChartSpecMap](AdditionalTypes-Type-Definition.md#type-61e059a17d79)、[IChartSpec](AdditionalTypes-Type-Definition.md#type-57e06d38bf09) + + +## BuildInTransformOptions + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type BuildInTransformOptions = + | { + /** 地理数据简化 */ + type: 'simplify'; + options: ISimplifyOptions; + } + | { + /** 数据维度处理，包括排序，逆序，数据筛选能力 */ + type: 'fields'; + options: IFieldsOptions; + } + | { + /** 使用回调的自定义筛选 */ + type: 'filter'; + options: IFilterOptions; + } + | { + /** 数据展开 */ + type: 'fold'; + options: IFoldOptions; + }; +``` + +相关定义：[ISimplifyOptions](AdditionalTypes-Type-Definition.md#type-a4c7726cf624)、[IFieldsOptions](AdditionalTypes-Type-Definition.md#type-26812fc33a0c)、[IFilterOptions](AdditionalTypes-Type-Definition.md#type-aceaf7172c44)、[IFoldOptions](AdditionalTypes-Type-Definition.md#type-46fd81c95ea2) + + +## CommonParseOptions + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface CommonParseOptions { + /** + * 是否需要对数据进行 clone，默认为 true。 + * 如果考虑性能，你可以将其关闭，但是这会带了一些副作用，即我们会对传入的数据进行修改（不会对原有字段及值修改，只会在原有数据基础上添加一些字段）。 + * @default true + * @since 1.3.0 + */ + clone?: boolean; +} +``` + + +## DataKeyType + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type DataKeyType = string | string[] | ((data: Datum, index: number) => string); +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61) + + +## EnableMarkType + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type EnableMarkType = keyof IBuildinMarkSpec; +``` + +相关定义：[IBuildinMarkSpec](AdditionalTypes-Type-Definition.md#type-1de36c1cfcb0) + + +## IBuildinMarkSpec + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IBuildinMarkSpec = { + group: IGroupMarkSpec; + symbol: ISymbolMarkSpec; + rule: IRuleMarkSpec; + line: ILineMarkSpec; + text: ITextMarkSpec; + rect: IRectMarkSpec; + image: IImageMarkSpec; + path: IPathMarkSpec; + area: IAreaMarkSpec; + arc: IArcMarkSpec; + polygon: IPolygonMarkSpec; + boxPlot: IBoxPlotMarkSpec; + linkPath: ILinkPathMarkSpec; + ripple: IRippleMarkSpec; +}; +``` + +相关定义：[IGroupMarkSpec](IGroupMarkSpec-Type-Definition.md)、[ISymbolMarkSpec](ISymbolMarkSpec-Type-Definition.md)、[IRuleMarkSpec](IRuleMarkSpec-Type-Definition.md)、[ILineMarkSpec](ILineMarkSpec-Type-Definition.md)、[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IRectMarkSpec](IRectMarkSpec-Type-Definition.md)、[IImageMarkSpec](IImageMarkSpec-Type-Definition.md)、[IPathMarkSpec](IPathMarkSpec-Type-Definition.md)、[IAreaMarkSpec](IAreaMarkSpec-Type-Definition.md)、[IArcMarkSpec](IArcMarkSpec-Type-Definition.md)、[IPolygonMarkSpec](IPolygonMarkSpec-Type-Definition.md)、[IBoxPlotMarkSpec](IBoxPlotMarkSpec-Type-Definition.md)、[ILinkPathMarkSpec](ILinkPathMarkSpec-Type-Definition.md)、[IRippleMarkSpec](IRippleMarkSpec-Type-Definition.md) + + +## IChartExtendsSeriesSpec + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IChartExtendsSeriesSpec = Omit; +``` + +相关定义：[ISeriesSpec](ISeriesSpec-Type-Definition.md) + + +## IChartSpec + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface IChartSpec { + /** 图表类型 */ + type: string; + /** 数据 */ + data?: IData; + /** 画布宽度 */ + width?: number; + /** 画布高度 */ + height?: number; + /** + * 图表宽高是否自适应容器，浏览器环境下默认为 true。 + * 该配置的优先级高于构造函数中的 autoFit 配置。 + * 如果用户配置了 width，则以用户配置的 width 为准，height 同理。 + */ + autoFit?: boolean; + /** + * 图表整体 padding 设置 + */ + padding?: ILayoutPaddingSpec; + /** + * 图表色系配置 + */ + color?: string[] | Omit, 'id'>; + /** + * 系列 + * @description 仅在组合图中使用, 文档中除组合图外均未透出该配置 + */ + series?: ISeriesSpec[]; + /** + * 系列样式 + * @description 仅在图表配置了seriesField时生效 + */ + seriesStyle?: ISeriesStyle; + + /** + * 自动关闭动画的阀值，对应的是单系列data的长度 + * @since 1.2.0 + */ + animationThreshold?: number; + + /** hover 交互 */ + hover?: boolean | IHoverSpec; + /** select 交互 */ + select?: boolean | ISelectSpec; + + /** region配置 */ + region?: RegionSpec[]; + /** 图表标题配置 */ + title?: ITitleSpec; + /** 布局配置 */ + layout?: ILayoutSpec; + /** 图例配置 */ + legends?: ILegendSpec | ILegendSpec[]; + /** 十字辅助线配置 */ + crosshair?: ICrosshairSpec | ICrosshairSpec[]; + /** tooltip配置 */ + tooltip?: ITooltipSpec; + /** 播放器配置 */ + player?: IPlayer; + /** 缩略轴配置 */ + dataZoom?: IDataZoomSpec | IDataZoomSpec[]; + /** 滚动条配置 */ + scrollBar?: IScrollBarSpec | IScrollBarSpec[]; + /** 框选配置 */ + brush?: IBrushSpec; + /** 全局 scale 配置 */ + scales?: IVisualSpecScale[]; + /** 自定义mark */ + customMark?: ICustomMarkSpec[]; + /** 轴 */ + axes?: ICommonAxisSpec[]; + /** + * 图表上的主题定义。 + * 可以直接配置主题名，前提是该主题名已经注册 + */ + theme?: Omit | string; + /** + * 图表背景色配置，优先级高于构造函数中的 background 配置 + * 自1.11.6版本支持渐变色对象的配置 + */ + background?: IBackgroundSpec; + + // TODO：后续开放，现在仍有问题 + // poptip?: PopTipAttributes; + // TODO: 补充动画配置 + + /** + * 堆积时是否逆序 + * @default false + * @since 1.4.0 + */ + stackInverse?: boolean; + /** + * 堆积时是否排序 + * @default false + * @since 1.10.4 + */ + stackSort?: boolean; + /** + * 媒体查询配置 + * @since 1.8.0 + */ + media?: IMediaQuerySpec; +} +``` + +相关定义：[IData](IData-Type-Definition.md)、[ILayoutPaddingSpec](ILayoutPaddingSpec-Type-Definition.md)、[IVisualSpecScale](IVisualSpecScale-Type-Definition.md)、[ISeriesSpec](ISeriesSpec-Type-Definition.md)、[ISeriesStyle](ISeriesStyle-Type-Definition.md)、[IHoverSpec](IHoverSpec-Type-Definition.md)、[ISelectSpec](ISelectSpec-Type-Definition.md)、[RegionSpec](RegionSpec-Type-Definition.md)、[ITitleSpec](ITitleSpec-Type-Definition.md)、[ILayoutSpec](ILayoutSpec-Type-Definition.md)、[ILegendSpec](ILegendSpec-Type-Definition.md)、[ICrosshairSpec](AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2)、[ITooltipSpec](ITooltipSpec-Type-Definition.md)、[IPlayer](IPlayer-Type-Definition.md)、[IDataZoomSpec](IDataZoomSpec-Type-Definition.md)、[IScrollBarSpec](IScrollBarSpec-Type-Definition.md)、[IBrushSpec](IBrushSpec-Type-Definition.md)、[ICustomMarkSpec](ICustomMarkSpec-Type-Definition.md)、[EnableMarkType](AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4)、[ICommonAxisSpec](AdditionalTypes-Type-Definition.md#type-500cf18886a4)、[ITheme](ITheme-Type-Definition.md)、[IBackgroundSpec](IBackgroundSpec-Type-Definition.md)、[IMediaQuerySpec](IMediaQuerySpec-Type-Definition.md) + + +## IDataType + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IDataType = IDataValues | DataView; +``` + +相关定义：[IDataValues](AdditionalTypes-Type-Definition.md#type-218b08963b1d)、[DataView](AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8) + + +## IDataValues + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface IDataValues { + /** + * 数据唯一标识 + */ + id?: StringOrNumber; + /** + * 数据 + */ + values: Datum[] | string; + /** + * 引用的数据索引 + */ + fromDataIndex?: number; + /** + * 引用的数据 id + */ + fromDataId?: StringOrNumber; + /** + * 数据 transform 配置 + */ + transforms?: BuildInTransformOptions[]; + /** + * 数据字段相关配置 + */ + fields?: Record< + /** 字段key */ + string, + IFieldsMeta + >; + /** + * 数据解析器配置 + */ + parser?: SheetParseOptions | CommonParseOptions; +} +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[BuildInTransformOptions](AdditionalTypes-Type-Definition.md#type-0ad7a402bbdf)、[IFieldsMeta](AdditionalTypes-Type-Definition.md#type-ad6958bb1a0b)、[SheetParseOptions](AdditionalTypes-Type-Definition.md#type-dbdce91761d0)、[CommonParseOptions](AdditionalTypes-Type-Definition.md#type-fdac4230815f) + + +## IFieldsMeta + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface IFieldsMeta { + /** TODO: 字段通用format, 暂时先不支持 */ + // format?: (datum: Datum, index: number) => unknown; + /** + * 字段别名 + */ + alias?: string; + /** 字段取值范围 */ + domain?: StringOrNumber[]; + /** + * 是否使用 domain 锁定统计信息。默认为 false + * true - 在图例交互场景，也固定domain + * 当设置为 `onlyFull` 时，仅在初始化的展示完整数据的场景锁定domain，在交互触发的筛选场景不锁定 + */ + lockStatisticsByDomain?: boolean | 'onlyFull'; + /** 连续型 还是 离散型 */ + type?: 'ordinal' | 'linear'; + /** 排序顺序 不设置的话当前维度不进行排序 */ + sortIndex?: number; + /** 排序时是否反转 默认为 false */ + sortReverse?: boolean; + /** + * 排序简易配置 + * 当配置了 sort 时，sortIndex 默认为 0 ，sortReverse 跟随 sort 的值，'desc' 时为 true，'asc' 时为 false + * 当配置了 sortIndex 和 sortReverser 时，优先级会高于 sort 的默认效果 + * @support since 2.0.0 + */ + sort?: 'desc' | 'asc'; +} +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727) + + +## IFormatMethod + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IFormatMethod = ( + ...args: T +) => ReturnType> | ReturnType>; +``` + +相关定义：[ITextFormatMethod](AdditionalTypes-Type-Definition.md#type-5a8994f84d7b)、[IRichTextFormatMethod](AdditionalTypes-Type-Definition.md#type-3b28c6257cf4) + + +## IMarkStateFilter + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IMarkStateFilter = + | { + /** 维度筛选 */ + fields: { [key in string]: { type: 'ordinal' | 'linear'; domain: StringOrNumber[] } }; + } + | { + /** 筛选数据 */ + datums: Datum[]; + /** 筛选数据 */ + datumKeys: string[]; + } + | { + /** 筛选 item */ + items: IGraphic[]; + } + /** 筛选函数 */ + | (( + datum: Datum, + options: { + mark?: IMark; + type?: string; + renderNode?: IGraphic; + } + ) => boolean); +``` + +相关定义：[StringOrNumber](AdditionalTypes-Type-Definition.md#type-2f92a26f4727)、[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[IGraphic](AdditionalTypes-Type-Definition.md#type-a766bc91cce3)、[IMark](AdditionalTypes-Type-Definition.md#type-50aedeb586cf) + + +## IMarkStateSpec + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface IMarkStateSpec { + /** 筛选器 */ + filter?: IMarkStateFilter; + /** 状态优先级 */ + level?: number | undefined; + style: ConvertToMarkStyleSpec; +} +``` + +相关定义：[IMarkStateFilter](AdditionalTypes-Type-Definition.md#type-493dcf0721cf)、[ConvertToMarkStyleSpec](AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5) + + +## IPerformanceHook + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface IPerformanceHook { + // constructor + // 创建完成。在使用 vstory 的场景下，图表实例不由业务创建，业务想要获取图表时机非常靠后，因此补充一个钩子 + afterCreateVChart?: (vchart?: IVChart) => void; + + // InitRender + // ├── InitializeChart + // ├── CompileToVGrammar + // ├── ParseView + // | └── ParseExpression + // ├── (new View) + // | ├── CreateRuntime + // | └── (view.initialize) + // | └── CreateVRenderStage + // └── SrViewEvaluateAsync / SrViewRunAsync + // ├── MarkTransform + // ├── FacetTransform + // ├── CreateVRenderMark + // └── VRenderDraw + + // 初始化图表配置 + beforeInitializeChart?: (vchart?: IVChart) => void; + afterInitializeChart?: (vchart?: IVChart) => void; + + // 编译 + beforeCompileToVGrammar?: (vchart?: IVChart) => void; + afterCompileToVGrammar?: (vchart?: IVChart) => void; + // 各个图表模块编译 + beforeRegionCompile?: (vchart?: IVChart) => void; + afterRegionCompile?: (vchart?: IVChart) => void; + beforeSeriesCompile?: (vchart?: IVChart) => void; + afterSeriesCompile?: (vchart?: IVChart) => void; + beforeComponentCompile?: (vchart?: IVChart) => void; + afterComponentCompile?: (vchart?: IVChart) => void; + + // resize的时候的钩子 + beforeResizeWithUpdate?: (vchart?: IVChart) => void; + afterResizeWithUpdate?: (vchart?: IVChart) => void; + + // LayoutWithSceneGraph 二次布局 + beforeLayoutWithSceneGraph?: (vchart?: IVChart) => void; + afterLayoutWithSceneGraph?: (vchart?: IVChart) => void; + + // VGrammar 解析spec + beforeParseView?: (vchart?: IVChart) => void; + afterParseView?: (vchart?: IVChart) => void; + + // 初始化runtime + beforeCreateRuntime?: (vchart?: IVChart) => void; + afterCreateRuntime?: (vchart?: IVChart) => void; + + // VGrammar EvaluateAsync 时间 + beforeSrViewEvaluateAsync?: (vchart?: IVChart) => void; + afterSrViewEvaluateAsync?: (vchart?: IVChart) => void; + + // VGrammar RunAsync 时间 + beforeSrViewRunAsync?: (vchart?: IVChart) => void; + afterSrViewRunAsync?: (vchart?: IVChart) => void; + + // transform测量 + beforeTransform?: (name: string, vchart?: IVChart) => void; + afterTransform?: (name: string, vchart?: IVChart) => void; + + // Create VRender Stage 时间 + beforeCreateVRenderStage?: (vchart?: IVChart) => void; + afterCreateVRenderStage?: (vchart?: IVChart) => void; + + // Create VRender Mark 时间 + beforeCreateVRenderMark?: (vchart?: IVChart) => void; + afterCreateVRenderMark?: (vchart?: IVChart) => void; + + // VGrammar 创建元素完成，vrender 绘图之前 + beforeDoRender?: (vchart?: IVChart) => void; + + // VRender Draw 时间 + beforeVRenderDraw?: (vchart?: IVChart) => void; + afterVRenderDraw?: (vchart?: IVChart) => void; + + // 词云 + afterWordcloudShapeDraw?: (vchart?: IVChart) => void; +} +``` + +相关定义：[IVChart](AdditionalTypes-Type-Definition.md#type-f6dc633e5201) + + +## IRichTextFormatMethod + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type IRichTextFormatMethod = (...args: T) => + | { + /** + * 设置文本类型为富文本 + */ + type: 'rich'; + /** + * 当文本类型为富文本的时候，设置文本的内容 + */ + text: IRichTextCharacter[]; + } + | IRichTextCharacter[]; +``` + +相关定义：[IRichTextCharacter](AdditionalTypes-Type-Definition.md#type-a486d6a175fe) + + +## ITextFormatMethod + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type ITextFormatMethod = ( + ...args: T +) => ITextMarkSpec['text'] | { type: 'text'; text: ITextMarkSpec['text'] }; +``` + +相关定义：[ITextMarkSpec](ITextMarkSpec-Type-Definition.md) + + +## RenderMode + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export type RenderMode = keyof typeof RenderModeEnum; +``` + +相关定义：[RenderModeEnum](AdditionalTypes-Type-Definition.md#type-240f8a4ed23c) + + +## RenderModeEnum + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export enum RenderModeEnum { + 'desktop-browser' = 'desktop-browser', + 'mobile-browser' = 'mobile-browser', + 'node' = 'node', + 'worker' = 'worker', + 'miniApp' = 'miniApp', + 'wx' = 'wx', + 'tt' = 'tt', + 'harmony' = 'harmony', + 'desktop-miniApp' = 'desktop-miniApp', + 'lynx' = 'lynx' +} +``` + + +## SheetParseOptions + +来源：`packages/vchart/src/typings/spec/common.ts`，VChart 2.1.7 + +```typescript +export interface SheetParseOptions extends CommonParseOptions { + /** + * 特定类型的数据，支持以下类型： + * - csv: 逗号分隔值（Comma-Separated Values，CSV，有时也称为字符分隔值，因为分隔字符也可以不是逗号），其文件以纯文本形式存储表格数据（数字和文本）。 + * - dsv: 分隔值（Delimiter-Separated Values，DSV，有时也称为字符分隔值，因为分隔字符也可以不是逗号），其文件以纯文本形式存储表格数据（数字和文本）。 + * - tsv: 制表符分隔值（Tab-Separated Values，TSV，有时也称为字符分隔值，因为分隔字符也可以不是逗号），其文件以纯文本形式存储表格数据（数字和文本）。 + */ + type: 'csv' | 'dsv' | 'tsv'; + /** + * 具体的解析配置 + */ + options?: IDsvParserOptions; +} +``` + +相关定义：[CommonParseOptions](AdditionalTypes-Type-Definition.md#type-fdac4230815f)、[IDsvParserOptions](AdditionalTypes-Type-Definition.md#type-a39097639f44) + + +## TooltipContentCallback + +来源：`packages/vchart/src/typings/tooltip/common.ts`，VChart 2.1.7 + +```typescript +export type TooltipContentCallback = (datum?: Datum, params?: TooltipHandlerParams) => T | undefined; +``` + +相关定义：[Datum](AdditionalTypes-Type-Definition.md#type-bf5eb9a79e61)、[TooltipHandlerParams](AdditionalTypes-Type-Definition.md#type-82517d84c2af) + + +## TooltipUpdateCallback + +来源：`packages/vchart/src/typings/tooltip/common.ts`，VChart 2.1.7 + +```typescript +export type TooltipUpdateCallback = ( + prev: T | undefined, + data?: TooltipData, + params?: TooltipHandlerParams +) => T | undefined; +``` + +相关定义：[TooltipData](AdditionalTypes-Type-Definition.md#type-2020c8fc6cbe)、[TooltipHandlerParams](AdditionalTypes-Type-Definition.md#type-82517d84c2af) + + +## ITooltipHandler + +来源：`packages/vchart/src/typings/tooltip/handler.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipHandler extends ITooltipHandlerSpec { + /** 可选，获取 tooltip 所在容器 */ + getTooltipContainer?: () => any; + /** 可选，更新 tooltip spec 或主题后执行的回调 */ + reInit?: () => any; + /** dom tooltip 支持改api */ + getRootDom?: () => any; +} +``` + +相关定义：[ITooltipHandlerSpec](AdditionalTypes-Type-Definition.md#type-9ead2353606b) + + +## TooltipActiveType + +来源：`packages/vchart/src/typings/tooltip/handler.ts`，VChart 2.1.7 + +```typescript +export type TooltipActiveType = 'mark' | 'dimension' | 'group'; +``` + + +## TooltipData + +来源：`packages/vchart/src/typings/tooltip/handler.ts`，VChart 2.1.7 + +```typescript +export type TooltipData = IDimensionInfo[] | IDimensionData[]; +``` + +相关定义：[IDimensionInfo](AdditionalTypes-Type-Definition.md#type-06b8a10af7b9)、[IDimensionData](AdditionalTypes-Type-Definition.md#type-5b72dbd75644) + + +## ITooltipLabelActual + +来源：`packages/vchart/src/typings/tooltip/label.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipLabelActual { + keyStyle?: ITooltipTextTheme; + valueStyle?: ITooltipTextTheme; +} +``` + +相关定义：[ITooltipTextTheme](AdditionalTypes-Type-Definition.md#type-6f8c16b9dce7) + + +## ITooltipLineActual + +来源：`packages/vchart/src/typings/tooltip/line.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipLineActual extends ITooltipShapeActual, ITooltipLabelActual { + /** + * tooltip key 值内容 + */ + key?: string; + /** + * tooltip value 值内容 + */ + value?: string | TooltipRichTextAttrs; + /** + * tooltip value 的格式化模板 + */ + valueFormatter?: string; + /** + * 该行是否可见 + */ + visible?: boolean; + /** + * key 列是否适应内容 + */ + isKeyAdaptive?: boolean; + /** + * 该行行间距 + * @since 1.4.0 + */ + spaceRow?: number; + /** + * 该行对应的原始数据 + * @since 1.5.1 + */ + datum?: any; +} +``` + +相关定义：[ITooltipShapeActual](AdditionalTypes-Type-Definition.md#type-641241d7a7b9)、[ITooltipLabelActual](AdditionalTypes-Type-Definition.md#type-c308b976acfb)、[TooltipRichTextAttrs](AdditionalTypes-Type-Definition.md#type-3b54c645e6d7) + + +## ITooltipPositionActual + +来源：`packages/vchart/src/typings/tooltip/position.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipPositionActual { + x: number; + y: number; +} +``` + + +## ITooltipShapeActual + +来源：`packages/vchart/src/typings/tooltip/shape.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipShapeActual { + /** + * 是否显示图形 + */ + hasShape?: boolean; + /** + * 图形的类型 + */ + shapeType?: ShapeType | string; + /** + * 形状填充颜色 + * @since 1.4.0 + */ + shapeFill?: string; + /** + * 形状描边颜色 + * @since 1.4.0 + */ + shapeStroke?: string; + /** + * 形状描边宽度 + * @since 1.4.0 + */ + shapeLineWidth?: number; + /** + * 图形的大小 + */ + shapeSize?: number; + /** + * 形状是否空心 + */ + shapeHollow?: boolean; +} +``` + +相关定义：[ShapeType](ShapeType-Type-Definition.md) + + +## ITooltipActual + +来源：`packages/vchart/src/typings/tooltip/tooltip.ts`，VChart 2.1.7 + +```typescript +export interface ITooltipActual { + visible?: boolean; + title?: ITooltipLineActual; + content?: ITooltipLineActual[]; + activeType?: TooltipActiveType; + position?: ITooltipPositionActual; + data?: TooltipData; + handler?: Partial; + maxLineCount?: number; + updateTitle?: TooltipUpdateCallback; + updateContent?: TooltipUpdateCallback; + updatePosition?: TooltipUpdateCallback; + othersLine?: ITooltipLineActual; +} +``` + +相关定义：[ITooltipLineActual](AdditionalTypes-Type-Definition.md#type-50e4fd39a41a)、[TooltipActiveType](AdditionalTypes-Type-Definition.md#type-990c112f10af)、[ITooltipPositionActual](AdditionalTypes-Type-Definition.md#type-b07cdb853d88)、[TooltipData](AdditionalTypes-Type-Definition.md#type-2020c8fc6cbe)、[ITooltipHandlerSpec](AdditionalTypes-Type-Definition.md#type-9ead2353606b)、[TooltipUpdateCallback](AdditionalTypes-Type-Definition.md#type-58900beb05b3) + + +## BackgroundMode + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundMode = BackgroundRepeatMode | BackgroundSizingShorthand; +``` + +相关定义：[BackgroundRepeatMode](AdditionalTypes-Type-Definition.md#type-6fb8f4404334)、[BackgroundSizingShorthand](AdditionalTypes-Type-Definition.md#type-f5dcfb5b7d65) + + +## BackgroundPosition + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPosition = + | BackgroundPositionKeyword + | BackgroundPositionPreset + | [BackgroundPositionValue, BackgroundPositionValue]; +``` + +相关定义：[BackgroundPositionKeyword](AdditionalTypes-Type-Definition.md#type-d7d952da248e)、[BackgroundPositionPreset](AdditionalTypes-Type-Definition.md#type-9b6ac71cd590)、[BackgroundPositionValue](AdditionalTypes-Type-Definition.md#type-da20797f386c) + + +## BackgroundPositionHorizontalKeyword + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionHorizontalKeyword = 'left' | 'center' | 'right'; +``` + + +## BackgroundPositionKeyword + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionKeyword = BackgroundPositionHorizontalKeyword | BackgroundPositionVerticalKeyword; +``` + +相关定义：[BackgroundPositionHorizontalKeyword](AdditionalTypes-Type-Definition.md#type-31dac926518d)、[BackgroundPositionVerticalKeyword](AdditionalTypes-Type-Definition.md#type-1c3d2aa1fdc1) + + +## BackgroundPositionPercent + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionPercent = `${number}%`; +``` + + +## BackgroundPositionPreset + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionPreset = + | 'top-left' + | 'top-center' + | 'top-right' + | 'center-left' + | 'center' + | 'center-right' + | 'bottom-left' + | 'bottom-center' + | 'bottom-right'; +``` + + +## BackgroundPositionValue + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionValue = number | BackgroundPositionKeyword | BackgroundPositionPercent; +``` + +相关定义：[BackgroundPositionKeyword](AdditionalTypes-Type-Definition.md#type-d7d952da248e)、[BackgroundPositionPercent](AdditionalTypes-Type-Definition.md#type-81363cd19fe5) + + +## BackgroundPositionVerticalKeyword + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundPositionVerticalKeyword = 'top' | 'center' | 'bottom'; +``` + + +## BackgroundRepeatMode + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundRepeatMode = 'repeat' | 'repeat-x' | 'repeat-y' | 'no-repeat'; +``` + + +## BackgroundSizingShorthand + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type BackgroundSizingShorthand = 'no-repeat-cover' | 'no-repeat-contain' | 'no-repeat-fill' | 'no-repeat-auto'; +``` + + +## ConvertToMarkStyleSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type ConvertToMarkStyleSpec> = { + [key in keyof T]: VisualType; +}; +``` + +相关定义：[VisualType](AdditionalTypes-Type-Definition.md#type-e295ec9bce6b) + + +## GradientPropValue + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type GradientPropValue = ValueType | FunctionType; +``` + +相关定义：[ValueType](AdditionalTypes-Type-Definition.md#type-979efd9d6b47)、[FunctionType](FunctionType-Type-Definition.md) + + +## GradientStop + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type GradientStop = { + /** + * 渐变色的偏移量，0-1的值 + */ + offset: GradientPropValue; + /** + * 渐变色的颜色 + */ + color?: GradientPropValue; + /** + * 渐变色的透明度 + */ + opacity?: number; +}; +``` + +相关定义：[GradientPropValue](AdditionalTypes-Type-Definition.md#type-b9b2288b01f6) + + +## IBorder + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IBorder { + /** + * 边框离图形边缘的距离 + */ + distance: number | string; + /** + * 边框的颜色 + */ + stroke?: string | IGradient; + /** + * 边框的透明度 + */ + strokeOpacity?: number; + /** + * 边框线的宽度 + */ + lineWidth?: number; + /** + * 给边框配置虚线模式。它使用一组值来指定描述模式的线和间隙的交替长度 + */ + lineDash?: number[]; + /** + * 设置边框的虚线偏移量 + */ + lineDashOffset?: number; +} +``` + +相关定义：[IGradient](AdditionalTypes-Type-Definition.md#type-4cdfc5286411) + + +## ICommonSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface ICommonSpec { + /** + * 图形是否可见 + */ + visible?: boolean; + /** + * 图形的x坐标 + */ + x?: number; + /** + * 图形的y坐标 + */ + y?: number; + /** + * 图形的z坐标，仅适用于3D图表 + */ + z?: number; + /** + * 图形的描边颜色。 + * 支持使用 'rgb(255,255,255)'，'rgba(255,255,255,1)'，'#fff' 等方式设置为纯色，也支持设置为渐变色描边 + * @todo 隔离主题和 spec 配置 + * IColorKey 类型只适用于主题 + */ + stroke?: string | IGradient | false | (number | boolean)[] | IColorKey | null; + /** + * 描边透明度 + */ + strokeOpacity?: number; + /** + * 图形的透明度，既影响描边也影响填充 + */ + opacity?: number; + /** + * 图形的描边宽度 + */ + lineWidth?: number; + /** + * 给描边配置虚线模式。它使用一组值来指定描述模式的线和间隙的交替长度 + */ + lineDash?: number[]; + /** + * 设置虚线偏移量的属性 + */ + lineDashOffset?: number; + /** + * 设置图形的鼠标样式 + */ + cursor?: Cursor; + /** + * 设置图形的层级，主意这个是相对层级，图形引擎绘制的时候，会对相同group下的所有图形根据zIndex进行排序，然后从小到大进行渲染 + */ + zIndex?: number; + /** + * 图形的旋转角度 + */ + angle?: number; + /** + * 基于AABB的锚点位置，用于简单的定位某些path的位置 + */ + anchor?: [number, number]; + + /** + * x方向的缩放比例，默认为1，即不进行缩放 + */ + scaleX?: number; + /** + * y方向的缩放比例，默认为1，即不进行缩放 + */ + scaleY?: number; + /** + * 图形缩放中心 + * @since 1.4.0 + * 可以配置固定坐标，例如 [100, 100]；或者百分比坐标，例如 ['50%', '50%']，代表以图元中心为缩放中心 + * */ + scaleCenter?: [number | string, number | string]; + + // 3d旋转的属性 + /** + * x方向的旋转角度 + */ + alpha?: number; + /** + * y方向的旋转角度 + */ + beta?: number; + /** + * 3d的锚点位置 + */ + anchor3d?: [number, number]; + + /** + * 选择模式，精确模式，粗糙模式（包围盒模式），自定义模式 + */ + pickMode?: 'accurate' | 'imprecise' | 'custom'; + /** + * bounds的计算模式 + */ + boundsMode?: 'accurate' | 'imprecise'; + + /** + * 用于扩展描边的拾取范围，为 0 就是默认线宽，正数就加宽，负数就减宽 + * @default 0 + * @since 1.7.3 + */ + pickStrokeBuffer?: number; + + // 以下是纹理相关的属性 + /** + * 纹理的类型 + */ + texture?: TextureType | string; + /** + * 纹理的颜色 + */ + textureColor?: string; + /** + * 纹理单元的大小 + */ + textureSize?: number; // 纹理大小 + /** + * 纹理之间空隙的大小 + */ + texturePadding?: number; + + /** + * 外边框，外描边，描边位于图形外侧 + */ + outerBorder?: IBorder; + /** + * 内边框，内描边，描边位于图形内侧 + */ + innerBorder?: IBorder; + /** + * html 浮层，会将配置的html相关内容，绝对定位到图元的位置 + * @experimental + * @since 1.10.0 + */ + html?: IMarkHtmlSpec; + + [key: string]: any; +} +``` + +相关定义：[IGradient](AdditionalTypes-Type-Definition.md#type-4cdfc5286411)、[IColorKey](AdditionalTypes-Type-Definition.md#type-a3c3eb9876a9)、[Cursor](AdditionalTypes-Type-Definition.md#type-05ee2579711f)、[TextureType](AdditionalTypes-Type-Definition.md#type-7dd7d41922bc)、[IBorder](AdditionalTypes-Type-Definition.md#type-c857646a1dda)、[IMarkHtmlSpec](AdditionalTypes-Type-Definition.md#type-d9ef36a1c319) + + +## IComposedTextMarkSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IComposedTextMarkSpec = ITextMarkSpec | IRichTextMarkSpec; +``` + +相关定义：[ITextMarkSpec](ITextMarkSpec-Type-Definition.md)、[IRichTextMarkSpec](AdditionalTypes-Type-Definition.md#type-19e9483035ff) + + +## IFillMarkSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IFillMarkSpec extends ICommonSpec { + /** + * 图形的填充颜色 + * @todo 隔离主题和 spec 配置 + * IColorKey 类型只适用于主题 + */ + fill?: VisualType | IGradient | false | IColorKey; + /** + * 图形模糊效果程度 + */ + shadowBlur?: number; + /** + * 图形的阴影颜色 + */ + shadowColor?: string; + /** + * 阴影水平偏移距离 + */ + shadowOffsetX?: number; + /** + * 阴影垂直偏移距离 + */ + shadowOffsetY?: number; + /** + * 填充的透明度 + */ + fillOpacity?: number; + + /** + * 图形的背景色，支持纯色、image元素、canvas元素 + */ + background?: IColor | HTMLImageElement | HTMLCanvasElement | null; + /** + * 背景图绘制模式（与具体图元有关）。 + * 原有平铺模式为：`repeat` / `repeat-x` / `repeat-y` / `no-repeat`； + * 自 `2.0.21` 版本开始，支持 `no-repeat-cover` / `no-repeat-contain` / + * `no-repeat-fill` / `no-repeat-auto` 这几个 `no-repeat` 下的尺寸简写。 + */ + backgroundMode?: BackgroundMode; + /** + * 是否正好填充，只在repeat-x或者repeat-y以及no-repeat的时候生效 + */ + backgroundFit?: boolean; + /** + * 是否保持背景图的宽高比 + */ + backgroundKeepAspectRatio?: boolean; + /** + * 背景图缩放，只在no-repeat的时候生效 + */ + backgroundScale?: number; + /** + * 背景图偏移，只在no-repeat的时候生效 + */ + backgroundOffsetX?: number; + /** + * 背景图偏移，只在no-repeat的时候生效 + */ + backgroundOffsetY?: number; + /** + * 背景图锚定位置，语义类似 CSS `background-position`。 + * 仅在图片背景且最终为 `no-repeat` 时生效。 + * @since 2.0.21 + */ + backgroundPosition?: BackgroundPosition; + /** + * 背景图是否裁切，是否调用clip避免绘制到图元外部 + */ + backgroundClip?: boolean; + /** + * 背景圆角半径 + */ + backgroundCornerRadius?: number | number[]; + /** + * 背景透明度 + */ + backgroundOpacity?: number; +} +``` + +相关定义：[ICommonSpec](AdditionalTypes-Type-Definition.md#type-642c420237a7)、[VisualType](AdditionalTypes-Type-Definition.md#type-e295ec9bce6b)、[IGradient](AdditionalTypes-Type-Definition.md#type-4cdfc5286411)、[IColorKey](AdditionalTypes-Type-Definition.md#type-a3c3eb9876a9)、[IColor](AdditionalTypes-Type-Definition.md#type-a0aea41aa029)、[BackgroundMode](AdditionalTypes-Type-Definition.md#type-335140a3e2b6)、[BackgroundPosition](AdditionalTypes-Type-Definition.md#type-79f8ce85abb1) + + +## IGradient + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IGradient = IGradientLinear | IGradientRadial | IGradientConical; +``` + +相关定义：[IGradientLinear](AdditionalTypes-Type-Definition.md#type-a9d5ddd8d42f)、[IGradientRadial](AdditionalTypes-Type-Definition.md#type-7c5f562e4fc5)、[IGradientConical](AdditionalTypes-Type-Definition.md#type-6564c798928d) + + +## IGradientConical + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IGradientConical { + /** + * 锥形渐变的中心点x坐标 + */ + x?: GradientPropValue; + /** + * 锥形渐变的中心点y坐标 + */ + y?: GradientPropValue; + /** + * 锥形渐变的开始角度 + */ + startAngle?: GradientPropValue; + /** + * 锥形渐变的结束角度 + */ + endAngle?: GradientPropValue; + /** + * 锥形渐变的颜色 + */ + stops: GradientStop[]; + /** + * 渐变色的类型设置为 'conical'，即锥形渐变 + */ + gradient: 'conical'; +} +``` + +相关定义：[GradientPropValue](AdditionalTypes-Type-Definition.md#type-b9b2288b01f6)、[GradientStop](AdditionalTypes-Type-Definition.md#type-105bc3b38706) + + +## IGradientLinear + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IGradientLinear { + /** + * 渐变色的起点x坐标，0-1的值，相对于图形包围盒x方向取值的比例值 + */ + x0?: GradientPropValue; + /** + * 渐变色的起点y坐标，0-1的值，相对于图形包围盒y方向取值的比例值 + */ + y0?: GradientPropValue; + /** + * 渐变色的终点x坐标，0-1的值，相对于图形包围盒x方向取值的比例值 + */ + x1?: GradientPropValue; + /** + * 渐变色的终点y坐标，0-1的值，相对于图形包围盒y方向取值的比例值 + */ + y1?: GradientPropValue; + /** + * 渐变色的颜色 + */ + stops: GradientStop[]; + /** + * 渐变色的类型设置为 'linear'，即线形渐变 + */ + gradient: 'linear'; +} +``` + +相关定义：[GradientPropValue](AdditionalTypes-Type-Definition.md#type-b9b2288b01f6)、[GradientStop](AdditionalTypes-Type-Definition.md#type-105bc3b38706) + + +## IGradientRadial + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IGradientRadial { + /** + * 径向渐变的起点的半径 + */ + r0?: GradientPropValue; + /** + * 径向渐变的起点的x坐标 + */ + x0?: GradientPropValue; + /** + * 径向渐变的起点的y坐标 + */ + y0?: GradientPropValue; + /** + * 径向渐变的终点的x坐标 + */ + x1?: GradientPropValue; + /** + * 径向渐变的终点的y坐标 + */ + y1?: GradientPropValue; + /** + * 径向渐变的终点的半径 + */ + r1?: GradientPropValue; + /** + * 渐变色的颜色 + */ + stops: GradientStop[]; + /** + * 渐变色的类型设置为 'radial'，即径向渐变 + */ + gradient: 'radial'; +} +``` + +相关定义：[GradientPropValue](AdditionalTypes-Type-Definition.md#type-b9b2288b01f6)、[GradientStop](AdditionalTypes-Type-Definition.md#type-105bc3b38706) + + +## IMarkHtmlSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IMarkHtmlSpec = Partial; +``` + +相关定义：[IGraphicStyle](AdditionalTypes-Type-Definition.md#type-fe3cb3c3600e) + + +## IPositionedTextMarkSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IPositionedTextMarkSpec = Omit; +``` + +相关定义：[ITextMarkSpec](ITextMarkSpec-Type-Definition.md) + + +## IRichTextMarkSpec + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IRichTextMarkSpec = IRichTextAttribute & + IFillMarkSpec & { type: 'rich'; text: IRichTextAttribute['textConfig'] }; +``` + +相关定义：[IRichTextAttribute](AdditionalTypes-Type-Definition.md#type-09c9e7b04102)、[IFillMarkSpec](AdditionalTypes-Type-Definition.md#type-36e76424276b) + + +## IVisual + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type IVisual = IVisualSpecStyle | IVisualScale; +``` + +相关定义：[IVisualSpecStyle](AdditionalTypes-Type-Definition.md#type-ae2e55448a0a)、[IVisualScale](AdditionalTypes-Type-Definition.md#type-d2a6fed8edde) + + +## IVisualScale + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IVisualScale { + /** + * 对应 IVisualSpecScale 的用户配置 scale-id + */ + scale: string; + /** + * 指定参与映射的数据字段 + */ + field?: string; + /** + * 当用户指定 field 后，用该属性来控制值域。 + * @default 'none' + */ + changeDomain?: 'none' | 'replace' | 'expand'; +} +``` + + +## IVisualSpecStyle + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export interface IVisualSpecStyle extends IVisualSpecBase { + /** + * 指定映射对应的数据字段 + */ + field?: string; +} +``` + +相关定义：[IVisualSpecBase](IVisualSpecBase-Type-Definition.md) + + +## TextAlign + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type TextAlign = TextAlignType; +``` + +相关定义：[TextAlignType](AdditionalTypes-Type-Definition.md#type-5417f1df62a1) + + +## TextBaseLine + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type TextBaseLine = TextBaselineType; +``` + +相关定义：[TextBaselineType](AdditionalTypes-Type-Definition.md#type-b47e2c6810a7) + + +## TextureType + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type TextureType = + | 'circle' + | 'dimond' + | 'rect' + | 'vertical-line' + | 'horizontal-line' + | 'bias-lr' + | 'bias-rl' + | 'grid'; +``` + + +## ValueType + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type ValueType = T; +``` + + +## VisualType + +来源：`packages/vchart/src/typings/visual.ts`，VChart 2.1.7 + +```typescript +export type VisualType = ValueType | FunctionType | IVisual; +``` + +相关定义：[ValueType](AdditionalTypes-Type-Definition.md#type-979efd9d6b47)、[FunctionType](FunctionType-Type-Definition.md)、[IVisual](AdditionalTypes-Type-Definition.md#type-9bb9b1b41b53) diff --git a/skills/vchart-development-assistant/references/type-details/IAnimationConfig-Type-Definition.md b/skills/vchart-development-assistant/references/type-details/IAnimationConfig-Type-Definition.md index bb08683c44..57f3346920 100644 --- a/skills/vchart-development-assistant/references/type-details/IAnimationConfig-Type-Definition.md +++ b/skills/vchart-development-assistant/references/type-details/IAnimationConfig-Type-Definition.md @@ -1,3 +1,21 @@ +## 系列动画与图元动画的层级 + +本文件的 `IAnimationConfig` 是图元动画配置，不是 `animationAppear` 等系列属性的完整类型。 + +- `animationAppear` 支持 boolean、包含 `preset` 的预设对象，或按图元名称配置的动画映射；预设名不能直接作为该属性的字符串值。 +- `animationEnter/Update/Exit/Disappear` 支持 boolean、通用时长/延迟对象，或图元动画映射。 +- `animationNormal` 是图元动画映射；`animationState` 采用单独的状态动画类型。 + +```javascript +const seriesAnimation = { + animationAppear: { preset: 'grow', duration: 600 }, // 柱图支持 grow 预设 + animationEnter: { duration: 300 } +}; +const disabledAppear = { animationAppear: false }; +``` + +真实系列声明：[IAnimationSpec](AdditionalTypes-Type-Definition.md#type-c2c92c7fb8c3)、[IStateAnimateSpec](AdditionalTypes-Type-Definition.md#type-c689f8784df3)、[IMarkAnimateSpec](AdditionalTypes-Type-Definition.md#type-f077d8f2c125)。按具体图型的元数据确认预设和图元名称。 + ## Overview `IAnimationConfig` is a union type for VChart animation configurations, supporting two main animation paradigms: diff --git a/skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md b/skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md index 2823f70247..7e4e0e876f 100644 --- a/skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md +++ b/skills/vchart-development-assistant/references/type-details/IData-Type-Definition.md @@ -17,7 +17,7 @@ type IDataType = IDataValues | DataView; ### 2. Multiple Data Sources ```typescript -type IData = IDataType[]; // Array of data sources +const sources: IData = [{ id: 'main', values: [{ day: '周一', value: 12 }] }]; ``` ## IDataValues Configuration @@ -25,7 +25,7 @@ type IData = IDataType[]; // Array of data sources ```typescript interface IDataValues { id?: StringOrNumber; // Unique data identifier - values: Datum[] | string; // Data array or URL string + values: Datum[] | string; // Records or CSV/TSV text; not a URL loader fromDataIndex?: number; // Reference data index fromDataId?: StringOrNumber; // Reference data ID transforms?: BuildInTransformOptions[]; // Data transformation configuration @@ -36,7 +36,7 @@ interface IDataValues { ### Core Properties - **id**: Unique identifier for the data source -- **values**: The actual data (array of objects) or URL string for remote data +- **values**: 数据记录数组或 CSV/TSV 等文本内容。字符串不会自动发起网络请求；不能直接填 URL 期待加载远程数据。 - **fromDataIndex/fromDataId**: Reference to other data sources for data sharing - **transforms**: Array of data transformation operations - **fields**: Field-specific metadata and configurations @@ -188,17 +188,26 @@ const data: IData = { ### CSV Data with Parser ```typescript const data: IData = { - values: 'https://example.com/data.csv', + values: 'day,value\n周一,12\n周二,25', parser: { - type: 'csv', - options: { - delimiter: ',', - header: true - } + type: 'csv' } }; ``` +### 应用代码加载远程 CSV + +由应用先读取文本，再传入数据配置；URL、网络请求和错误处理属于宿主能力，不是 JSON spec 中的函数或加载字段。 + +```javascript +const response = await fetch(csvUrl); // csvUrl 由实际应用提供 +if (!response.ok) throw new Error(`CSV 请求失败：${response.status}`); +const csvText = await response.text(); +const data = { values: csvText, parser: { type: 'csv' } }; +``` + +只交付 spec 且宿主提供数据时保留真实绑定，不以内嵌模拟数据替代无法访问的来源。 + ### Multiple Data Sources ```typescript const data: IData = [ diff --git a/skills/vchart-development-assistant/references/type-meta/area.json b/skills/vchart-development-assistant/references/type-meta/area.json index 28e746aebf..a1fa839c3f 100644 --- a/skills/vchart-development-assistant/references/type-meta/area.json +++ b/skills/vchart-development-assistant/references/type-meta/area.json @@ -1,1209 +1,1318 @@ { "typeName": "IAreaChartSpec", - "description": "IAreaChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IAreaChartSpec": { - "description": "IAreaChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaAppearPreset", + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'area'", - "originalType": "'area'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IAreaSeriesSpec[]", - "originalType": "IAreaSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IAreaSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "area", + "description": "面积图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IAreaMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "areaLabel", + "description": "面积图元标签配置", + "type": "(Omit & {\n position?: \"end\" | \"start\" | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.7.0" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" ] }, - "IChartExtendsSeriesSpec": { - "description": "IAreaSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'area'", - "originalType": "'area'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "x轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "y轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'clipIn' | 'fadeIn' | 'grow' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "activePoint", - "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sampling", - "description": "数据采样 - 采样方法", - "type": "'lttb' | 'min' | 'max' | 'sum' | 'average'", - "originalType": "ISamplingMethod", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "samplingFactor", - "description": "数据采样 - 采样系数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "pointDis", - "description": "标记点之间的距离，px", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "pointDisMul", - "description": "标记点之间的距离， pointSize 的倍数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "markOverlap", - "description": "是否允许标记图形相互覆盖", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "point", - "description": "point 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "line", - "description": "line 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILineMarkSpec" - ] - }, - { - "name": "area", - "description": "area 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IAreaMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec & {\n position: 'top' | 'bottom' | 'left' | 'right' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' | 'center' | 'inside-middle';\n }>", - "originalType": "IMultiLabelSpec & {\n position: 'top' | 'bottom' | 'left' | 'right' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' | 'center' | 'inside-middle';\n }>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILineLikeLabelSpec" - ] - }, - { - "name": "areaLabel", - "description": "areaLabel 配置", - "type": "Omit & {\n position?: 'start' | 'end';\n }", - "originalType": "Omit & {\n position?: 'start' | 'end';\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - }, - { - "name": "seriesMark", - "description": "系列主 mark 类型配置，该配置会影响图例的展示", - "type": "'point' | 'line' | 'area'", - "originalType": "'point' | 'line' | 'area'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position: \"bottom-left\" | \"bottom-right\" | \"bottom\" | \"center\" | \"inside-middle\" | \"left\" | \"right\" | \"top-left\" | \"top-right\" | \"top\";\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineLikeLabelSpec", + "IMultiLabelSpec" + ], + "since": "1.13.1 新增支持 inside-middle 标签位置" + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "line", + "description": "线图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markOverlap", + "description": "是否允许标记图形相互覆盖", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.6.0" + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 46 个属性（已展开所有继承）", - "expandedFrom": "IAreaSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "point", + "description": "点图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "pointDis", + "description": "标记点之间的距离，px", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0" + }, + { + "name": "pointDisMul", + "description": "标记点之间的距离， pointSize 的倍数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IAreaSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IAreaSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesMark", + "description": "系列主 mark 类型配置，该配置会影响图例的展示", + "type": "\"area\" | \"line\" | \"point\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'area'", + "since": "1.2.0", + "literalValues": [ + "area", + "line", + "point" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"area\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "area" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:32:36.587Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/area/interface.d.ts", + ], "complexTypeDefinitions": { + "AreaAppearPreset": { + "typeName": "AreaAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1632d0cf5560" + }, + "AreaMarks": { + "typeName": "AreaMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6b16760e15b0" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IAreaMarkSpec": { + "typeName": "IAreaMarkSpec", + "reference": "type-details/IAreaMarkSpec-Type-Definition.md" + }, "IAreaSeriesSpec": { "typeName": "IAreaSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/area/interface.d.ts", - "note": "类型 IAreaSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3c1aa405c767" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILineLikeLabelSpec": { + "typeName": "ILineLikeLabelSpec", + "reference": "type-details/ILineLikeLabelSpec-Type-Definition.md" + }, + "ILineMarkSpec": { + "typeName": "ILineMarkSpec", + "reference": "type-details/ILineMarkSpec-Type-Definition.md" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "ISymbolMarkSpec": { - "typeName": "ISymbolMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ISymbolMarkSpec 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "ILineMarkSpec": { - "typeName": "ILineMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ILineMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IAreaMarkSpec": { - "typeName": "IAreaMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IAreaMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 84, - "complexTypes": 37, - "typeFileLocations": 37, - "dependencyTypes": 865 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/bar.json b/skills/vchart-development-assistant/references/type-meta/bar.json index 9eadd0f9c3..e74f602724 100644 --- a/skills/vchart-development-assistant/references/type-meta/bar.json +++ b/skills/vchart-development-assistant/references/type-meta/bar.json @@ -1,1225 +1,1320 @@ { "typeName": "IBarChartSpec", - "description": "IBarChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IBarChartSpec": { - "description": "IBarChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'bar'", - "originalType": "'bar'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IBarSeriesSpec[]", - "originalType": "IBarSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBarSeriesSpec" - ] - }, - { - "name": "autoBandSize", - "description": "是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度", - "type": "boolean | {\n extend: number;\n }", - "originalType": "boolean | {\n extend: number;\n }", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "autoBandSize", + "description": "是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度", + "type": "{\n extend: number;\n} | boolean | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.10.0" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" ] }, - "IChartExtendsSeriesSpec": { - "description": "IBarSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'bar'", - "originalType": "'bar'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "xField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "yField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "\"grow\" | \"fadeIn\" | \"scaleIn\" | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "activePoint", - "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "sampling", - "description": "数据采样 - 采样方法", - "type": "'lttb' | 'min' | 'max' | 'sum' | 'average'", - "originalType": "ISamplingMethod", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "samplingFactor", - "description": "数据采样 - 采样系数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "bar", - "description": "设置柱子的样式，比如填充颜色、描边粗细等", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "barBackground", - "description": "设置背景柱子的样式，比如填充颜色、圆角等", - "type": "IMarkSpec & IBarBackgroundSpec", - "originalType": "IMarkSpec & IBarBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec", - "IBarBackgroundSpec" - ] - }, - { - "name": "label", - "description": "数据标签，一般用于展示柱子对应的数值信息等", - "type": "IMultiLabelSpec & {\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "originalType": "IMultiLabelSpec & {\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILabelSpec" - ] - }, - { - "name": "barWidth", - "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMinWidth", - "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMaxWidth", - "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barGapInGroup", - "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。 当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。 如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string | (number | string)[]", - "originalType": "number | string | (number | string)[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMinHeight", - "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackCornerRadius", - "description": "堆叠柱整体的圆角 @since 1.10.0 圆角支持回调配置 @since 1.12.4", - "type": "number | number[] | IStackCornerRadiusCallback", - "originalType": "number | number[] | IStackCornerRadiusCallback", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IStackCornerRadiusCallback" - ] - }, - { - "name": "barGap", - "description": "柱条间 gap 值 @since 1.13.11", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position?: Functional<\"bottom-left\" | \"bottom-right\" | \"bottom\" | \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | \"left\" | \"outside\" | \"right\" | \"top-left\" | \"top-right\" | \"top\"> | undefined;\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "Functional", + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 47 个属性（已展开所有继承）", - "expandedFrom": "IBarSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IBarSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"bar\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "bar" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:33:33.094Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/bar/interface.d.ts", + ], "complexTypeDefinitions": { + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "Functional": { + "typeName": "Functional", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2535a2dd9530", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, "IBarSeriesSpec": { "typeName": "IBarSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IBarSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e01baddbd8aa" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" }, - "IPlayer": { - "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" }, - "IScrollBarSpec": { - "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" }, - "ITheme": { - "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" }, - "ITotalLabelSpec": { - "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" }, "IMarkSpec": { "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IRectMarkSpec": { "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, - "IBarBackgroundSpec": { - "typeName": "IBarBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IBarBackgroundSpec 的定义位置" + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" }, "IStackCornerRadiusCallback": { "typeName": "IStackCornerRadiusCallback", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IStackCornerRadiusCallback 的定义位置" + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 86, - "complexTypes": 37, - "typeFileLocations": 37, - "dependencyTypes": 865 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/bar3d.json b/skills/vchart-development-assistant/references/type-meta/bar3d.json new file mode 100644 index 0000000000..2c44c5120d --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/bar3d.json @@ -0,0 +1,1332 @@ +{ + "typeName": "IBar3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" + ], + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position?: Functional<\"bottom-left\" | \"bottom-right\" | \"bottom\" | \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | \"left\" | \"outside\" | \"right\" | \"top-left\" | \"top-right\" | \"top\"> | undefined;\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "Functional", + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IBar3dSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBar3dSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"bar3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "bar3d" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段\ny轴字段\n运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "Functional": { + "typeName": "Functional", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2535a2dd9530", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBar3dSeriesSpec": { + "typeName": "IBar3dSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e506ece45fdc" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianAxisSpec": { + "typeName": "ICartesianAxisSpec", + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + } + }, + "registration": [ + "registerBar3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ], + "contractNotes": [ + { + "description": "当前 IBar3dSeriesSpec 继承二维 bar 类型，未声明运行时使用的 bar3d 样式字段；这属于公开类型与运行时的差异，不能据元数据认定该字段不受支持。", + "example": { + "bar3d": { + "style": { + "length": 20, + "z": -20 + } + } + } + } + ] +} diff --git a/skills/vchart-development-assistant/references/type-meta/boxPlot.json b/skills/vchart-development-assistant/references/type-meta/boxPlot.json index 9501cf1067..b088396b25 100644 --- a/skills/vchart-development-assistant/references/type-meta/boxPlot.json +++ b/skills/vchart-development-assistant/references/type-meta/boxPlot.json @@ -1,830 +1,1282 @@ { "typeName": "IBoxPlotChartSpec", - "description": "IBoxPlotChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IBoxPlotChartSpec": { - "description": "IBoxPlotChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'boxPlot'", - "originalType": "'boxPlot'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IBoxPlotSeriesSpec[]", - "originalType": "IBoxPlotSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBoxPlotSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "boxPlot", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "boxGapInGroup", + "description": "分组箱线图中各个分组内的间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "2.0.10" + }, + { + "name": "boxMaxWidth", + "description": "最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "2.0.10" + }, + { + "name": "boxMinWidth", + "description": "最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "2.0.10" + }, + { + "name": "boxPlot", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBoxPlotMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "boxWidth", + "description": "宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "2.0.10" + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "maxField", + "description": "最大值字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IBoxPlotSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "string | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'boxPlot'", - "originalType": "'boxPlot'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "direction", - "description": "direction 配置", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "xField", - "description": "x轴字段（direction=vertical时生效）", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "yField", - "description": "y轴字段（direction=horizontal时生效）", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minField", - "description": "最小值字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxField", - "description": "最大值字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "q1Field", - "description": "q1字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "medianField", - "description": "中位数字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "q3Field", - "description": "q3字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "boxPlot", - "description": "boxPlot 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IBoxPlotMarkSpec" - ] - }, - { - "name": "outliersField", - "description": "异常值字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "outliersStyle", - "description": "异常值样式配置", - "type": "IOutlierMarkSpec", - "originalType": "IOutlierMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IOutlierMarkSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "medianField", + "description": "中位数字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "minField", + "description": "最小值字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outlier", + "description": "异常值图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ], + "since": "2.0.10" + }, + { + "name": "outliersField", + "description": "异常值字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outliersStyle", + "description": "异常值样式配置", + "type": "IOutlierMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IOutlierMarkSpec" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "q1Field", + "description": "q1字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "q3Field", + "description": "q3字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IBoxPlotSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBoxPlotSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 16 个属性（已展开所有继承）", - "expandedFrom": "IBoxPlotSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"boxPlot\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "boxPlot" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段（direction=vertical时生效）", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段（direction=horizontal时生效）", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:34:29.304Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/box-plot/interface.d.ts", + ], "complexTypeDefinitions": { + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "boxPlot": { + "typeName": "boxPlot", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3b9e5d5f1ab0" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBoxPlotMarkSpec": { + "typeName": "IBoxPlotMarkSpec", + "reference": "type-details/IBoxPlotMarkSpec-Type-Definition.md" + }, "IBoxPlotSeriesSpec": { "typeName": "IBoxPlotSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/box-plot/interface.d.ts", - "note": "类型 IBoxPlotSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4f696616234f" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IOutlierMarkSpec": { + "typeName": "IOutlierMarkSpec", + "reference": "type-details/IOutlierMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IBoxPlotMarkSpec": { - "typeName": "IBoxPlotMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IBoxPlotMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IOutlierMarkSpec": { - "typeName": "IOutlierMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IOutlierMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 54, - "complexTypes": 32, - "typeFileLocations": 32, - "dependencyTypes": 863 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/circlePacking.json b/skills/vchart-development-assistant/references/type-meta/circlePacking.json index 6d4536ad79..24a60c5240 100644 --- a/skills/vchart-development-assistant/references/type-meta/circlePacking.json +++ b/skills/vchart-development-assistant/references/type-meta/circlePacking.json @@ -1,963 +1,922 @@ { "typeName": "ICirclePackingChartSpec", - "description": "ICirclePackingChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ICirclePackingChartSpec": { - "description": "ICirclePackingChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingAppearPreset", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'circlePacking'", - "originalType": "'circlePacking'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ICirclePackingSeriesSpec[]", - "originalType": "ICirclePackingSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICirclePackingSeriesSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "ICirclePackingSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'circlePacking'", - "originalType": "'circlePacking'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "权重字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "layoutPadding", - "description": "层内边距", - "type": "number | number[]", - "originalType": "number | number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ITextMarkSpec" - ] - }, - { - "name": "circlePacking", - "description": "circlePacking 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "drill", - "description": "下钻配置", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "drillField", - "description": "钻取字段的field", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CirclePackingMark", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "circlePacking", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "drill", + "description": "下钻配置", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "drillField", + "description": "钻取字段的field", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "DEFAULT_DATA_KEY" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ITextMarkSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutPadding", + "description": "层内边距", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "5" + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ICirclePackingSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICirclePackingSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 34 个属性（已展开所有继承）", - "expandedFrom": "ICirclePackingSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"circlePacking\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "circlePacking" ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:35:24.751Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/circle-packing/interface.d.ts", + ], "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CirclePackingAppearPreset": { + "typeName": "CirclePackingAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b9b1dad57548" + }, + "CirclePackingMark": { + "typeName": "CirclePackingMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c5aa6f08af16" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, "ICirclePackingSeriesSpec": { "typeName": "ICirclePackingSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/circle-packing/interface.d.ts", - "note": "类型 ICirclePackingSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-bbcfdbd7ab2b" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITextMarkSpec": { + "typeName": "ITextMarkSpec", + "reference": "type-details/ITextMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "ITextMarkSpec": { - "typeName": "ITextMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ITextMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 66, - "complexTypes": 31, - "typeFileLocations": 31, - "dependencyTypes": 850 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/circularProgress.json b/skills/vchart-development-assistant/references/type-meta/circularProgress.json index 46c50f9375..831aface21 100644 --- a/skills/vchart-development-assistant/references/type-meta/circularProgress.json +++ b/skills/vchart-development-assistant/references/type-meta/circularProgress.json @@ -1,1153 +1,1041 @@ { "typeName": "ICircularProgressChartSpec", - "description": "ICircularProgressChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ICircularProgressChartSpec": { - "description": "ICircularProgressChartSpec 接口配置", - "directExtends": [ - "IProgressChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "ProgressLikeAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'circularProgress'", - "originalType": "'circularProgress'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ICircularProgressSeriesSpec[]", - "originalType": "ICircularProgressSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICircularProgressSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CircularProgressMarks", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴配置", + "type": "ICartesianAxisSpec[] | IPolarAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec", + "IPolarAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "centerX", + "description": "中心点 x 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "中心点 y 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "clamp", + "description": "超出轴范围是否被裁剪（除tick模式外, 因为tick模式自带裁剪）", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.13.9" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "cornerRadius", + "description": "进度条圆角半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" ] }, - "IProgressChartSpec": { - "description": "IProgressChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "endAngle", + "description": "扇区结束角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "innerRadius", + "description": "扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maxValue", + "description": "数据最大值，默认为 1", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "cornerRadius", - "description": "进度条圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "originalType": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec", - "IPolarAxisSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progress", + "description": "进度条样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "radius", + "description": "扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "roundCap", + "description": "圆角部分是否突出（可分别设置左侧和右侧）", + "type": "[\n boolean,\n boolean\n] | boolean | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ICircularProgressSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICircularProgressSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "扇区起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "tickMask", + "description": "tick 模式显示", + "type": "(Omit, \"state\"> & ITickMaskSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec", + "ITickMaskSpec" + ], + "since": "1.4.0" + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" ] }, - "IChartExtendsSeriesSpec": { - "description": "ICircularProgressSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'circularProgress'", - "originalType": "'circularProgress'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "cornerRadius", - "description": "进度条圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "progress", - "description": "progress 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "track", - "description": "track 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "centerX", - "description": "中心点 x 坐标", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "centerY", - "description": "中心点 y 坐标", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "outerRadius", - "description": "扇区外半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "innerRadius", - "description": "扇区内半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "startAngle", - "description": "扇区起始角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "endAngle", - "description": "扇区结束角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "数值字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "radiusField", - "description": "radiusField 配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "angleField", - "description": "angleField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "radius", - "description": "扇区半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "roundCap", - "description": "圆角部分是否突出（可分别设置左侧和右侧）", - "type": "boolean | [boolean, boolean]", - "originalType": "boolean | [boolean, boolean]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [ - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "tickMask", - "description": "tick 模式显示", - "type": "Omit, 'state'> & ITickMaskSpec", - "originalType": "Omit, 'state'> & ITickMaskSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec", - "ITickMaskSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "clamp", - "description": "超出轴范围是否被裁剪（除tick模式外, 因为tick模式自带裁剪）", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'grow' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "maxValue", - "description": "数据最大值，默认为 1", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 46 个属性（已展开所有继承）", - "expandedFrom": "ICircularProgressSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "track", + "description": "背景样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"circularProgress\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "circularProgress" ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:36:19.728Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/progress/circular/interface.d.ts", + ], "complexTypeDefinitions": { - "ICircularProgressSeriesSpec": { - "typeName": "ICircularProgressSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/progress/circular/interface.d.ts", - "note": "类型 ICircularProgressSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CircularProgressMarks": { + "typeName": "CircularProgressMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-26e9a8fad3db" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "ICircularProgressSeriesSpec": { + "typeName": "ICircularProgressSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-30261f5b0d11" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITickMaskSpec": { + "typeName": "ITickMaskSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ab1fc6a002d4" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "ProgressLikeAppearPreset": { + "typeName": "ProgressLikeAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-eb112c7e9a22" }, - "ITickMaskSpec": { - "typeName": "ITickMaskSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/polar/progress-like/interface.d.ts", - "note": "类型 ITickMaskSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 81, - "complexTypes": 34, - "typeFileLocations": 34, - "dependencyTypes": 866 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/common.json b/skills/vchart-development-assistant/references/type-meta/common.json index 600f8300d3..6af45c83e3 100644 --- a/skills/vchart-development-assistant/references/type-meta/common.json +++ b/skills/vchart-development-assistant/references/type-meta/common.json @@ -1,770 +1,853 @@ { "typeName": "ICommonChartSpec", - "description": "ICommonChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ICommonChartSpec": { - "description": "ICommonChartSpec 接口配置", - "directExtends": [ - "Omit" - ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'common'", - "originalType": "'common'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "(IAreaSeriesSpec | ILineSeriesSpec | IBarSeriesSpec | IRangeColumnChartSpec | IRangeAreaChartSpec | IDotSeriesSpec | IMapSeriesSpec | IPieSeriesSpec | ILinkSeriesSpec | IRadarSeriesSpec | IRoseSeriesSpec | IScatterSeriesSpec | ICircularProgressSeriesSpec | ILinearProgressSeriesSpec | IWordCloudSeriesSpec | IFunnelSeriesSpec | IBoxPlotSeriesSpec | IGaugeSeriesSpec | ISankeySeriesSpec | ITreemapSeriesSpec | ISunburstSeriesSpec | ICirclePackingSeriesSpec | IWaterfallSeriesSpec | IHeatmapSeriesSpec | IGaugePointerSeriesSpec | ICorrelationSeriesSpec)[]", - "originalType": "(IAreaSeriesSpec | ILineSeriesSpec | IBarSeriesSpec | IRangeColumnChartSpec | IRangeAreaChartSpec | IDotSeriesSpec | IMapSeriesSpec | IPieSeriesSpec | ILinkSeriesSpec | IRadarSeriesSpec | IRoseSeriesSpec | IScatterSeriesSpec | ICircularProgressSeriesSpec | ILinearProgressSeriesSpec | IWordCloudSeriesSpec | IFunnelSeriesSpec | IBoxPlotSeriesSpec | IGaugeSeriesSpec | ISankeySeriesSpec | ITreemapSeriesSpec | ISunburstSeriesSpec | ICirclePackingSeriesSpec | IWaterfallSeriesSpec | IHeatmapSeriesSpec | IGaugePointerSeriesSpec | ICorrelationSeriesSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IAreaSeriesSpec", - "ILineSeriesSpec", - "IBarSeriesSpec", - "IRangeColumnChartSpec", - "IRangeAreaChartSpec", - "IDotSeriesSpec", - "IMapSeriesSpec", - "IPieSeriesSpec", - "ILinkSeriesSpec", - "IRadarSeriesSpec", - "IRoseSeriesSpec", - "IScatterSeriesSpec", - "ICircularProgressSeriesSpec", - "ILinearProgressSeriesSpec", - "IWordCloudSeriesSpec", - "IFunnelSeriesSpec", - "IBoxPlotSeriesSpec", - "IGaugeSeriesSpec", - "ISankeySeriesSpec", - "ITreemapSeriesSpec", - "ISunburstSeriesSpec", - "ICirclePackingSeriesSpec", - "IWaterfallSeriesSpec", - "IHeatmapSeriesSpec", - "IGaugePointerSeriesSpec", - "ICorrelationSeriesSpec" - ] - }, - { - "name": "axes", - "description": "坐标轴配置", - "type": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "originalType": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec", - "IPolarAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec", - "IPolarCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "**仅适用于笛卡尔坐标系**，参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "**仅适用于笛卡尔坐标系**，参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "**仅适用于笛卡尔坐标系**，参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - }, - { - "name": "autoBandSize", - "description": "是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度", - "type": "boolean | {\n extend: number;\n }", - "originalType": "boolean | {\n extend: number;\n }", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "autoBandSize", + "description": "是否开启自动 bandSize。如果开启，会根据传入的 barWidth 等配置自动计算 bandSize，从而影响轴实际长度", + "type": "{\n extend: number;\n} | boolean | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.11.2" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "坐标轴配置", + "type": "ICartesianAxisSpec[] | IPolarAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec", + "IPolarAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | IPolarCrosshairSpec | IPolarCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" ] }, - "Omit": { - "description": "IChartSpec 的属性（排除 series）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "**仅适用于笛卡尔坐标系**，参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "**仅适用于笛卡尔坐标系**，参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "**仅适用于笛卡尔坐标系**，参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 29 个属性（已展开所有继承）", - "expandedFrom": "IChartSpec", - "omittedKeys": [ - "series" + "since": "1.8.0" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "series 配置", + "type": "(IAreaSeriesSpec | IBarSeriesSpec | IBoxPlotSeriesSpec | ICirclePackingSeriesSpec | ICircularProgressSeriesSpec | ICorrelationSeriesSpec | IFunnelSeriesSpec | IGaugePointerSeriesSpec | IGaugeSeriesSpec | IHeatmapSeriesSpec | ILinearProgressSeriesSpec | ILineSeriesSpec | IMapSeriesSpec | IPieSeriesSpec | IRadarSeriesSpec | IRangeAreaChartSpec | IRangeColumnChartSpec | IRoseSeriesSpec | ISankeySeriesSpec | IScatterSeriesSpec | ISunburstSeriesSpec | ITreemapSeriesSpec | IWaterfallSeriesSpec | IWordCloudSeriesSpec)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IAreaSeriesSpec", + "IBarSeriesSpec", + "IBoxPlotSeriesSpec", + "ICirclePackingSeriesSpec", + "ICircularProgressSeriesSpec", + "ICorrelationSeriesSpec", + "IFunnelSeriesSpec", + "IGaugePointerSeriesSpec", + "IGaugeSeriesSpec", + "IHeatmapSeriesSpec", + "ILinearProgressSeriesSpec", + "ILineSeriesSpec", + "IMapSeriesSpec", + "IPieSeriesSpec", + "IRadarSeriesSpec", + "IRangeAreaChartSpec", + "IRangeColumnChartSpec", + "IRoseSeriesSpec", + "ISankeySeriesSpec", + "IScatterSeriesSpec", + "ISunburstSeriesSpec", + "ITreemapSeriesSpec", + "IWaterfallSeriesSpec", + "IWordCloudSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"common\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "common" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:00:37.268Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/common/interface.d.ts", + ], "complexTypeDefinitions": { + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, "IAreaSeriesSpec": { "typeName": "IAreaSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/area/interface.d.ts", - "note": "类型 IAreaSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3c1aa405c767" }, - "ILineSeriesSpec": { - "typeName": "ILineSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/line/interface.d.ts", - "note": "类型 ILineSeriesSpec 的定义位置" + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" }, "IBarSeriesSpec": { "typeName": "IBarSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IBarSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e01baddbd8aa" }, - "IRangeColumnChartSpec": { - "typeName": "IRangeColumnChartSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/range-column/interface.d.ts", - "note": "类型 IRangeColumnChartSpec 的定义位置" + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" }, - "IRangeAreaChartSpec": { - "typeName": "IRangeAreaChartSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/range-area/interface.d.ts", - "note": "类型 IRangeAreaChartSpec 的定义位置" + "IBoxPlotSeriesSpec": { + "typeName": "IBoxPlotSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4f696616234f" }, - "IDotSeriesSpec": { - "typeName": "IDotSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/dot/interface.d.ts", - "note": "类型 IDotSeriesSpec 的定义位置" + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, - "IMapSeriesSpec": { - "typeName": "IMapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/map/interface.d.ts", - "note": "类型 IMapSeriesSpec 的定义位置" + "ICartesianAxisSpec": { + "typeName": "ICartesianAxisSpec", + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, - "IPieSeriesSpec": { - "typeName": "IPieSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/pie/interface.d.ts", - "note": "类型 IPieSeriesSpec 的定义位置" + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "ILinkSeriesSpec": { - "typeName": "ILinkSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/link/interface.d.ts", - "note": "类型 ILinkSeriesSpec 的定义位置" + "ICirclePackingSeriesSpec": { + "typeName": "ICirclePackingSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-bbcfdbd7ab2b" }, - "IRadarSeriesSpec": { - "typeName": "IRadarSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/radar/interface.d.ts", - "note": "类型 IRadarSeriesSpec 的定义位置" + "ICircularProgressSeriesSpec": { + "typeName": "ICircularProgressSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-30261f5b0d11" }, - "IRoseSeriesSpec": { - "typeName": "IRoseSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/rose/interface.d.ts", - "note": "类型 IRoseSeriesSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IScatterSeriesSpec": { - "typeName": "IScatterSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/scatter/interface.d.ts", - "note": "类型 IScatterSeriesSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "ICircularProgressSeriesSpec": { - "typeName": "ICircularProgressSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/progress/circular/interface.d.ts", - "note": "类型 ICircularProgressSeriesSpec 的定义位置" + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" }, - "ILinearProgressSeriesSpec": { - "typeName": "ILinearProgressSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/progress/linear/interface.d.ts", - "note": "类型 ILinearProgressSeriesSpec 的定义位置" + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "IWordCloudSeriesSpec": { - "typeName": "IWordCloudSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/word-cloud/interface.d.ts", - "note": "类型 IWordCloudSeriesSpec 的定义位置" + "ICorrelationSeriesSpec": { + "typeName": "ICorrelationSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-129af10992bf" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" }, "IFunnelSeriesSpec": { "typeName": "IFunnelSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/funnel/interface.d.ts", - "note": "类型 IFunnelSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0291e38eb55c" }, - "IBoxPlotSeriesSpec": { - "typeName": "IBoxPlotSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/box-plot/interface.d.ts", - "note": "类型 IBoxPlotSeriesSpec 的定义位置" + "IGaugePointerSeriesSpec": { + "typeName": "IGaugePointerSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fdd71c680f3" }, "IGaugeSeriesSpec": { "typeName": "IGaugeSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/gauge/interface.d.ts", - "note": "类型 IGaugeSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-dfd9dde34e4c" }, - "ISankeySeriesSpec": { - "typeName": "ISankeySeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/sankey/interface.d.ts", - "note": "类型 ISankeySeriesSpec 的定义位置" + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" }, - "ITreemapSeriesSpec": { - "typeName": "ITreemapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/treemap/interface.d.ts", - "note": "类型 ITreemapSeriesSpec 的定义位置" + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, - "ISunburstSeriesSpec": { - "typeName": "ISunburstSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/sunburst/interface.d.ts", - "note": "类型 ISunburstSeriesSpec 的定义位置" + "IHeatmapSeriesSpec": { + "typeName": "IHeatmapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6600af61a1ec" }, - "ICirclePackingSeriesSpec": { - "typeName": "ICirclePackingSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/circle-packing/interface.d.ts", - "note": "类型 ICirclePackingSeriesSpec 的定义位置" + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "IWaterfallSeriesSpec": { - "typeName": "IWaterfallSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/waterfall/interface.d.ts", - "note": "类型 IWaterfallSeriesSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "IHeatmapSeriesSpec": { - "typeName": "IHeatmapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/heatmap/interface.d.ts", - "note": "类型 IHeatmapSeriesSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" }, - "IGaugePointerSeriesSpec": { - "typeName": "IGaugePointerSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/gauge/interface.d.ts", - "note": "类型 IGaugePointerSeriesSpec 的定义位置" + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, - "ICorrelationSeriesSpec": { - "typeName": "ICorrelationSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/correlation/interface.d.ts", - "note": "类型 ICorrelationSeriesSpec 的定义位置" + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, - "ICartesianAxisSpec": { - "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ICartesianCrosshairSpec": { - "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "ILinearProgressSeriesSpec": { + "typeName": "ILinearProgressSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a272f43e66ef" }, - "IPolarCrosshairSpec": { - "typeName": "IPolarCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 IPolarCrosshairSpec 的定义位置" + "ILineSeriesSpec": { + "typeName": "ILineSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c14fbe0b660f" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IMapSeriesSpec": { + "typeName": "IMapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f28afaaaf021" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" }, "IMarkAreaSpec": { "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" }, - "IData": { - "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" }, - "IHoverSpec": { - "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" }, - "ILayoutSpec": { - "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" }, - "ILegendSpec": { - "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPieSeriesSpec": { + "typeName": "IPieSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-71acefc8c120" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadarSeriesSpec": { + "typeName": "IRadarSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-702f2f2e90b8" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRangeAreaChartSpec": { + "typeName": "IRangeAreaChartSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3a7b7d9563aa" + }, + "IRangeColumnChartSpec": { + "typeName": "IRangeColumnChartSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-da04864ad35f" + }, + "IRoseSeriesSpec": { + "typeName": "IRoseSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-50a9d844112a" + }, + "ISankeySeriesSpec": { + "typeName": "ISankeySeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-73ad288a6b3a" + }, + "IScatterSeriesSpec": { + "typeName": "IScatterSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-08a7bd218e9e" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "ISunburstSeriesSpec": { + "typeName": "ISunburstSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-42998a239bf0" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITreemapSeriesSpec": { + "typeName": "ITreemapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6cdfbc0c0174" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "IWaterfallSeriesSpec": { + "typeName": "IWaterfallSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-312af991e7a8" + }, + "IWordCloudSeriesSpec": { + "typeName": "IWordCloudSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-472dc2c97d50" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" } - }, - "statistics": { - "totalInterfaces": 2, - "totalProperties": 38, - "complexTypes": 54, - "typeFileLocations": 54, - "dependencyTypes": 923 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/correlation.json b/skills/vchart-development-assistant/references/type-meta/correlation.json index f17a9424b8..a5305c6836 100644 --- a/skills/vchart-development-assistant/references/type-meta/correlation.json +++ b/skills/vchart-development-assistant/references/type-meta/correlation.json @@ -1,772 +1,1010 @@ { "typeName": "ICorrelationChartSpec", - "description": "ICorrelationChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ICorrelationChartSpec": { - "description": "ICorrelationChartSpec 接口配置", - "directExtends": [ - "Omit", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationAppearPreset", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'correlation'", - "originalType": "'correlation'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ICorrelationSeriesSpec[]", - "originalType": "ICorrelationSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICorrelationSeriesSpec" - ] - } - ] - }, - "Omit": { - "description": "IChartSpec 的属性（排除 padding）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "CorrelationMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "节点名称字段配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerLabel", + "description": "中心点label属性 *", + "type": "(ILabelSpec & {\n position?: \"bottom-left\" | \"bottom-right\" | \"bottom\" | \"center\" | \"left\" | \"right\" | \"top-left\" | \"top-right\" | \"top\" | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "centerPoint", + "description": "中心点图元属性 *", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "centerX", + "description": "图表中心点位置X坐标", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "图表中心点位置Y坐标", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "endAngle", + "description": "图表终止角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "innerRadius", + "description": "节点分布内半径", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 29 个属性（已展开所有继承）", - "expandedFrom": "IChartSpec", - "omittedKeys": [ - "padding" - ] - }, - "IChartExtendsSeriesSpec": { - "description": "ICorrelationSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'scaleIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'correlation'", - "originalType": "'correlation'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "节点名称字段配置", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "相关性数据字段配置", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "seriesField", - "description": "节点系列字段配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sizeField", - "description": "节点尺寸数据字段配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sizeRange", - "description": "节点尺寸映射范围", - "type": "number[]", - "originalType": "number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centerX", - "description": "图表中心点位置X坐标", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centerY", - "description": "图表中心点位置Y坐标", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "innerRadius", - "description": "节点分布内半径", - "type": "string | number", - "originalType": "string | number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "outerRadius", - "description": "节点分布外半径", - "type": "string | number", - "originalType": "string | number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "startAngle", - "description": "图表起始角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "endAngle", - "description": "图表终止角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centerPoint", - "description": "centerPoint 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "ripplePoint", - "description": "ripplePoint 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRippleMarkSpec" - ] - }, - { - "name": "centerLabel", - "description": "centerLabel 配置", - "type": "ILabelSpec & {\n position?: 'top' | 'bottom' | 'left' | 'right' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' | 'center';\n }", - "originalType": "ILabelSpec & {\n position?: 'top' | 'bottom' | 'left' | 'right' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left' | 'center';\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "nodePoint", - "description": "nodePoint 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILabelSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nodePoint", + "description": "节点图元属性 *", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "outerRadius", + "description": "节点分布外半径", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "radius", + "description": "扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "ripplePoint", + "description": "水波纹图元属性 *", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRippleMarkSpec" + ] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ICorrelationSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICorrelationSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "节点系列字段配置", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sizeField", + "description": "节点尺寸数据字段配置", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "sizeRange", + "description": "节点尺寸映射范围", + "type": "number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "图表起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 21 个属性（已展开所有继承）", - "expandedFrom": "ICorrelationSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"correlation\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "correlation" ] + }, + { + "name": "valueField", + "description": "相关性数据字段配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:37:26.940Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/correlation/interface.d.ts", + ], "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "CorrelationAppearPreset": { + "typeName": "CorrelationAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9e370720e4c3" + }, + "CorrelationMarks": { + "typeName": "CorrelationMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-bdf6cade9a59" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, "ICorrelationSeriesSpec": { "typeName": "ICorrelationSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/correlation/interface.d.ts", - "note": "类型 ICorrelationSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-129af10992bf" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" - }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRippleMarkSpec": { + "typeName": "IRippleMarkSpec", + "reference": "type-details/IRippleMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "ISymbolMarkSpec": { - "typeName": "ISymbolMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ISymbolMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IRippleMarkSpec": { - "typeName": "IRippleMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRippleMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 52, - "complexTypes": 26, - "typeFileLocations": 26, - "dependencyTypes": 850 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/funnel.json b/skills/vchart-development-assistant/references/type-meta/funnel.json index b007e437cf..c1a038a982 100644 --- a/skills/vchart-development-assistant/references/type-meta/funnel.json +++ b/skills/vchart-development-assistant/references/type-meta/funnel.json @@ -1,1076 +1,1031 @@ { "typeName": "IFunnelChartSpec", - "description": "IFunnelChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IFunnelChartSpec": { - "description": "IFunnelChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "FunnelAppearPreset", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "funnel", + "description": "漏斗层样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "funnelAlign", + "description": "漏斗图对齐方式。转化漏斗图仅支持'center'", + "type": "\"center\" | \"left\" | \"right\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'center'", + "literalValues": [ + "center", + "left", + "right" + ] + }, + { + "name": "funnelOrient", + "description": "漏斗图朝向。", + "type": "IOrientType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'top'", + "literalValues": [ + "bottom", + "left", + "right", + "top", + "z" + ] + }, + { + "name": "gap", + "description": "漏斗层之间的像素间隔。转化漏斗图不支持gap配置。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "heightRatio", + "description": "漏斗层与转化层的图形高度比例\nThe height ratio between the funnel graphic and the transform graphic", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.5", + "since": "1.10.1" + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "isCone", + "description": "漏斗图最下层是否尖角。shape为`rect`时不生效", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "true" + }, + { + "name": "isTransform", + "description": "是否是转化漏斗图", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "label", + "description": "漏斗层标签配置", + "type": "IFunnelLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maxSize", + "description": "漏斗图最大宽度，支持配置像素值和百分比字符串。", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'80%'" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'funnel'", - "originalType": "'funnel'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.8.0" + }, + { + "name": "minSize", + "description": "漏斗图最小宽度，支持配置像素值和百分比字符串。", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerLabel", + "description": "漏斗层外部标签配置", + "type": "IFunnelOuterLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelOuterLabelSpec" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "range", + "description": "指定数值映射范围，range.min 映射到 minSize，range.max 映射到 maxSize。\nrange.min 默认为 0，range.max 默认为数据最大值。", + "type": "{\n min?: number | undefined;\n max?: number | undefined;\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "shape", + "description": "图元形状。转化漏斗图仅支持 'rect'", + "type": "\"rect\" | \"trapezoid\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'trapezoid'", + "literalValues": [ + "rect", + "trapezoid" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" ] }, - "IChartExtendsSeriesSpec": { - "description": "IFunnelSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'funnel'", - "originalType": "'funnel'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'clipIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "数值字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "funnelOrient", - "description": "漏斗图朝向。", - "type": "'left' | 'top' | 'right' | 'bottom' | 'z'", - "originalType": "IOrientType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "shape", - "description": "图元形状。转化漏斗图仅支持 'rect'", - "type": "'rect' | 'trapezoid'", - "originalType": "'rect' | 'trapezoid'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "isTransform", - "description": "是否是转化漏斗图", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "isCone", - "description": "漏斗图最下层是否尖角。shape为`rect`时不生效", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "funnelAlign", - "description": "漏斗图对齐方式。转化漏斗图仅支持'center'", - "type": "'left' | 'center' | 'right'", - "originalType": "'left' | 'center' | 'right'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "gap", - "description": "漏斗层之间的像素间隔。转化漏斗图不支持gap配置。", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "range", - "description": "指定数据项的最大值和最小值", - "type": "{\n min?: number;\n max?: number;\n }", - "originalType": "{\n min?: number;\n max?: number;\n }", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxSize", - "description": "漏斗图最大宽度，支持配置像素值和百分比字符串。", - "type": "number | IPercent", - "originalType": "number | IPercent", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPercent" - ] - }, - { - "name": "minSize", - "description": "漏斗图最小宽度，支持配置像素值和百分比字符串。", - "type": "number | IPercent", - "originalType": "number | IPercent", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPercent" - ] - }, - { - "name": "heightRatio", - "description": "漏斗层与转化层的图形高度比例 The height ratio between the funnel graphic and the transform graphic", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "transformRatioText", - "description": "漏斗图转化率文案，用于转化层 tooltip key 的显示内容", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "funnel", - "description": "funnel 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "transform", - "description": "transform 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IFunnelLabelSpec", - "originalType": "IFunnelLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IFunnelLabelSpec" - ] - }, - { - "name": "outerLabel", - "description": "outerLabel 配置", - "type": "IFunnelOuterLabelSpec", - "originalType": "IFunnelOuterLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IFunnelOuterLabelSpec" - ] - }, - { - "name": "transformLabel", - "description": "transformLabel 配置", - "type": "IFunnelLabelSpec", - "originalType": "IFunnelLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IFunnelLabelSpec" - ] - } + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 45 个属性（已展开所有继承）", - "expandedFrom": "IFunnelSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "transform", + "description": "转化层样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "transformLabel", + "description": "转化层标签配置", + "type": "IFunnelLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelLabelSpec" + ] + }, + { + "name": "transformRatioText", + "description": "漏斗图转化率文案，用于转化层 tooltip key 的显示内容", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'转化率'", + "since": "1.13.6" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"funnel\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "funnel" ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:38:20.505Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/funnel/interface.d.ts", + ], "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "FunnelAppearPreset": { + "typeName": "FunnelAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ca0d8e9e8ab0" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IFunnelLabelSpec": { + "typeName": "IFunnelLabelSpec", + "reference": "type-details/IFunnelLabelSpec-Type-Definition.md" + }, + "IFunnelOuterLabelSpec": { + "typeName": "IFunnelOuterLabelSpec", + "reference": "type-details/IFunnelOuterLabelSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPathMarkSpec": { + "typeName": "IPathMarkSpec", + "reference": "type-details/IPathMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" - }, - "IPercent": { - "typeName": "IPercent", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 IPercent 的定义位置" - }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IPathMarkSpec": { - "typeName": "IPathMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IPathMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IFunnelLabelSpec": { - "typeName": "IFunnelLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/funnel/interface.d.ts", - "note": "类型 IFunnelLabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IFunnelOuterLabelSpec": { - "typeName": "IFunnelOuterLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/funnel/interface.d.ts", - "note": "类型 IFunnelOuterLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 76, - "complexTypes": 32, - "typeFileLocations": 32, - "dependencyTypes": 853 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/funnel3d.json b/skills/vchart-development-assistant/references/type-meta/funnel3d.json new file mode 100644 index 0000000000..3ed163188b --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/funnel3d.json @@ -0,0 +1,1039 @@ +{ + "typeName": "IFunnel3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "FunnelAppearPreset", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "funnel", + "description": "漏斗层样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "funnelAlign", + "description": "漏斗图对齐方式。转化漏斗图仅支持'center'", + "type": "\"center\" | \"left\" | \"right\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'center'", + "literalValues": [ + "center", + "left", + "right" + ] + }, + { + "name": "funnelOrient", + "description": "漏斗图朝向。", + "type": "IOrientType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'top'", + "literalValues": [ + "bottom", + "left", + "right", + "top", + "z" + ] + }, + { + "name": "gap", + "description": "漏斗层之间的像素间隔。转化漏斗图不支持gap配置。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "heightRatio", + "description": "漏斗层与转化层的图形高度比例\nThe height ratio between the funnel graphic and the transform graphic", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.5", + "since": "1.10.1" + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "isCone", + "description": "漏斗图最下层是否尖角。shape为`rect`时不生效", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "true" + }, + { + "name": "isTransform", + "description": "是否是转化漏斗图", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "label", + "description": "漏斗层标签配置", + "type": "IFunnelLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maxSize", + "description": "漏斗图最大宽度，支持配置像素值和百分比字符串。", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'80%'" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "minSize", + "description": "漏斗图最小宽度，支持配置像素值和百分比字符串。", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerLabel", + "description": "漏斗层外部标签配置", + "type": "IFunnelOuterLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelOuterLabelSpec" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "range", + "description": "指定数值映射范围，range.min 映射到 minSize，range.max 映射到 maxSize。\nrange.min 默认为 0，range.max 默认为数据最大值。", + "type": "{\n min?: number | undefined;\n max?: number | undefined;\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "shape", + "description": "图元形状。转化漏斗图仅支持 'rect'", + "type": "\"rect\" | \"trapezoid\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'trapezoid'", + "literalValues": [ + "rect", + "trapezoid" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "transform", + "description": "转化层样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "transformLabel", + "description": "转化层标签配置", + "type": "IFunnelLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFunnelLabelSpec" + ] + }, + { + "name": "transformRatioText", + "description": "漏斗图转化率文案，用于转化层 tooltip key 的显示内容", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'转化率'", + "since": "1.13.6" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"funnel3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "funnel3d" + ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "FunnelAppearPreset": { + "typeName": "FunnelAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ca0d8e9e8ab0" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IFunnelLabelSpec": { + "typeName": "IFunnelLabelSpec", + "reference": "type-details/IFunnelLabelSpec-Type-Definition.md" + }, + "IFunnelOuterLabelSpec": { + "typeName": "IFunnelOuterLabelSpec", + "reference": "type-details/IFunnelOuterLabelSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPathMarkSpec": { + "typeName": "IPathMarkSpec", + "reference": "type-details/IPathMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + } + }, + "registration": [ + "registerFunnel3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] +} diff --git a/skills/vchart-development-assistant/references/type-meta/gauge.json b/skills/vchart-development-assistant/references/type-meta/gauge.json index 64a59ff8cf..63cfd67c2f 100644 --- a/skills/vchart-development-assistant/references/type-meta/gauge.json +++ b/skills/vchart-development-assistant/references/type-meta/gauge.json @@ -1,1180 +1,1129 @@ { "typeName": "IGaugeChartSpec", - "description": "IGaugeChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IGaugeChartSpec": { - "description": "IGaugeChartSpec 接口配置", - "directExtends": [ - "Omit", - "Omit" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "ProgressLikeAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "GaugePointerMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴配置", + "type": "(ILinearAxisSpec | IPolarAxisSpec)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILinearAxisSpec", + "IPolarAxisSpec", + "IPolarBandAxisSpec", + "IPolarLinearAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "类别字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "centerX", + "description": "中心点 x 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "中心点 y 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "clamp", + "description": "超出轴范围是否被裁剪（除tick模式外, 因为tick模式自带裁剪）", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.13.9" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "cornerRadius", + "description": "圆角半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "endAngle", + "description": "扇区结束角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "gauge", + "description": "表盘背景，可选择 gauge 系列或 circularProgress 系列的配置", + "type": "Omit | Omit | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICircularProgressSeriesSpec", + "IGaugeSeriesSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "indicator", + "description": "指标卡配置", + "type": "IIndicatorSpec | IIndicatorSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IIndicatorSpec" + ] + }, + { + "name": "innerRadius", + "description": "扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutRadius", + "description": "layoutRadius 配置", + "type": "\"auto\" | ((layoutRect: ILayoutRect, center: IPointLike) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutRect", + "IPointLike" + ], + "since": "1.11.2", + "literalValues": [ + "auto" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'gauge'", - "originalType": "'gauge'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "gauge", - "description": "表盘背景，可选择 gauge 系列或 circularProgress 系列的配置", - "type": "Omit | Omit", - "originalType": "Omit | Omit", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IGaugeSeriesSpec", - "ICircularProgressSeriesSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "(IPolarAxisSpec | ILinearAxisSpec)[]", - "originalType": "(IPolarAxisSpec | ILinearAxisSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarAxisSpec", - "ILinearAxisSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "pin", + "description": "图钉前景样式", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & PinMarkSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "IPathMarkSpec", + "PinMarkSpec" + ] + }, + { + "name": "pinBackground", + "description": "图钉背景样式", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & PinMarkSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "IPathMarkSpec", + "PinMarkSpec" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "pointer", + "description": "指针样式", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & PointerMarkSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "IPathMarkSpec", + "IRectMarkSpec", + "PointerMarkSpec" + ] + }, + { + "name": "radius", + "description": "扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "半径字段（可影响指针长度，GaugePointerSeries 没有 categoryField）", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "roundCap", + "description": "圆角部分是否突出（可分别设置左侧和右侧）", + "type": "[\n boolean,\n boolean\n] | boolean | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" ] }, - "Omit": { - "description": "IPolarChartSpec 的属性（排除 axes）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "originalType": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarCrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IChartSpec" - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ], - "inheritedFrom": "IChartSpec" - }, - { - "name": "layoutRadius", - "description": "layoutRadius 配置", - "type": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "originalType": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "indicator", - "description": "指标卡配置", - "type": "IIndicatorSpec | IIndicatorSpec[]", - "originalType": "IIndicatorSpec | IIndicatorSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IIndicatorSpec" - ] - } + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "stackValue", + "description": "堆叠时的分组值\nstackValue 相等的系列将在一起堆积。没有配置的系列将在一组", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "startAngle", + "description": "扇区起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "tickMask", + "description": "tick 模式显示", + "type": "(Omit, \"state\"> & ITickMaskSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec", + "ITickMaskSpec" ], - "note": "展开自 Omit - 包含 31 个属性（已展开所有继承）", - "expandedFrom": "IPolarChartSpec", - "omittedKeys": [ - "axes" + "since": "1.4.0" + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" ] }, - "Omit": { - "description": "IGaugePointerSeriesSpec 的属性（排除 data, type, morph, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "stackValue", - "description": "堆叠时的分组值 stackValue 相等的系列将在一起堆积。没有配置的系列将在一组", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "centerX", - "description": "中心点 x 坐标", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "centerY", - "description": "中心点 y 坐标", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "outerRadius", - "description": "扇区外半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "innerRadius", - "description": "扇区内半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "startAngle", - "description": "扇区起始角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "endAngle", - "description": "扇区结束角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "categoryField", - "description": "类别字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "valueField", - "description": "数值字段（可影响指针角度）", - "type": "string | string[]", - "originalType": "string | string[]", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "radiusField", - "description": "半径字段（可影响指针长度，GaugePointerSeries 没有 categoryField）", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "angleField", - "description": "angleField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "radius", - "description": "扇区半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "roundCap", - "description": "圆角部分是否突出（可分别设置左侧和右侧）", - "type": "boolean | [boolean, boolean]", - "originalType": "boolean | [boolean, boolean]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [ - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "cornerRadius", - "description": "圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "tickMask", - "description": "tick 模式显示", - "type": "Omit, 'state'> & ITickMaskSpec", - "originalType": "Omit, 'state'> & ITickMaskSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec", - "ITickMaskSpec" - ], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "clamp", - "description": "超出轴范围是否被裁剪（除tick模式外, 因为tick模式自带裁剪）", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressLikeSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'grow' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "pin", - "description": "pin 配置", - "type": "IMarkSpec & PinMarkSpec", - "originalType": "IMarkSpec & PinMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "pinBackground", - "description": "pinBackground 配置", - "type": "IMarkSpec & PinMarkSpec", - "originalType": "IMarkSpec & PinMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "pointer", - "description": "pointer 配置", - "type": "IMarkSpec & PointerMarkSpec", - "originalType": "IMarkSpec & PointerMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - } + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 46 个属性（已展开所有继承）", - "expandedFrom": "IGaugePointerSeriesSpec", - "omittedKeys": [ - "data", - "type", - "morph", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"gauge\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "gauge" ] + }, + { + "name": "valueField", + "description": "数值字段（可影响指针角度）", + "type": "string | string[]", + "required": true, + "isSimple": false, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:10:18.432Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/gauge/interface.d.ts", + ], "complexTypeDefinitions": { - "IGaugeSeriesSpec": { - "typeName": "IGaugeSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/gauge/interface.d.ts", - "note": "类型 IGaugeSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "GaugePointerMarks": { + "typeName": "GaugePointerMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1acef37a74c3" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICircularProgressSeriesSpec": { "typeName": "ICircularProgressSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/progress/circular/interface.d.ts", - "note": "类型 ICircularProgressSeriesSpec 的定义位置" + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-30261f5b0d11" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "ILinearAxisSpec": { - "typeName": "ILinearAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ILinearAxisSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGaugeSeriesSpec": { + "typeName": "IGaugeSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-dfd9dde34e4c" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IIndicatorSpec": { + "typeName": "IIndicatorSpec", + "reference": "type-details/IIndicatorSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutRect": { + "typeName": "ILayoutRect", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4324e55ab6b" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "IPolarCrosshairSpec": { - "typeName": "IPolarCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 IPolarCrosshairSpec 的定义位置" + "ILinearAxisSpec": { + "typeName": "ILinearAxisSpec", + "reference": "type-details/ILinearAxisSpec-Type-Definition.md" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPathMarkSpec": { + "typeName": "IPathMarkSpec", + "reference": "type-details/IPathMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPointLike": { + "typeName": "IPointLike", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e25b463f6cfe", + "package": "@visactor/vutils", + "version": "1.0.28" + }, + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarBandAxisSpec": { + "typeName": "IPolarBandAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3621aa2a35eb" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IPolarLinearAxisSpec": { + "typeName": "IPolarLinearAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ee0a50d0f01" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITickMaskSpec": { + "typeName": "ITickMaskSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ab1fc6a002d4" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IIndicatorSpec": { - "typeName": "IIndicatorSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/indicator/interface.d.ts", - "note": "类型 IIndicatorSpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "PinMarkSpec": { + "typeName": "PinMarkSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d46655d2cdbe" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "PointerMarkSpec": { + "typeName": "PointerMarkSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f4b734667103" }, - "ITickMaskSpec": { - "typeName": "ITickMaskSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/polar/progress-like/interface.d.ts", - "note": "类型 ITickMaskSpec 的定义位置" + "ProgressLikeAppearPreset": { + "typeName": "ProgressLikeAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-eb112c7e9a22" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IPathMarkSpec": { - "typeName": "IPathMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IPathMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 80, - "complexTypes": 36, - "typeFileLocations": 36, - "dependencyTypes": 865 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/heatmap.json b/skills/vchart-development-assistant/references/type-meta/heatmap.json index e238a5a4e5..704219157d 100644 --- a/skills/vchart-development-assistant/references/type-meta/heatmap.json +++ b/skills/vchart-development-assistant/references/type-meta/heatmap.json @@ -1,1108 +1,1201 @@ { "typeName": "IHeatmapChartSpec", - "description": "IHeatmapChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IHeatmapChartSpec": { - "description": "IHeatmapChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec<\"fadeIn\"> | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'heatmap'", - "originalType": "'heatmap'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IHeatmapSeriesSpec[]", - "originalType": "IHeatmapSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHeatmapSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "HeatmapMarks", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "cell", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "cellBackground", + "description": "图元背景配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "(ILabelSpec & {\n position?: \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IHeatmapSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHeatmapSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" ] }, - "IChartExtendsSeriesSpec": { - "description": "IHeatmapSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'heatmap'", - "originalType": "'heatmap'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "x轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "y轴字段 运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "valueField", - "description": "值 field", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "cell", - "description": "cell 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "cellBackground", - "description": "cellBackground 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "ILabelSpec & {\n position?: 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left';\n }", - "originalType": "ILabelSpec & {\n position?: 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left';\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - } + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 38 个属性（已展开所有继承）", - "expandedFrom": "IHeatmapSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"heatmap\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "heatmap" ] + }, + { + "name": "valueField", + "description": "值 field", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段\n运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:40:10.220Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/heatmap/interface.d.ts", + ], "complexTypeDefinitions": { - "IHeatmapSeriesSpec": { - "typeName": "IHeatmapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/heatmap/interface.d.ts", - "note": "类型 IHeatmapSeriesSpec 的定义位置" + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "HeatmapMarks": { + "typeName": "HeatmapMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5bfb84e5033a" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHeatmapSeriesSpec": { + "typeName": "IHeatmapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6600af61a1ec" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 76, - "complexTypes": 35, - "typeFileLocations": 35, - "dependencyTypes": 863 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/histogram.json b/skills/vchart-development-assistant/references/type-meta/histogram.json index 8285a952c0..fa28d5fb81 100644 --- a/skills/vchart-development-assistant/references/type-meta/histogram.json +++ b/skills/vchart-development-assistant/references/type-meta/histogram.json @@ -1,1185 +1,1307 @@ { "typeName": "IHistogramChartSpec", - "description": "IHistogramChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IHistogramChartSpec": { - "description": "IHistogramChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "Omit, 'type'>" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'histogram'", - "originalType": "'histogram'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" ] }, - "Omit, 'type'>": { - "description": "IChartExtendsSeriesSpec 的属性（排除 type）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "xField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "yField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "\"grow\" | \"fadeIn\" | \"scaleIn\" | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "activePoint", - "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "sampling", - "description": "数据采样 - 采样方法", - "type": "'lttb' | 'min' | 'max' | 'sum' | 'average'", - "originalType": "ISamplingMethod", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "samplingFactor", - "description": "数据采样 - 采样系数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "bar", - "description": "bar 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "barBackground", - "description": "barBackground 配置", - "type": "IMarkSpec & IBarBackgroundSpec", - "originalType": "IMarkSpec & IBarBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec", - "IBarBackgroundSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec & {\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "originalType": "IMultiLabelSpec & {\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILabelSpec" - ] - }, - { - "name": "barWidth", - "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMinWidth", - "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMaxWidth", - "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'） 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string", - "originalType": "number | string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barGapInGroup", - "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。 当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。 如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。 1. number 类型，表示像素值 2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", - "type": "number | string | (number | string)[]", - "originalType": "number | string | (number | string)[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "barMinHeight", - "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackCornerRadius", - "description": "堆叠柱整体的圆角 @since 1.10.0 圆角支持回调配置 @since 1.12.4", - "type": "number | number[] | IStackCornerRadiusCallback", - "originalType": "number | number[] | IStackCornerRadiusCallback", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IStackCornerRadiusCallback" - ] - }, - { - "name": "barGap", - "description": "柱条间 gap 值 @since 1.13.11", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position?: Functional<\"bottom-left\" | \"bottom-right\" | \"bottom\" | \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | \"left\" | \"outside\" | \"right\" | \"top-left\" | \"top-right\" | \"top\"> | undefined;\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "Functional", + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit, 'type'> - 包含 46 个属性（已展开所有继承）", - "expandedFrom": "IChartExtendsSeriesSpec", - "omittedKeys": [ - "type" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"histogram\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "histogram" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:41:08.221Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/histogram/interface.d.ts", + ], "complexTypeDefinitions": { + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "Functional": { + "typeName": "Functional", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2535a2dd9530", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" }, - "IPlayer": { - "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" }, - "IScrollBarSpec": { - "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" }, - "ITheme": { - "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" }, - "ITotalLabelSpec": { - "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" }, "IMarkSpec": { "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IRectMarkSpec": { "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, - "IBarBackgroundSpec": { - "typeName": "IBarBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IBarBackgroundSpec 的定义位置" + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" }, "IStackCornerRadiusCallback": { "typeName": "IStackCornerRadiusCallback", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/bar/interface.d.ts", - "note": "类型 IStackCornerRadiusCallback 的定义位置" + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 83, - "complexTypes": 36, - "typeFileLocations": 36, - "dependencyTypes": 866 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/histogram3d.json b/skills/vchart-development-assistant/references/type-meta/histogram3d.json new file mode 100644 index 0000000000..02ae9fe56d --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/histogram3d.json @@ -0,0 +1,1315 @@ +{ + "typeName": "IHistogram3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" + ], + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position?: Functional<\"bottom-left\" | \"bottom-right\" | \"bottom\" | \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | \"left\" | \"outside\" | \"right\" | \"top-left\" | \"top-right\" | \"top\"> | undefined;\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "Functional", + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"histogram3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "histogram3d" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段\ny轴字段\n运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "Functional": { + "typeName": "Functional", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2535a2dd9530", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianAxisSpec": { + "typeName": "ICartesianAxisSpec", + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + } + }, + "registration": [ + "registerHistogram3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] +} diff --git a/skills/vchart-development-assistant/references/type-meta/line.json b/skills/vchart-development-assistant/references/type-meta/line.json index f6b135cd18..3eb10e17c1 100644 --- a/skills/vchart-development-assistant/references/type-meta/line.json +++ b/skills/vchart-development-assistant/references/type-meta/line.json @@ -1,1201 +1,1301 @@ { "typeName": "ILineChartSpec", - "description": "ILineChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ILineChartSpec": { - "description": "ILineChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "LineAppearPreset", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'line'", - "originalType": "'line'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "ILineSeriesSpec[]", - "originalType": "ILineSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILineSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "LineMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineLikeLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "line", + "description": "线图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "lineLabel", + "description": "折线标签配置", + "type": "(Omit & {\n position?: \"end\" | \"start\" | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ], + "since": "1.7.0" + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markOverlap", + "description": "是否允许标记图形相互覆盖", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.6.0" + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "point", + "description": "点图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "pointDis", + "description": "标记点之间的距离，px", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0" + }, + { + "name": "pointDisMul", + "description": "标记点之间的距离， pointSize 的倍数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" ] }, - "IChartExtendsSeriesSpec": { - "description": "ILineSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'line'", - "originalType": "'line'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "x轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "y轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'clipIn' | 'fadeIn' | 'grow' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "activePoint", - "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sampling", - "description": "数据采样 - 采样方法", - "type": "'lttb' | 'min' | 'max' | 'sum' | 'average'", - "originalType": "ISamplingMethod", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "samplingFactor", - "description": "数据采样 - 采样系数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IDataSamping" - }, - { - "name": "pointDis", - "description": "标记点之间的距离，px", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "pointDisMul", - "description": "标记点之间的距离， pointSize 的倍数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "markOverlap", - "description": "是否允许标记图形相互覆盖", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "point", - "description": "point 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "line", - "description": "line 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILineMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILineLikeLabelSpec" - ] - }, - { - "name": "lineLabel", - "description": "lineLabel 配置", - "type": "Omit & {\n position?: 'start' | 'end';\n }", - "originalType": "Omit & {\n position?: 'start' | 'end';\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - }, - { - "name": "seriesMark", - "description": "系列主 mark 类型配置，该配置会影响图例的展示", - "type": "'line' | 'point'", - "originalType": "'line' | 'point'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "ILineSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesMark", + "description": "系列主 mark 类型配置，该配置会影响图例的展示", + "type": "\"line\" | \"point\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'line'", + "since": "1.2.0", + "literalValues": [ + "line", + "point" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 45 个属性（已展开所有继承）", - "expandedFrom": "ILineSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"line\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "line" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:42:01.949Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/line/interface.d.ts", + ], "complexTypeDefinitions": { - "ILineSeriesSpec": { - "typeName": "ILineSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/line/interface.d.ts", - "note": "类型 ILineSeriesSpec 的定义位置" + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILineLikeLabelSpec": { + "typeName": "ILineLikeLabelSpec", + "reference": "type-details/ILineLikeLabelSpec-Type-Definition.md" + }, + "ILineMarkSpec": { + "typeName": "ILineMarkSpec", + "reference": "type-details/ILineMarkSpec-Type-Definition.md" + }, + "ILineSeriesSpec": { + "typeName": "ILineSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c14fbe0b660f" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "LineAppearPreset": { + "typeName": "LineAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6966f849b7c7" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "LineMarks": { + "typeName": "LineMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-da75180b071f" }, - "ISymbolMarkSpec": { - "typeName": "ISymbolMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ISymbolMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "ILineMarkSpec": { - "typeName": "ILineMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ILineMarkSpec 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IMultiLabelSpec": { - "typeName": "IMultiLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 IMultiLabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ILineLikeLabelSpec": { - "typeName": "ILineLikeLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/mixin/interface.d.ts", - "note": "类型 ILineLikeLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 83, - "complexTypes": 38, - "typeFileLocations": 38, - "dependencyTypes": 866 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/linearProgress.json b/skills/vchart-development-assistant/references/type-meta/linearProgress.json index 0a6192dfd7..a4deafb0ab 100644 --- a/skills/vchart-development-assistant/references/type-meta/linearProgress.json +++ b/skills/vchart-development-assistant/references/type-meta/linearProgress.json @@ -1,1032 +1,954 @@ { "typeName": "ILinearProgressChartSpec", - "description": "ILinearProgressChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ILinearProgressChartSpec": { - "description": "ILinearProgressChartSpec 接口配置", - "directExtends": [ - "IProgressChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "LinearProgressAppearPreset", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'linearProgress'", - "originalType": "'linearProgress'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ILinearProgressSeriesSpec[]", - "originalType": "ILinearProgressSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILinearProgressSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "progress", + "track", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bandWidth", + "description": "进度条宽度\n以像素值(px)为单位", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "clamp", + "description": "超出轴范围是否被裁剪", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.13.9" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "cornerRadius", + "description": "进度条圆角半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" ] }, - "IProgressChartSpec": { - "description": "IProgressChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "方向", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "Direction.horizontal", + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "cornerRadius", - "description": "进度条圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "originalType": "ICartesianAxisSpec[] | IPolarAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec", - "IPolarAxisSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progress", + "description": "进度条样式\nTODO: 支持百分比作为padding, 类型为string", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & {\n topPadding?: number | undefined;\n bottomPadding?: number | undefined;\n leftPadding?: number | undefined;\n rightPadding?: number | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" ] }, - "IChartExtendsSeriesSpec": { - "description": "ILinearProgressSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'linearProgress'", - "originalType": "'linearProgress'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "cornerRadius", - "description": "进度条圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IProgressSeriesSpec" - }, - { - "name": "progress", - "description": "progress 配置", - "type": "IMarkSpec & {\n topPadding?: number;\n bottomPadding?: number;\n leftPadding?: number;\n rightPadding?: number;\n }", - "originalType": "IMarkSpec & {\n topPadding?: number;\n bottomPadding?: number;\n leftPadding?: number;\n rightPadding?: number;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "track", - "description": "track 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'grow' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "xField", - "description": "coordinate: 'cartesian' x轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "yField", - "description": "y轴字段 因为存在 direction，运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", - "type": "string | string[]", - "originalType": "string | string[]", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "direction", - "description": "direction 配置", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "bandWidth", - "description": "进度条宽度 以像素值(px)为单位", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "clamp", - "description": "超出轴范围是否被裁剪", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ILinearProgressSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILinearProgressSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 35 个属性（已展开所有继承）", - "expandedFrom": "ILinearProgressSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "track", + "description": "背景条样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"linearProgress\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "linearProgress" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "coordinate: 'cartesian'\nx轴字段", + "type": "string | string[]", + "required": true, + "isSimple": false, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段\n因为存在 direction，运行双轴都为离散，连续。所以 yField 也可以像 xField 一样支持多维度", + "type": "string | string[]", + "required": true, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:42:57.462Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/progress/linear/interface.d.ts", + ], "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, - "ILinearProgressSeriesSpec": { - "typeName": "ILinearProgressSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/progress/linear/interface.d.ts", - "note": "类型 ILinearProgressSeriesSpec 的定义位置" + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILinearProgressSeriesSpec": { + "typeName": "ILinearProgressSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a272f43e66ef" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "LinearProgressAppearPreset": { + "typeName": "LinearProgressAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1cff2ef63939" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "progress": { + "typeName": "progress", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a5db06e8dac0" }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "track": { + "typeName": "track", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3720a45bf7f9" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 71, - "complexTypes": 32, - "typeFileLocations": 32, - "dependencyTypes": 864 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/liquid.json b/skills/vchart-development-assistant/references/type-meta/liquid.json index 46ba29300a..c3b2e41b94 100644 --- a/skills/vchart-development-assistant/references/type-meta/liquid.json +++ b/skills/vchart-development-assistant/references/type-meta/liquid.json @@ -1,826 +1,989 @@ { "typeName": "ILiquidChartSpec", - "description": "ILiquidChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ILiquidChartSpec": { - "description": "ILiquidChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" - ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'liquid'", - "originalType": "'liquid'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "ILiquidSeriesSpec[]", - "originalType": "ILiquidSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILiquidSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "LiquidAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "ILiquidSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'wave' | 'grow' | 'waveGrow' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'liquid'", - "originalType": "'liquid'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "value字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maskShape", - "description": "轮廓形状", - "type": "LiquidShapeType", - "originalType": "LiquidShapeType", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "LiquidShapeType" - ] - }, - { - "name": "outlineMargin", - "description": "外轮廓与region边界之间的padding", - "type": "{\n left?: number;\n right?: number;\n top?: number;\n bottom?: number;\n} | number | number[]", - "originalType": "ILiquidPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "outlinePadding", - "description": "内轮廓与外轮廓之间的padding", - "type": "{\n left?: number;\n right?: number;\n top?: number;\n bottom?: number;\n} | number | number[]", - "originalType": "ILiquidPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "indicatorSmartInvert", - "description": "是否开启指标智能反色", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "reverse", - "description": "是否反向绘制", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "liquid", - "description": "liquid 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILiquidMarkSpec" - ] - }, - { - "name": "liquidBackground", - "description": "liquidBackground 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IGroupMarkSpec" - ] - }, - { - "name": "liquidOutline", - "description": "liquidOutline 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILiquidOutlineSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "indicatorSmartInvert", + "description": "是否开启指标智能反色", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "liquid", + "description": "水波图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILiquidMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "liquidBackground", + "description": "水波背景图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IGroupMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "liquidOutline", + "description": "水波外轮廓配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMark" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "maskShape", + "description": "轮廓形状", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'circle'" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 14 个属性（已展开所有继承）", - "expandedFrom": "ILiquidSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "outlineMargin", + "description": "外轮廓与region边界之间的padding", + "type": "ILiquidPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILiquidPadding", + "ILiquidPaddingSpec" + ] + }, + { + "name": "outlinePadding", + "description": "内轮廓与外轮廓之间的padding", + "type": "ILiquidPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILiquidPadding", + "ILiquidPaddingSpec" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "reverse", + "description": "是否反向绘制", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.11.10" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "ILiquidSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILiquidSeriesSpec" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"liquid\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "liquid" + ] + }, + { + "name": "valueField", + "description": "value字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:47:40.597Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/liquid/interface.d.ts", + ], "complexTypeDefinitions": { - "ILiquidSeriesSpec": { - "typeName": "ILiquidSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/liquid/interface.d.ts", - "note": "类型 ILiquidSeriesSpec 的定义位置" + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILiquidMarkSpec": { + "typeName": "ILiquidMarkSpec", + "reference": "type-details/ILiquidMarkSpec-Type-Definition.md" + }, + "ILiquidPadding": { + "typeName": "ILiquidPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-bef15b2fe03b" + }, + "ILiquidPaddingSpec": { + "typeName": "ILiquidPaddingSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2cf44bad013" + }, + "ILiquidSeriesSpec": { + "typeName": "ILiquidSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fbf087ad5565" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMark": { + "typeName": "ISymbolMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-dd0f2569fc22" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "LiquidShapeType": { - "typeName": "LiquidShapeType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/liquid/interface.d.ts", - "note": "类型 LiquidShapeType 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "LiquidAppearPreset": { + "typeName": "LiquidAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e2f6a6a53711" }, - "ILiquidMarkSpec": { - "typeName": "ILiquidMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ILiquidMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IGroupMarkSpec": { - "typeName": "IGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IGroupMarkSpec 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ILiquidOutlineSpec": { - "typeName": "ILiquidOutlineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/mark/interface/mark.d.ts", - "note": "类型 ISymbolMark 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 52, - "complexTypes": 34, - "typeFileLocations": 34, - "dependencyTypes": 882 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/map.json b/skills/vchart-development-assistant/references/type-meta/map.json index 546d796abd..5245a3fb7c 100644 --- a/skills/vchart-development-assistant/references/type-meta/map.json +++ b/skills/vchart-development-assistant/references/type-meta/map.json @@ -1,992 +1,932 @@ { "typeName": "IMapChartSpec", - "description": "IMapChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IMapChartSpec": { - "description": "IMapChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec<\"fadeIn\"> | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'map'", - "originalType": "'map'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IMapSeriesSpec[]", - "originalType": "IMapSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMapSeriesSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IMapSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'map'", - "originalType": "'map'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "map", - "description": "地图数据源", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nameField", - "description": "名称维度", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "valueField 配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nameProperty", - "description": "名称映射字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centroidProperty", - "description": "中心坐标映射字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nameMap", - "description": "名称映射表", - "type": "{\n [key: string]: string;\n }", - "originalType": "{\n [key: string]: string;\n }", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "area", - "description": "图元配置", - "type": "IMarkSpec>", - "originalType": "IMarkSpec>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "defaultFillColor", - "description": "默认填充颜色", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "showDefaultName", - "description": "是否显示数据中没有的地区名称", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "label", - "description": "标签配置", - "type": "Omit", - "originalType": "Omit", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "area", + "description": "图元配置", + "type": "IMarkSpec> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "centroidProperty", + "description": "中心坐标映射字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "undefined", + "since": "1.5.1" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "defaultFillColor", + "description": "默认填充颜色", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "Omit | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "map", + "description": "地图数据源", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 37 个属性（已展开所有继承）", - "expandedFrom": "IMapSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nameField", + "description": "名称维度", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nameMap", + "description": "名称映射表", + "type": "{\n [key: string]: string;\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "nameProperty", + "description": "名称映射字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'name'" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IMapSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMapSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "showDefaultName", + "description": "是否显示数据中没有的地区名称", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.3" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"map\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "map" + ] + }, + { + "name": "valueField", + "description": "值维度", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:44:04.711Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/map/interface.d.ts", + ], "complexTypeDefinitions": { - "IMapSeriesSpec": { - "typeName": "IMapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/map/interface.d.ts", - "note": "类型 IMapSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMapSeriesSpec": { + "typeName": "IMapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f28afaaaf021" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPathMarkSpec": { + "typeName": "IPathMarkSpec", + "reference": "type-details/IPathMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IPathMarkSpec": { - "typeName": "IPathMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IPathMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ILabelSpec": { - "typeName": "ILabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ILabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 69, - "complexTypes": 31, - "typeFileLocations": 31, - "dependencyTypes": 850 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/mosaic.json b/skills/vchart-development-assistant/references/type-meta/mosaic.json index e01cbe467b..2b54a2c975 100644 --- a/skills/vchart-development-assistant/references/type-meta/mosaic.json +++ b/skills/vchart-development-assistant/references/type-meta/mosaic.json @@ -1,666 +1,1320 @@ { "typeName": "IMosaicChartSpec", - "description": "IMosaicChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IMosaicChartSpec": { - "description": "IMosaicChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "图表类型配置", - "type": "'mosaic'", - "originalType": "'mosaic'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IMosaicSeriesSpec[]", - "originalType": "IMosaicSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMosaicSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bandWidthField", + "description": "柱子尺寸映射字段，如果不声明默认会根据相同维度下的总值占比进行映射\n- 条形图方向时自动映射高度\n- 竖形图方向时自动映射宽度", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.13.10" + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IMosaicSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "系列类型", - "type": "'mosaic'", - "originalType": "'mosaic'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec & {\n filterByGroup?: {\n field: string;\n type?: 'min' | 'max';\n filter?: (d: any) => boolean;\n };\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "originalType": "IMultiLabelSpec & {\n filterByGroup?: {\n field: string;\n type?: 'min' | 'max';\n filter?: (d: any) => boolean;\n };\n position?: Functional<'outside' | 'top' | 'bottom' | 'left' | 'right' | 'inside' | 'inside-top' | 'inside-bottom' | 'inside-right' | 'inside-left' | 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'>;\n }>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILabelSpec" - ] - }, - { - "name": "bandWidthField", - "description": "柱子尺寸映射字段，如果不声明默认会根据相同维度下的总值占比进行映射 - 条形图方向时自动映射高度 - 竖形图方向时自动映射宽度", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "label 配置", + "type": "IMultiLabelSpec & {\n filterByGroup?: {\n field: string;\n type?: \"max\" | \"min\" | undefined;\n filter?: ((d: any) => boolean) | undefined;\n } | undefined;\n position?: Functional<\"bottom-left\" | \"bottom-right\" | \"bottom\" | \"inside-bottom\" | \"inside-left\" | \"inside-right\" | \"inside-top\" | \"inside\" | \"left\" | \"outside\" | \"right\" | \"top-left\" | \"top-right\" | \"top\"> | undefined;\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "Functional", + "ILabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IMosaicSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMosaicSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 3 个属性（已展开所有继承）", - "expandedFrom": "IMosaicSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型配置", + "type": "\"mosaic\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "mosaic" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:48:55.519Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/mosaic/interface.d.ts", + ], "complexTypeDefinitions": { - "IMosaicSeriesSpec": { - "typeName": "IMosaicSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/mosaic/interface.d.ts", - "note": "类型 IMosaicSeriesSpec 的定义位置" + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "Functional": { + "typeName": "Functional", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2535a2dd9530", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMosaicSeriesSpec": { + "typeName": "IMosaicSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1b11da6c8615" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 41, - "complexTypes": 28, - "typeFileLocations": 28, - "dependencyTypes": 861 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/pictogram.json b/skills/vchart-development-assistant/references/type-meta/pictogram.json index 50f0dd59e1..e2491ec1f0 100644 --- a/skills/vchart-development-assistant/references/type-meta/pictogram.json +++ b/skills/vchart-development-assistant/references/type-meta/pictogram.json @@ -1,522 +1,510 @@ { "typeName": "IPictogramChartSpec", - "description": "IPictogramChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IPictogramChartSpec": { - "description": "IPictogramChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'pictogram'", - "originalType": "'pictogram'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IPictogramSeriesSpec[]", - "originalType": "IPictogramSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPictogramSeriesSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" ] }, - "IChartExtendsSeriesSpec": { - "description": "any 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [], - "note": "展开自 Omit - 基础类型待分析" + { + "name": "series", + "description": "系列", + "type": "IPictogramSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPictogramSeriesSpec" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"pictogram\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "pictogram" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:44:58.160Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/pictogram/interface.d.ts", + ], "complexTypeDefinitions": { - "IPictogramSeriesSpec": { - "typeName": "IPictogramSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/pictogram/interface.d.ts", - "note": "类型 IPictogramSeriesSpec 的定义位置" + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPictogramSeriesSpec": { + "typeName": "IPictogramSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f780ecfd754f" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" } }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 32, - "complexTypes": 23, - "typeFileLocations": 23, - "dependencyTypes": 850 - } -} \ No newline at end of file + "registration": [ + "registerPictogramChart" + ], + "registrationNote": "由宿主注册扩展图型，注册代码不属于 spec。", + "openContract": "IChartExtendsSeriesSpec 保留公开开放契约；系列字段见 IPictogramSeriesSpec，根字段转发见 pictogram-transformer.ts。" +} diff --git a/skills/vchart-development-assistant/references/type-meta/pie.json b/skills/vchart-development-assistant/references/type-meta/pie.json index 6b0b65f6f9..f4f3f06a95 100644 --- a/skills/vchart-development-assistant/references/type-meta/pie.json +++ b/skills/vchart-development-assistant/references/type-meta/pie.json @@ -1,1133 +1,1090 @@ { "typeName": "IPieChartSpec", - "description": "IPieChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IPieChartSpec": { - "description": "IPieChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "PieAppearPreset", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'pie'", - "originalType": "'pie'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "indicator", - "description": "饼图指标卡", - "type": "IIndicatorSpec | IIndicatorSpec[]", - "originalType": "IIndicatorSpec | IIndicatorSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IIndicatorSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerOffset", + "description": "饼图扇区中心偏移", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerX", + "description": "饼图中心点 x 坐标", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "饼图中心点 y 坐标", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "cornerRadius", + "description": "饼图扇区圆角半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "emptyPlaceholder", + "description": "数据为空时显示的占位图形", + "type": "{\n showEmptyCircle?: boolean | undefined;\n emptyCircle?: IMarkSpec | undefined;\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "endAngle", + "description": "饼图的结束角度（0 ~ 360）", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "270" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" ] }, - "IChartExtendsSeriesSpec": { - "description": "IPieSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'pie'", - "originalType": "'pie'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "centerX", - "description": "饼图中心点 x 坐标", - "type": "number | IPercent", - "originalType": "number | IPercent", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPercent" - ] - }, - { - "name": "centerY", - "description": "饼图中心点 y 坐标", - "type": "number | IPercent", - "originalType": "number | IPercent", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPercent" - ] - }, - { - "name": "outerRadius", - "description": "饼图扇区外半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "innerRadius", - "description": "饼图扇区内半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "startAngle", - "description": "饼图的起始角度（0 ~ 360）", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "endAngle", - "description": "饼图的结束角度（0 ~ 360）", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "数值字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "radiusField", - "description": "radiusField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "angleField", - "description": "angleField 配置", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "radius", - "description": "饼图扇区半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IPolarSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growAngle' | 'growRadius' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "centerOffset", - "description": "饼图扇区中心偏移", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "cornerRadius", - "description": "饼图扇区圆角半径", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padAngle", - "description": "扇区之间的间隔角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minAngle", - "description": "最小的扇区角度（0 ~ 360），用于防止某个值过小导致扇区太小影响交互。", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "layoutRadius", - "description": "layoutRadius 配置", - "type": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "originalType": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "pie", - "description": "pie 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "IArcLabelSpec" - ] - }, - { - "name": "emptyPlaceholder", - "description": "数据为空时显示的占位图形", - "type": "{\n showEmptyCircle?: boolean;\n emptyCircle?: IMarkSpec;\n }", - "originalType": "{\n showEmptyCircle?: boolean;\n emptyCircle?: IMarkSpec;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "showAllZero", - "description": "是否在数据均为0时显示均分扇区。", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "supportNegative", - "description": "是否将负数按照绝对值进行处理。", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "indicator", + "description": "饼图指标卡", + "type": "IIndicatorSpec | IIndicatorSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IIndicatorSpec" + ] + }, + { + "name": "innerRadius", + "description": "饼图扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutRadius", + "description": "layoutRadius 配置", + "type": "\"auto\" | ((layoutRect: ILayoutRect, center: IPointLike) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutRect", + "IPointLike" ], - "note": "展开自 Omit - 包含 49 个属性（已展开所有继承）", - "expandedFrom": "IPieSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.11.12", + "literalValues": [ + "auto" ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "minAngle", + "description": "最小的扇区角度（0 ~ 360），用于防止某个值过小导致扇区太小影响交互。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0", + "since": "1.4.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "饼图扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padAngle", + "description": "扇区之间的间隔角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "pie", + "description": "扇区样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "radius", + "description": "饼图扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "showAllZero", + "description": "是否在数据均为0时显示均分扇区。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "饼图的起始角度（0 ~ 360）", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "-90" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "supportNegative", + "description": "是否将负数按照绝对值进行处理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"pie\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "pie" + ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:50:49.073Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/pie/interface.d.ts", + ], "complexTypeDefinitions": { - "IIndicatorSpec": { - "typeName": "IIndicatorSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/indicator/interface.d.ts", - "note": "类型 IIndicatorSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcLabelSpec": { + "typeName": "IArcLabelSpec", + "reference": "type-details/IArcLabelSpec-Type-Definition.md" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IIndicatorSpec": { + "typeName": "IIndicatorSpec", + "reference": "type-details/IIndicatorSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutRect": { + "typeName": "ILayoutRect", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4324e55ab6b" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPointLike": { + "typeName": "IPointLike", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e25b463f6cfe", + "package": "@visactor/vutils", + "version": "1.0.28" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IPercent": { - "typeName": "IPercent", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 IPercent 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "PieAppearPreset": { + "typeName": "PieAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c560860d2a3d" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "PieMarks": { + "typeName": "PieMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b04753817bef" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" - }, - "IMultiLabelSpec": { - "typeName": "IMultiLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 IMultiLabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IArcLabelSpec": { - "typeName": "IArcLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/pie/interface.d.ts", - "note": "类型 IArcLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 81, - "complexTypes": 33, - "typeFileLocations": 33, - "dependencyTypes": 855 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/pie3d.json b/skills/vchart-development-assistant/references/type-meta/pie3d.json new file mode 100644 index 0000000000..9a80fb67fe --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/pie3d.json @@ -0,0 +1,1106 @@ +{ + "typeName": "IPie3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angle3d", + "description": "angle3d 配置", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "PieAppearPreset", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "PieMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerOffset", + "description": "饼图扇区中心偏移", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerX", + "description": "饼图中心点 x 坐标", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "饼图中心点 y 坐标", + "type": "`${number}%` | number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "cornerRadius", + "description": "饼图扇区圆角半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "emptyPlaceholder", + "description": "数据为空时显示的占位图形", + "type": "{\n showEmptyCircle?: boolean | undefined;\n emptyCircle?: IMarkSpec | undefined;\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "endAngle", + "description": "饼图的结束角度（0 ~ 360）", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "270" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "indicator", + "description": "饼图指标卡", + "type": "IIndicatorSpec | IIndicatorSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IIndicatorSpec" + ] + }, + { + "name": "innerRadius", + "description": "饼图扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutRadius", + "description": "layoutRadius 配置", + "type": "\"auto\" | ((layoutRect: ILayoutRect, center: IPointLike) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutRect", + "IPointLike" + ], + "since": "1.11.12", + "literalValues": [ + "auto" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "minAngle", + "description": "最小的扇区角度（0 ~ 360），用于防止某个值过小导致扇区太小影响交互。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0", + "since": "1.4.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "饼图扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padAngle", + "description": "扇区之间的间隔角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "pie", + "description": "扇区样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "radius", + "description": "饼图扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "showAllZero", + "description": "是否在数据均为0时显示均分扇区。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "饼图的起始角度（0 ~ 360）", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "-90" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "supportNegative", + "description": "是否将负数按照绝对值进行处理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"pie3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "pie3d" + ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcLabelSpec": { + "typeName": "IArcLabelSpec", + "reference": "type-details/IArcLabelSpec-Type-Definition.md" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IIndicatorSpec": { + "typeName": "IIndicatorSpec", + "reference": "type-details/IIndicatorSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutRect": { + "typeName": "ILayoutRect", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4324e55ab6b" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPointLike": { + "typeName": "IPointLike", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e25b463f6cfe", + "package": "@visactor/vutils", + "version": "1.0.28" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "PieAppearPreset": { + "typeName": "PieAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c560860d2a3d" + }, + "PieMarks": { + "typeName": "PieMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b04753817bef" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + } + }, + "registration": [ + "registerPie3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] +} diff --git a/skills/vchart-development-assistant/references/type-meta/radar.json b/skills/vchart-development-assistant/references/type-meta/radar.json index 0aa928fa81..ebeed7e17a 100644 --- a/skills/vchart-development-assistant/references/type-meta/radar.json +++ b/skills/vchart-development-assistant/references/type-meta/radar.json @@ -1,801 +1,1145 @@ { "typeName": "IRadarChartSpec", - "description": "IRadarChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IRadarChartSpec": { - "description": "IRadarChartSpec 接口配置", - "directExtends": [ - "IPolarChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "RadarAppearPreset", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'radar'", - "originalType": "'radar'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IRadarSeriesSpec[]", - "originalType": "IRadarSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IRadarSeriesSpec" - ] - } - ] - }, - "IPolarChartSpec": { - "description": "IPolarChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "RadarMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "area", + "description": "面积图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IAreaMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "极坐标系下坐标轴配置，支持半径轴和角度轴。\n* `orient: 'angle'` 角度轴\n* `orient: 'radius'` 半径轴", + "type": "IPolarAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPolarAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "类别字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "centerX", + "description": "中心点 x 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "中心点 y 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "endAngle", + "description": "扇区结束角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "indicator", + "description": "指标卡配置", + "type": "IIndicatorSpec | IIndicatorSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IIndicatorSpec" + ] + }, + { + "name": "innerRadius", + "description": "扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineLikeLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutRadius", + "description": "layoutRadius 配置", + "type": "\"auto\" | ((layoutRect: ILayoutRect, center: IPointLike) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutRect", + "IPointLike" ], - "ownProperties": [ - { - "name": "axes", - "description": "极坐标系下坐标轴配置，支持半径轴和角度轴。 * `orient: 'angle'` 角度轴 * `orient: 'radius'` 半径轴", - "type": "IPolarAxisSpec[]", - "originalType": "IPolarAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "originalType": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarCrosshairSpec" - ] - }, - { - "name": "layoutRadius", - "description": "layoutRadius 配置", - "type": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "originalType": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "indicator", - "description": "指标卡配置", - "type": "IIndicatorSpec | IIndicatorSpec[]", - "originalType": "IIndicatorSpec | IIndicatorSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IIndicatorSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IRadarSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'grow' | 'fadeIn' | 'clipIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "pointDis", - "description": "标记点之间的距离，px", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "pointDisMul", - "description": "标记点之间的距离， pointSize 的倍数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "markOverlap", - "description": "是否允许标记图形相互覆盖", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IMarkOverlap" - }, - { - "name": "type", - "description": "type 配置", - "type": "'radar'", - "originalType": "'radar'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "point", - "description": "point 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "line", - "description": "line 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILineMarkSpec" - ] - }, - { - "name": "area", - "description": "area 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IAreaMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILineLikeLabelSpec" - ] - }, - { - "name": "seriesMark", - "description": "系列主 mark 类型配置，该配置会影响图例的展示", - "type": "'point' | 'line' | 'area'", - "originalType": "'point' | 'line' | 'area'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "activePoint", - "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.11.2", + "literalValues": [ + "auto" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "line", + "description": "线图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "markOverlap", + "description": "是否允许标记图形相互覆盖", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.6.0" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 14 个属性（已展开所有继承）", - "expandedFrom": "IRadarSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "point", + "description": "点图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "pointDis", + "description": "标记点之间的距离，px", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0" + }, + { + "name": "pointDisMul", + "description": "标记点之间的距离， pointSize 的倍数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "radius", + "description": "扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IRadarSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IRadarSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesMark", + "description": "系列主 mark 类型配置，该配置会影响图例的展示", + "type": "\"area\" | \"line\" | \"point\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'area'", + "since": "1.2.0", + "literalValues": [ + "area", + "line", + "point" ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "扇区起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"radar\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "radar" + ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:52:19.848Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/radar/interface.d.ts", + ], "complexTypeDefinitions": { - "IRadarSeriesSpec": { - "typeName": "IRadarSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/radar/interface.d.ts", - "note": "类型 IRadarSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" }, - "IPolarCrosshairSpec": { - "typeName": "IPolarCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 IPolarCrosshairSpec 的定义位置" + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" }, - "IIndicatorSpec": { - "typeName": "IIndicatorSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/indicator/interface.d.ts", - "note": "类型 IIndicatorSpec 的定义位置" + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IAreaMarkSpec": { + "typeName": "IAreaMarkSpec", + "reference": "type-details/IAreaMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IIndicatorSpec": { + "typeName": "IIndicatorSpec", + "reference": "type-details/IIndicatorSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutRect": { + "typeName": "ILayoutRect", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4324e55ab6b" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILineLikeLabelSpec": { + "typeName": "ILineLikeLabelSpec", + "reference": "type-details/ILineLikeLabelSpec-Type-Definition.md" + }, + "ILineMarkSpec": { + "typeName": "ILineMarkSpec", + "reference": "type-details/ILineMarkSpec-Type-Definition.md" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPointLike": { + "typeName": "IPointLike", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e25b463f6cfe", + "package": "@visactor/vutils", + "version": "1.0.28" + }, + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadarSeriesSpec": { + "typeName": "IRadarSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-702f2f2e90b8" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "ISymbolMarkSpec": { - "typeName": "ISymbolMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ISymbolMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "ILineMarkSpec": { - "typeName": "ILineMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ILineMarkSpec 的定义位置" + "RadarAppearPreset": { + "typeName": "RadarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3ec398b9ec94" }, - "IAreaMarkSpec": { - "typeName": "IAreaMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IAreaMarkSpec 的定义位置" + "RadarMarks": { + "typeName": "RadarMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-44fb5d824dc0" }, - "IMultiLabelSpec": { - "typeName": "IMultiLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 IMultiLabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ILineLikeLabelSpec": { - "typeName": "ILineLikeLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/mixin/interface.d.ts", - "note": "类型 ILineLikeLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 50, - "complexTypes": 33, - "typeFileLocations": 33, - "dependencyTypes": 864 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/rangeArea.json b/skills/vchart-development-assistant/references/type-meta/rangeArea.json index 1c8e985998..3fbfb1c1d3 100644 --- a/skills/vchart-development-assistant/references/type-meta/rangeArea.json +++ b/skills/vchart-development-assistant/references/type-meta/rangeArea.json @@ -1,663 +1,1334 @@ { "typeName": "IRangeAreaChartSpec", - "description": "IRangeAreaChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IRangeAreaChartSpec": { - "description": "IRangeAreaChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaAppearPreset", + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "图表类型配置", - "type": "'rangeArea'", - "originalType": "'rangeArea'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IRangeAreaSeriesSpec[]", - "originalType": "IRangeAreaSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IRangeAreaSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "AreaMarks", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "area", + "description": "面积图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IAreaMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "areaLabel", + "description": "面积图元标签配置", + "type": "(Omit & {\n position?: \"end\" | \"start\" | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ], + "since": "1.7.0" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec & {\n position: \"bottom-left\" | \"bottom-right\" | \"bottom\" | \"center\" | \"inside-middle\" | \"left\" | \"right\" | \"top-left\" | \"top-right\" | \"top\";\n}> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineLikeLabelSpec", + "IMultiLabelSpec" + ], + "since": "1.13.1 新增支持 inside-middle 标签位置" + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "line", + "description": "线图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markOverlap", + "description": "是否允许标记图形相互覆盖", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.6.0" + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "maxField", + "description": "maxField 配置", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IRangeAreaSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "系列类型", - "type": "'rangeArea'", - "originalType": "'rangeArea'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minField", - "description": "minField 配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxField", - "description": "maxField 配置", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.8.0" + }, + { + "name": "minField", + "description": "数据字段配置", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "point", + "description": "点图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "pointDis", + "description": "标记点之间的距离，px", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0" + }, + { + "name": "pointDisMul", + "description": "标记点之间的距离， pointSize 的倍数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IRangeAreaSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IRangeAreaSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesMark", + "description": "系列主 mark 类型配置，该配置会影响图例的展示", + "type": "\"area\" | \"line\" | \"point\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'area'", + "since": "1.2.0", + "literalValues": [ + "area", + "line", + "point" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 3 个属性（已展开所有继承）", - "expandedFrom": "IRangeAreaSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型配置", + "type": "\"rangeArea\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "rangeArea" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:46:47.031Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/range-area/interface.d.ts", + ], "complexTypeDefinitions": { - "IRangeAreaSeriesSpec": { - "typeName": "IRangeAreaSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/range-area/interface.d.ts", - "note": "类型 IRangeAreaSeriesSpec 的定义位置" + "AreaAppearPreset": { + "typeName": "AreaAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1632d0cf5560" + }, + "AreaMarks": { + "typeName": "AreaMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6b16760e15b0" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IAreaMarkSpec": { + "typeName": "IAreaMarkSpec", + "reference": "type-details/IAreaMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILineLikeLabelSpec": { + "typeName": "ILineLikeLabelSpec", + "reference": "type-details/ILineLikeLabelSpec-Type-Definition.md" + }, + "ILineMarkSpec": { + "typeName": "ILineMarkSpec", + "reference": "type-details/ILineMarkSpec-Type-Definition.md" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRangeAreaSeriesSpec": { + "typeName": "IRangeAreaSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-777c15c57cb1" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 41, - "complexTypes": 28, - "typeFileLocations": 28, - "dependencyTypes": 861 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/rangeColumn.json b/skills/vchart-development-assistant/references/type-meta/rangeColumn.json index 898f70cd93..ba2ebb1edd 100644 --- a/skills/vchart-development-assistant/references/type-meta/rangeColumn.json +++ b/skills/vchart-development-assistant/references/type-meta/rangeColumn.json @@ -1,753 +1,1336 @@ { "typeName": "IRangeColumnChartSpec", - "description": "IRangeColumnChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IRangeColumnChartSpec": { - "description": "IRangeColumnChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "RangeColumnAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "图表类型配置", - "type": "'rangeColumn'", - "originalType": "'rangeColumn'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IRangeColumnSeriesSpec[]", - "originalType": "IRangeColumnSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IRangeColumnSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IRangeColumnSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'fadeIn' | 'grow' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'rangeColumn'", - "originalType": "'rangeColumn'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minField", - "description": "minField 配置", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxField", - "description": "maxField 配置", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "bar", - "description": "bar 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "Partial & {\n position?: PositionEnum;\n [SeriesMarkNameEnum.minLabel]?: IMarkSpec & {\n visible?: boolean;\n position?: keyof typeof minMaxPositionEnum;\n offset?: number;\n formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>;\n };\n [SeriesMarkNameEnum.maxLabel]?: IMarkSpec & {\n visible?: boolean;\n position?: minMaxPositionEnum;\n offset?: number;\n formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>;\n };\n }", - "originalType": "Partial & {\n position?: PositionEnum;\n [SeriesMarkNameEnum.minLabel]?: IMarkSpec & {\n visible?: boolean;\n position?: keyof typeof minMaxPositionEnum;\n offset?: number;\n formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>;\n };\n [SeriesMarkNameEnum.maxLabel]?: IMarkSpec & {\n visible?: boolean;\n position?: minMaxPositionEnum;\n offset?: number;\n formatMethod?: IFormatMethod<[text: string | string[], datum?: any]>;\n };\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - } + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "(Partial & {\n position?: PositionEnum | undefined;\n minLabel?: ({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n } & IMarkProgressiveConfig & {\n visible?: boolean | undefined;\n position?: \"end\" | \"middle\" | \"start\" | undefined;\n offset?: number | undefined;\n formatMethod?: IFormatMethod<[\n text: string | string[],\n datum?: any\n ]> | undefined;\n }) | undefined;\n maxLabel?: ({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n } & IMarkProgressiveConfig & {\n visible?: boolean | undefined;\n position?: minMaxPositionEnum | undefined;\n offset?: number | undefined;\n formatMethod?: IFormatMethod<[\n text: string | string[],\n datum?: any\n ]> | undefined;\n }) | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFormatMethod", + "ILabelSpec", + "IMarkSpec", + "IPositionedTextMarkSpec", + "minMaxPositionEnum", + "PositionEnum" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "maxField", + "description": "maxField 配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 9 个属性（已展开所有继承）", - "expandedFrom": "IRangeColumnSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "minField", + "description": "数据字段配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IRangeColumnSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IRangeColumnSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型配置", + "type": "\"rangeColumn\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "rangeColumn" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:53:47.382Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/range-column/interface.d.ts", + ], "complexTypeDefinitions": { - "IRangeColumnSeriesSpec": { - "typeName": "IRangeColumnSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/range-column/interface.d.ts", - "note": "类型 IRangeColumnSeriesSpec 的定义位置" + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IFormatMethod": { + "typeName": "IFormatMethod", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6375b3333257" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IPositionedTextMarkSpec": { + "typeName": "IPositionedTextMarkSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-62ea327d0fc7" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRangeColumnSeriesSpec": { + "typeName": "IRangeColumnSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-71611a6326b0" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "minMaxPositionEnum": { + "typeName": "minMaxPositionEnum", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e105bd77edce" + }, + "PositionEnum": { + "typeName": "PositionEnum", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-febd1be01553" + }, + "RangeColumnAppearPreset": { + "typeName": "RangeColumnAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-df0bef8e8bc4" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 47, - "complexTypes": 31, - "typeFileLocations": 31, - "dependencyTypes": 861 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/rangeColumn3d.json b/skills/vchart-development-assistant/references/type-meta/rangeColumn3d.json new file mode 100644 index 0000000000..2af2d55739 --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/rangeColumn3d.json @@ -0,0 +1,1344 @@ +{ + "typeName": "IRangeColumn3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "RangeColumnAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" + ], + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "(Partial & {\n position?: PositionEnum | undefined;\n minLabel?: ({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n } & IMarkProgressiveConfig & {\n visible?: boolean | undefined;\n position?: \"end\" | \"middle\" | \"start\" | undefined;\n offset?: number | undefined;\n formatMethod?: IFormatMethod<[\n text: string | string[],\n datum?: any\n ]> | undefined;\n }) | undefined;\n maxLabel?: ({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n } & IMarkProgressiveConfig & {\n visible?: boolean | undefined;\n position?: minMaxPositionEnum | undefined;\n offset?: number | undefined;\n formatMethod?: IFormatMethod<[\n text: string | string[],\n datum?: any\n ]> | undefined;\n }) | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IFormatMethod", + "ILabelSpec", + "IMarkSpec", + "IPositionedTextMarkSpec", + "minMaxPositionEnum", + "PositionEnum" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "maxField", + "description": "maxField 配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "minField", + "description": "数据字段配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IRangeColumn3dSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IRangeColumn3dSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型配置", + "type": "\"rangeColumn3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "rangeColumn3d" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianAxisSpec": { + "typeName": "ICartesianAxisSpec", + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IFormatMethod": { + "typeName": "IFormatMethod", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6375b3333257" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IPositionedTextMarkSpec": { + "typeName": "IPositionedTextMarkSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-62ea327d0fc7" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRangeColumn3dSeriesSpec": { + "typeName": "IRangeColumn3dSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-de962586184b" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "minMaxPositionEnum": { + "typeName": "minMaxPositionEnum", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e105bd77edce" + }, + "PositionEnum": { + "typeName": "PositionEnum", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-febd1be01553" + }, + "RangeColumnAppearPreset": { + "typeName": "RangeColumnAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-df0bef8e8bc4" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + } + }, + "registration": [ + "registerRangeColumn3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] +} diff --git a/skills/vchart-development-assistant/references/type-meta/rose.json b/skills/vchart-development-assistant/references/type-meta/rose.json index 39a81bc628..9eac905977 100644 --- a/skills/vchart-development-assistant/references/type-meta/rose.json +++ b/skills/vchart-development-assistant/references/type-meta/rose.json @@ -1,732 +1,1019 @@ { "typeName": "IRoseChartSpec", - "description": "IRoseChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IRoseChartSpec": { - "description": "IRoseChartSpec 接口配置", - "directExtends": [ - "IPolarChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "angleField", + "description": "angleField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `categoryField`" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "RoseAppearPreset", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'rose'", - "originalType": "'rose'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IRoseSeriesSpec[]", - "originalType": "IRoseSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IRoseSeriesSpec" - ] - } - ] - }, - "IPolarChartSpec": { - "description": "IPolarChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "极坐标系下坐标轴配置，支持半径轴和角度轴。\n* `orient: 'angle'` 角度轴\n* `orient: 'radius'` 半径轴", + "type": "IPolarAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPolarAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string | string[]", + "required": true, + "isSimple": false, + "dependencies": [] + }, + { + "name": "centerX", + "description": "中心点 x 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "centerY", + "description": "中心点 y 坐标", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.2 支持百分比字符串" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "endAngle", + "description": "扇区结束角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "indicator", + "description": "指标卡配置", + "type": "IIndicatorSpec | IIndicatorSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IIndicatorSpec" + ] + }, + { + "name": "innerRadius", + "description": "扇区内半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "layoutRadius", + "description": "layoutRadius 配置", + "type": "\"auto\" | ((layoutRect: ILayoutRect, center: IPointLike) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutRect", + "IPointLike" ], - "ownProperties": [ - { - "name": "axes", - "description": "极坐标系下坐标轴配置，支持半径轴和角度轴。 * `orient: 'angle'` 角度轴 * `orient: 'radius'` 半径轴", - "type": "IPolarAxisSpec[]", - "originalType": "IPolarAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "originalType": "IPolarCrosshairSpec | IPolarCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPolarCrosshairSpec" - ] - }, - { - "name": "layoutRadius", - "description": "layoutRadius 配置", - "type": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "originalType": "'auto' | number | ((layoutRect: ILayoutRect, center: IPointLike) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "indicator", - "description": "指标卡配置", - "type": "IIndicatorSpec | IIndicatorSpec[]", - "originalType": "IIndicatorSpec | IIndicatorSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IIndicatorSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IRoseSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growAngle' | 'growRadius' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'rose'", - "originalType": "'rose'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "数值字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "rose", - "description": "rose 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "IArcLabelSpec" - ] - } + "since": "1.11.2", + "literalValues": [ + "auto" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 9 个属性（已展开所有继承）", - "expandedFrom": "IRoseSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "outerRadius", + "description": "扇区外半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "radius", + "description": "扇区半径", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0.6", + "deprecated": "use outerRadius instead" + }, + { + "name": "radiusField", + "description": "radiusField 配置", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "deprecated": "请使用 `valueField`" + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "rose", + "description": "扇区样式", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IRoseSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IRoseSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "扇区起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"rose\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "rose" + ] + }, + { + "name": "valueField", + "description": "数值字段", + "type": "string | string[]", + "required": true, + "isSimple": false, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:47:40.170Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/rose/interface.d.ts", + ], "complexTypeDefinitions": { - "IRoseSeriesSpec": { - "typeName": "IRoseSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/rose/interface.d.ts", - "note": "类型 IRoseSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" }, - "IPolarAxisSpec": { - "typeName": "IPolarAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/polar/interface/spec.d.ts", - "note": "类型 IPolarAxisSpec 的定义位置" + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" }, - "IPolarCrosshairSpec": { - "typeName": "IPolarCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 IPolarCrosshairSpec 的定义位置" + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" }, - "IIndicatorSpec": { - "typeName": "IIndicatorSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/indicator/interface.d.ts", - "note": "类型 IIndicatorSpec 的定义位置" + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcLabelSpec": { + "typeName": "IArcLabelSpec", + "reference": "type-details/IArcLabelSpec-Type-Definition.md" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IIndicatorSpec": { + "typeName": "IIndicatorSpec", + "reference": "type-details/IIndicatorSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutRect": { + "typeName": "ILayoutRect", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4324e55ab6b" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPointLike": { + "typeName": "IPointLike", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e25b463f6cfe", + "package": "@visactor/vutils", + "version": "1.0.28" + }, + "IPolarAxisSpec": { + "typeName": "IPolarAxisSpec", + "reference": "type-details/IPolarAxisSpec-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRoseSeriesSpec": { + "typeName": "IRoseSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-50a9d844112a" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IMultiLabelSpec": { - "typeName": "IMultiLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 IMultiLabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IArcLabelSpec": { - "typeName": "IArcLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/pie/interface.d.ts", - "note": "类型 IArcLabelSpec 的定义位置" + "RoseAppearPreset": { + "typeName": "RoseAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c671df1145cb" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 45, - "complexTypes": 31, - "typeFileLocations": 31, - "dependencyTypes": 862 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/sankey.json b/skills/vchart-development-assistant/references/type-meta/sankey.json index 14d5528664..5a4d69d5b2 100644 --- a/skills/vchart-development-assistant/references/type-meta/sankey.json +++ b/skills/vchart-development-assistant/references/type-meta/sankey.json @@ -1,923 +1,1156 @@ { "typeName": "ISankeyChartSpec", - "description": "ISankeyChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ISankeyChartSpec": { - "description": "ISankeyChartSpec 接口配置", - "directExtends": [ - "Omit", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "SankeyAppearPreset", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'sankey'", - "originalType": "'sankey'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISankeySeriesSpec[]", - "originalType": "ISankeySeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISankeySeriesSpec" - ] - } - ] - }, - "Omit": { - "description": "IChartSpec 的属性（排除 padding）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SankeyMark", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "节点名称字段配置", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "crossNodeAlign", + "description": "横向布局的桑基图，设置节点Y坐标的对齐方式：\n'start' - '顶部对齐'\n'end' - '底部对齐'\n'middle' - '居中对齐'\n\n纵向布局的桑基图，设置节点X坐标的对齐方式：\n'start' - '左对齐'\n'end' - '右对齐'\n'middle' - '居中对齐'\n'parent' - '父节点'，从1.12.14版本开始支持", + "type": "\"end\" | \"middle\" | \"parent\" | \"start\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.12.4", + "literalValues": [ + "end", + "middle", + "parent", + "start" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表布局方向", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "dropIsolatedNode", + "description": "是否丢弃孤立的节点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.0" + }, + { + "name": "emphasis", + "description": "联动交互配置", + "type": "{\n enable: boolean;\n trigger?: \"click\" | \"hover\" | undefined;\n effect: \"adjacency\" | \"related\" | \"self\";\n} | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "equalNodeHeight", + "description": "each node has same height", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.0" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "inverse", + "description": "是否反向", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.12.2" + }, + { + "name": "iterations", + "description": "布局的迭代次数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "label", + "description": "标签配置", + "type": "ISankeyLabelSpec | ISankeyLabelSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISankeyLabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "link", + "description": "边配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILinkPathMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "linkHeight", + "description": "set the height of link", + "type": "((link: SankeyLinkElement, sourceNode: SankeyNodeElement, sourceNodeHeight: number) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyLinkElement", + "SankeyNodeElement" + ], + "since": "1.11.0" + }, + { + "name": "linkOverlap", + "description": "the layout type of link", + "type": "\"center\" | \"end\" | \"start\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.11.0", + "literalValues": [ + "center", + "end", + "start" + ] + }, + { + "name": "linkSortBy", + "description": "按此funtion排序link", + "type": "((a: SankeyLinkElement, b: SankeyLinkElement) => number) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyLinkElement" + ] + }, + { + "name": "linkWidth", + "description": "link宽度，单位px", + "type": "((link: SankeyLinkElement) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyLinkElement" + ] + }, + { + "name": "maxLinkHeight", + "description": "数据不为零或空时边的最大大小\n- 当同时指定 `maxNodeHeight` 和 `maxLinkHeight` 两个选项时，此选项应小于 `maxNodeHeight`", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.12.14" + }, + { + "name": "maxNodeHeight", + "description": "数据不为零或空时节点的最大大小", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.12.14" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 29 个属性（已展开所有继承）", - "expandedFrom": "IChartSpec", - "omittedKeys": [ - "padding" - ] - }, - "IChartExtendsSeriesSpec": { - "description": "ISankeySeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'sankey'", - "originalType": "'sankey'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "节点名称字段配置", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "节点之间关系的权重字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "sourceField", - "description": "来源节点数据字段 层级数据不提供", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "targetField", - "description": "目标节点数据字段 层级数据不提供", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "direction", - "description": "direction 配置", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nodeAlign", - "description": "节点的对齐类型，所有深度相同的节点，采用什么对齐方式，决定了节点在第几层： - 横向布局的桑基图，用于计算节点x坐标 - 纵向布局的桑基图，用于计算节点y坐标", - "type": "'left' | 'right' | 'center' | 'justify' | 'start' | 'end'", - "originalType": "'left' | 'right' | 'center' | 'justify' | 'start' | 'end'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "crossNodeAlign", - "description": "横向布局的桑基图，设置节点Y坐标的对齐方式： 'start' - '顶部对齐' 'end' - '底部对齐' 'middle' - '居中对齐' 纵向布局的桑基图，设置节点X坐标的对齐方式： 'start' - '左对齐' 'end' - '右对齐' 'middle' - '居中对齐' 'parent' - '父节点'，从1.12.14版本开始支持", - "type": "'start' | 'end' | 'middle' | 'parent'", - "originalType": "'start' | 'end' | 'middle' | 'parent'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "inverse", - "description": "是否反向", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nodeGap", - "description": "同一层中两个节点之间的间隙大小", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nodeWidth", - "description": "nodeWidth 配置", - "type": "string | number | ((node: SankeyNodeElement) => number)", - "originalType": "string | number | ((node: SankeyNodeElement) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "linkWidth", - "description": "link宽度，单位px", - "type": "number | ((link: SankeyLinkElement) => number)", - "originalType": "number | ((link: SankeyLinkElement) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "minStepWidth", - "description": "link + node 的最小宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minNodeHeight", - "description": "数据不为零或空时节点的最小大小 - 这个配置可以用来避免数据太小时看不到太细的节点 - 建议小于5px", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "minLinkHeight", - "description": "数据不为零或空时边的最小大小 - 这个配置可以用来避免数据太小的时候看不到太细的链接 - 建议小于5px - 当同时指定 `minNodeHeight` 和 `minLinkHeight` 两个选项时，此选项应小于 `minNodeHeight`", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxNodeHeight", - "description": "数据不为零或空时节点的最大大小", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "maxLinkHeight", - "description": "数据不为零或空时边的最大大小 - 当同时指定 `maxNodeHeight` 和 `maxLinkHeight` 两个选项时，此选项应小于 `maxNodeHeight`", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "iterations", - "description": "布局的迭代次数", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nodeKey", - "description": "解析node的key，defaultValue", - "type": "string | number | ((datum: SankeyNodeDatum) => string | number)", - "originalType": "string | number | ((datum: SankeyNodeDatum) => string | number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "linkSortBy", - "description": "按此funtion排序link", - "type": "(a: SankeyLinkElement, b: SankeyLinkElement) => number", - "originalType": "(a: SankeyLinkElement, b: SankeyLinkElement) => number", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "nodeSortBy", - "description": "按此funtion排序node", - "type": "(a: SankeyNodeElement, b: SankeyNodeElement) => number", - "originalType": "(a: SankeyNodeElement, b: SankeyNodeElement) => number", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "setNodeLayer", - "description": "自定义指定节点层", - "type": "(datum: SankeyNodeDatum) => number", - "originalType": "(datum: SankeyNodeDatum) => number", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "dropIsolatedNode", - "description": "是否丢弃孤立的节点", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nodeHeight", - "description": "set the height of node", - "type": "number | ((node: SankeyNodeElement) => number)", - "originalType": "number | ((node: SankeyNodeElement) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "linkHeight", - "description": "set the height of link", - "type": "number | ((link: SankeyLinkElement, sourceNode: SankeyNodeElement, sourceNodeHeight: number) => number)", - "originalType": "number | ((link: SankeyLinkElement, sourceNode: SankeyNodeElement, sourceNodeHeight: number) => number)", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - }, - { - "name": "equalNodeHeight", - "description": "each node has same height", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "linkOverlap", - "description": "the layout type of link", - "type": "'start' | 'center' | 'end'", - "originalType": "'start' | 'center' | 'end'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "node", - "description": "node 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "link", - "description": "link 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ILinkPathMarkSpec" - ] - }, - { - "name": "emphasis", - "description": "联动交互配置", - "type": "{\n enable: boolean;\n trigger?: 'click' | 'hover';\n effect: 'self' | 'adjacency' | 'related';\n }", - "originalType": "{\n enable: boolean;\n trigger?: 'click' | 'hover';\n effect: 'self' | 'adjacency' | 'related';\n }", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "label", - "description": "label 配置", - "type": "ISankeyLabelSpec | ISankeyLabelSpec[]", - "originalType": "ISankeyLabelSpec | ISankeyLabelSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISankeyLabelSpec" - ] - }, - { - "name": "overflow", - "description": "当制定了节点、边的宽度的时候，可以配置这个属性 当宽度大于图表region的宽度、高度大于图表resion高度的时候是否自动产生滚动条", - "type": "'scroll' | 'hidden' | 'scroll-x' | 'scroll-y'", - "originalType": "'scroll' | 'hidden' | 'scroll-x' | 'scroll-y'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - } + "since": "1.8.0" + }, + { + "name": "minLinkHeight", + "description": "数据不为零或空时边的最小大小\n - 这个配置可以用来避免数据太小的时候看不到太细的链接\n - 建议小于5px\n - 当同时指定 `minNodeHeight` 和 `minLinkHeight` 两个选项时，此选项应小于 `minNodeHeight`", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "minNodeHeight", + "description": "数据不为零或空时节点的最小大小\n - 这个配置可以用来避免数据太小时看不到太细的节点\n - 建议小于5px", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "minStepWidth", + "description": "link + node 的最小宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "node", + "description": "节点配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "nodeAlign", + "description": "节点的对齐类型，所有深度相同的节点，采用什么对齐方式，决定了节点在第几层：\n- 横向布局的桑基图，用于计算节点x坐标\n- 纵向布局的桑基图，用于计算节点y坐标", + "type": "\"center\" | \"end\" | \"justify\" | \"left\" | \"right\" | \"start\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "center", + "end", + "justify", + "left", + "right", + "start" + ] + }, + { + "name": "nodeGap", + "description": "同一层中两个节点之间的间隙大小", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nodeHeight", + "description": "set the height of node", + "type": "((node: SankeyNodeElement) => number) | number | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyNodeElement" + ], + "since": "1.11.0" + }, + { + "name": "nodeKey", + "description": "解析node的key，defaultValue", + "type": "((datum: SankeyNodeDatum) => number | string) | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyNodeDatum" + ] + }, + { + "name": "nodeSortBy", + "description": "按此funtion排序node", + "type": "((a: SankeyNodeElement, b: SankeyNodeElement) => number) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyNodeElement" + ] + }, + { + "name": "nodeWidth", + "description": "每个节点的宽度，支持三种取值\n1. 百分比字符串，例如：{ nodeWidth: '12%' }\n2. 以'px'为单位的简单数字，eg: { nodeWidth: 20 }\n3. function，通过自定义计算指定nodeWidth", + "type": "((node: SankeyNodeElement) => number) | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyNodeElement" + ] + }, + { + "name": "overflow", + "description": "当制定了节点、边的宽度的时候，可以配置这个属性\n当宽度大于图表region的宽度、高度大于图表resion高度的时候是否自动产生滚动条", + "type": "\"hidden\" | \"scroll-x\" | \"scroll-y\" | \"scroll\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.13.0", + "literalValues": [ + "hidden", + "scroll", + "scroll-x", + "scroll-y" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISankeySeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISankeySeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "setNodeLayer", + "description": "自定义指定节点层", + "type": "((datum: SankeyNodeDatum) => number) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SankeyNodeDatum" + ] + }, + { + "name": "sourceField", + "description": "来源节点数据字段\n层级数据不提供", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "targetField", + "description": "目标节点数据字段\n层级数据不提供", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 36 个属性（已展开所有继承）", - "expandedFrom": "ISankeySeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"sankey\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "sankey" ] + }, + { + "name": "valueField", + "description": "节点之间关系的权重字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:48:34.213Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/sankey/interface.d.ts", + ], "complexTypeDefinitions": { - "ISankeySeriesSpec": { - "typeName": "ISankeySeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/sankey/interface.d.ts", - "note": "类型 ISankeySeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "IHoverSpec": { - "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILinkPathMarkSpec": { + "typeName": "ILinkPathMarkSpec", + "reference": "type-details/ILinkPathMarkSpec-Type-Definition.md" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "ISankeyLabelSpec": { + "typeName": "ISankeyLabelSpec", + "reference": "type-details/ISankeyLabelSpec-Type-Definition.md" + }, + "ISankeySeriesSpec": { + "typeName": "ISankeySeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-73ad288a6b3a" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "ILinkPathMarkSpec": { - "typeName": "ILinkPathMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ILinkPathMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ISankeyLabelSpec": { - "typeName": "ISankeyLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/sankey/interface.d.ts", - "note": "类型 ISankeyLabelSpec 的定义位置" + "SankeyAppearPreset": { + "typeName": "SankeyAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6997583ca0c0" + }, + "SankeyLinkElement": { + "typeName": "SankeyLinkElement", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e49f605dc3e0" + }, + "SankeyMark": { + "typeName": "SankeyMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2f12a706e2ad" + }, + "SankeyNodeDatum": { + "typeName": "SankeyNodeDatum", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0e7c9dea40ba" + }, + "SankeyNodeElement": { + "typeName": "SankeyNodeElement", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1474c7d432e5" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 67, - "complexTypes": 27, - "typeFileLocations": 27, - "dependencyTypes": 851 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/scatter.json b/skills/vchart-development-assistant/references/type-meta/scatter.json index 02b990e327..659fee9acf 100644 --- a/skills/vchart-development-assistant/references/type-meta/scatter.json +++ b/skills/vchart-development-assistant/references/type-meta/scatter.json @@ -1,1158 +1,1243 @@ { "typeName": "IScatterChartSpec", - "description": "IScatterChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IScatterChartSpec": { - "description": "IScatterChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "ScatterAppearPreset", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'scatter'", - "originalType": "'scatter'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IScatterSeriesSpec[]", - "originalType": "IScatterSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScatterSeriesSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "ScatterMarks", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" ] }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMultiLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILineLikeLabelSpec", + "IMultiLabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "point", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ISymbolMarkSpec" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IScatterSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScatterSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "shape", + "description": "形状配置，设置形状的可选值\n- 单一形状：如 'circle'，则所有点的形状都为 'circle'\n- 数组：如 ['circle', 'square']，则根据形状数据字段映射到该范围\n- 回调函数，自定义根据数据计算形状的逻辑\n- scale配置，自定义形状对应的scale", + "type": "FunctionType | IVisualSpecBase | string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "FunctionType", + "IVisualSpecBase", + "ShapeType" + ] + }, + { + "name": "shapeField", + "description": "设置形状对应的数据字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "size", + "description": "设置尺寸的可选值，支持多种格式：\n- 单一数值：如 10，则所有点的大小都为 10\n- 数组：如 [10, 30]，则根据尺寸数据字段映射到该范围\n- 回调函数，自定义根据数据计算尺寸的逻辑\n- scale配置，自定义尺寸对应的scale", + "type": "FunctionType | IVisualSpecBase | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "FunctionType", + "IVisualSpecBase" + ] + }, + { + "name": "sizeField", + "description": "尺寸 对应的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" ] }, - "IChartExtendsSeriesSpec": { - "description": "IScatterSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "type", - "description": "系列类型", - "type": "'scatter'", - "originalType": "'scatter'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "direction", - "description": "direction row means layout by rows，col means layout by columns", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "xField", - "description": "x轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "x2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "yField", - "description": "y轴字段", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "y2Field", - "description": "用于区间数据，声明区间末尾的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "zField", - "description": "z轴字段 用于3d散点图等", - "type": "string | string[]", - "originalType": "string | string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "sortDataByAxis", - "description": "是否将数据按照数轴排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ICartesianSeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'scaleIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "point", - "description": "point 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ISymbolMarkSpec" - ] - }, - { - "name": "sizeField", - "description": "尺寸 对应的数据字段。", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "size", - "description": "设置尺寸的可选值，支持多种格式： - 单一数值：如 10，则所有点的大小都为 10 - 数组：如 [10, 30]，则根据尺寸数据字段映射到该范围 - 回调函数，自定义根据数据计算尺寸的逻辑 - scale配置，自定义尺寸对应的scale", - "type": "number | number[] | FunctionType | IVisualSpecBase", - "originalType": "number | number[] | FunctionType | IVisualSpecBase", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "FunctionType", - "IVisualSpecBase" - ] - }, - { - "name": "shapeField", - "description": "设置形状对应的数据字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "shape", - "description": "形状配置，设置形状的可选值 - 单一形状：如 'circle'，则所有点的形状都为 'circle' - 数组：如 ['circle', 'square']，则根据形状数据字段映射到该范围 - 回调函数，自定义根据数据计算形状的逻辑 - scale配置，自定义形状对应的scale", - "type": "ShapeType | ShapeType[] | FunctionType | IVisualSpecBase", - "originalType": "ShapeType | ShapeType[] | FunctionType | IVisualSpecBase", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ShapeType", - "FunctionType", - "IVisualSpecBase" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMultiLabelSpec", - "originalType": "IMultiLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMultiLabelSpec", - "ILineLikeLabelSpec" - ] - } + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 40 个属性（已展开所有继承）", - "expandedFrom": "IScatterSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"scatter\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "scatter" ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:49:28.272Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/scatter/interface.d.ts", + ], "complexTypeDefinitions": { - "IScatterSeriesSpec": { - "typeName": "IScatterSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/scatter/interface.d.ts", - "note": "类型 IScatterSeriesSpec 的定义位置" + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "FunctionType": { + "typeName": "FunctionType", + "reference": "type-details/FunctionType-Type-Definition.md" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "ILineLikeLabelSpec": { + "typeName": "ILineLikeLabelSpec", + "reference": "type-details/ILineLikeLabelSpec-Type-Definition.md" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMultiLabelSpec": { + "typeName": "IMultiLabelSpec", + "reference": "type-details/IMultiLabelSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IScatterSeriesSpec": { + "typeName": "IScatterSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-08a7bd218e9e" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISymbolMarkSpec": { + "typeName": "ISymbolMarkSpec", + "reference": "type-details/ISymbolMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "IVisualSpecBase": { + "typeName": "IVisualSpecBase", + "reference": "type-details/IVisualSpecBase-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "ISymbolMarkSpec": { - "typeName": "ISymbolMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ISymbolMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "FunctionType": { - "typeName": "FunctionType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 FunctionType 的定义位置" + "ScatterAppearPreset": { + "typeName": "ScatterAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-76d1da4aa75e" }, - "IVisualSpecBase": { - "typeName": "IVisualSpecBase", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecBase 的定义位置" + "ScatterMarks": { + "typeName": "ScatterMarks", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd1929cd17c5" }, "ShapeType": { "typeName": "ShapeType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/shape.d.ts", - "note": "类型 ShapeType 的定义位置" + "reference": "type-details/ShapeType-Type-Definition.md" }, - "IMultiLabelSpec": { - "typeName": "IMultiLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 IMultiLabelSpec 的定义位置" - }, - "ILineLikeLabelSpec": { - "typeName": "ILineLikeLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/mixin/interface.d.ts", - "note": "类型 ILineLikeLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 78, - "complexTypes": 40, - "typeFileLocations": 40, - "dependencyTypes": 864 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/sequence.json b/skills/vchart-development-assistant/references/type-meta/sequence.json index b911242a4b..6b8373defd 100644 --- a/skills/vchart-development-assistant/references/type-meta/sequence.json +++ b/skills/vchart-development-assistant/references/type-meta/sequence.json @@ -1,597 +1,541 @@ { "typeName": "ISequenceChartSpec", - "description": "ISequenceChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ISequenceChartSpec": { - "description": "ISequenceChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "appendPadding", + "description": "可以为左边的title预留padding", + "type": "IPadding | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPadding" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "dataZooms", + "description": "缩略轴配置", + "type": "IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'sequence'", - "originalType": "'sequence'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "appendPadding", - "description": "可以为左边的title预留padding", - "type": "IPadding", - "originalType": "IPadding", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPadding" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "dataZooms", - "description": "缩略轴配置", - "type": "IDataZoomSpec[]", - "originalType": "IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBars", - "description": "滚动条配置", - "type": "IScrollBarSpec[]", - "originalType": "IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "layout", - "description": "layout 配置", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "region", - "description": "region 配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" ] }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + { + "name": "scrollBars", + "description": "滚动条配置", + "type": "IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesSpec" + ] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "type", + "description": "图表类型", + "type": "\"sequence\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "sequence" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:55:17.260Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/sequence/interface.d.ts", + ], "complexTypeDefinitions": { - "IPadding": { - "typeName": "IPadding", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/space.d.ts", - "note": "类型 IPadding 的定义位置" + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" }, - "ICartesianAxisSpec": { - "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" }, - "IScrollBarSpec": { - "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianAxisSpec": { + "typeName": "ICartesianAxisSpec", + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "ILayoutSpec": { - "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPadding": { + "typeName": "IPadding", + "reference": "type-details/IPadding-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" } }, - "statistics": { - "totalInterfaces": 2, - "totalProperties": 38, - "complexTypes": 25, - "typeFileLocations": 25, - "dependencyTypes": 858 - } -} \ No newline at end of file + "registration": [ + "registerSequenceChart" + ], + "registrationNote": "由宿主注册扩展图型，注册代码不属于 spec。" +} diff --git a/skills/vchart-development-assistant/references/type-meta/sunburst.json b/skills/vchart-development-assistant/references/type-meta/sunburst.json index a1edbbdfcf..00177f66cf 100644 --- a/skills/vchart-development-assistant/references/type-meta/sunburst.json +++ b/skills/vchart-development-assistant/references/type-meta/sunburst.json @@ -1,795 +1,1024 @@ { "typeName": "ISunburstChartSpec", - "description": "ISunburstChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ISunburstChartSpec": { - "description": "ISunburstChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "SunburstAppearPreset", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'sunburst'", - "originalType": "'sunburst'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISunburstSeriesSpec[]", - "originalType": "ISunburstSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISunburstSeriesSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "ISunburstSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growAngle' | 'growRadius' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'sunburst'", - "originalType": "'sunburst'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "分类字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "权重字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centerX", - "description": "旭日图中心点, x坐标.", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "centerY", - "description": "旭日图中心点, y坐标.", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "offsetX", - "description": "旭日图中心点, x坐标偏移量.", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "offsetY", - "description": "旭日图中心点, y坐标偏移量.", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "startAngle", - "description": "起始角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "endAngle", - "description": "终止角度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "innerRadius", - "description": "扇区半径", - "type": "number | number[]", - "originalType": "number | number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "outerRadius", - "description": "扇区外半径", - "type": "number | number[]", - "originalType": "number | number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "gap", - "description": "层级间隔", - "type": "number | number[]", - "originalType": "number | number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "labelLayout", - "description": "label布局相关参数", - "type": "SunburstLabelConfig | (SunburstLabelConfig | null)[]", - "originalType": "SunburstLabelConfig | (SunburstLabelConfig | null)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "SunburstLabelConfig" - ] - }, - { - "name": "labelAutoVisible", - "description": "自动隐藏密集标签", - "type": "{\n /**\n * 是否启用\n * @default false\n */\n enable?: boolean;\n\n /**\n * 周长阈值,扇区周长小于该值时, 则隐藏标签.\n * @default 10\n */\n circumference?: number;\n}", - "originalType": "LabelAutoVisibleType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "drill", - "description": "下钻配置", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "drillField", - "description": "钻取字段的field", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "label", - "description": "label 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ITextMarkSpec" - ] - }, - { - "name": "sunburst", - "description": "sunburst 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "SunburstMark", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "分类字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "centerX", + "description": "旭日图中心点, x坐标.", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "正中心" + }, + { + "name": "centerY", + "description": "旭日图中心点, y坐标.", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "正中心" + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "drill", + "description": "下钻配置", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "drillField", + "description": "钻取字段的field", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "DEFAULT_DATA_KEY" + }, + { + "name": "endAngle", + "description": "终止角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "startAngle + 360" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "gap", + "description": "层级间隔", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "innerRadius", + "description": "扇区半径", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "ITextMarkSpec" + ] + }, + { + "name": "labelAutoVisible", + "description": "自动隐藏密集标签", + "type": "LabelAutoVisibleType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "LabelAutoVisibleType" + ] + }, + { + "name": "labelLayout", + "description": "label布局相关参数", + "type": "(null | SunburstLabelConfig)[] | SunburstLabelConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "SunburstLabelConfig" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "offsetX", + "description": "旭日图中心点, x坐标偏移量.", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "offsetY", + "description": "旭日图中心点, y坐标偏移量.", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "outerRadius", + "description": "扇区外半径", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "1" + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "ISunburstSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISunburstSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "startAngle", + "description": "起始角度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "-90" + }, + { + "name": "sunburst", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 22 个属性（已展开所有继承）", - "expandedFrom": "ISunburstSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"sunburst\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "sunburst" ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:50:23.633Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/sunburst/interface.d.ts", + ], "complexTypeDefinitions": { - "ISunburstSeriesSpec": { - "typeName": "ISunburstSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/sunburst/interface.d.ts", - "note": "类型 ISunburstSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ISunburstSeriesSpec": { + "typeName": "ISunburstSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-42998a239bf0" + }, + "ITextMarkSpec": { + "typeName": "ITextMarkSpec", + "reference": "type-details/ITextMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "LabelAutoVisibleType": { + "typeName": "LabelAutoVisibleType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e60547cde037" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "SunburstAppearPreset": { + "typeName": "SunburstAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9821e1ad4f86" }, "SunburstLabelConfig": { "typeName": "SunburstLabelConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 SunburstLabelConfig 的定义位置" + "reference": "type-details/SunburstLabelConfig-Type-Definition.md", + "package": "@visactor/vlayouts", + "version": "1.0.28" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "SunburstMark": { + "typeName": "SunburstMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-97edc6635996" }, - "ITextMarkSpec": { - "typeName": "ITextMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 ITextMarkSpec 的定义位置" - }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 54, - "complexTypes": 28, - "typeFileLocations": 28, - "dependencyTypes": 850 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/treemap.json b/skills/vchart-development-assistant/references/type-meta/treemap.json index 803e188780..c6fccb6fed 100644 --- a/skills/vchart-development-assistant/references/type-meta/treemap.json +++ b/skills/vchart-development-assistant/references/type-meta/treemap.json @@ -1,818 +1,1037 @@ { "typeName": "ITreemapChartSpec", - "description": "ITreemapChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "ITreemapChartSpec": { - "description": "ITreemapChartSpec 接口配置", - "directExtends": [ - "Omit", - "Omit" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TreemapAppearPreset", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TreemapMark", + "TypeAnimationConfig" + ] + }, + { + "name": "aspectRatio", + "description": "矩形分割比例", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "(1 + Math.sqrt(5)) / 2" + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "文本字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IHierarchyData", + "required": true, + "isSimple": false, + "dependencies": [ + "IHierarchyData" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "drill", + "description": "下钻配置", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "drillField", + "description": "钻取字段的field", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "DEFAULT_DATA_KEY" + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "gapWidth", + "description": "节点间距", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "TreemapOptions" + ], + "defaultValue": "1" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "叶子节点标签样式配置，默认不显示", + "type": "Omit | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "leaf", + "description": "叶子节点样式配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maxDepth", + "description": "展示的最大层级", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'treemap'", - "originalType": "'treemap'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "ITreemapSeriesSpec[]", - "originalType": "ITreemapSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITreemapSeriesSpec" - ] - } - ] - }, - "Omit": { - "description": "IChartSpec 的属性（排除 data, series）", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } + "since": "1.8.0" + }, + { + "name": "minChildrenVisibleArea", + "description": "当区域面积（px * px）小于设定值后，节点的子节点将被隐藏", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "TreemapOptions" + ] + }, + { + "name": "minChildrenVisibleSize", + "description": "当区域宽或高（px）小于设定值后，节点的子节点将被隐藏", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "TreemapOptions" + ] + }, + { + "name": "minVisibleArea", + "description": "当区域面积（px * px）小于设定值后，节点将被隐藏", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "TreemapOptions" ], - "note": "展开自 Omit - 包含 28 个属性（已展开所有继承）", - "expandedFrom": "IChartSpec", - "omittedKeys": [ - "data", - "series" - ] - }, - "Omit": { - "description": "ITreemapSeriesSpec 的属性（排除 tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growIn' | 'fadeIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'treemap'", - "originalType": "'treemap'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "categoryField", - "description": "文本字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "权重字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IHierarchyData", - "originalType": "IHierarchyData", - "required": true, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHierarchyData" - ] - }, - { - "name": "aspectRatio", - "description": "矩形分割比例", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "splitType", - "description": "splitType 配置", - "type": "TreemapOptions['splitType']", - "originalType": "TreemapOptions['splitType']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['splitType']" - ] - }, - { - "name": "gapWidth", - "description": "节点间距", - "type": "TreemapOptions['gapWidth']", - "originalType": "TreemapOptions['gapWidth']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['gapWidth']" - ] - }, - { - "name": "nodePadding", - "description": "节点内边距", - "type": "TreemapOptions['padding']", - "originalType": "TreemapOptions['padding']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['padding']" - ] - }, - { - "name": "maxDepth", - "description": "展示的最大层级", - "type": "TreemapOptions['maxDepth']", - "originalType": "TreemapOptions['maxDepth']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['maxDepth']" - ] - }, - { - "name": "minVisibleArea", - "description": "当区域面积（px * px）小于设定值后，节点将被隐藏", - "type": "TreemapOptions['minVisibleArea']", - "originalType": "TreemapOptions['minVisibleArea']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['minVisibleArea']" - ] - }, - { - "name": "minChildrenVisibleArea", - "description": "当区域面积（px * px）小于设定值后，节点的子节点将被隐藏", - "type": "TreemapOptions['minChildrenVisibleArea']", - "originalType": "TreemapOptions['minChildrenVisibleArea']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['minChildrenVisibleArea']" - ] - }, - { - "name": "minChildrenVisibleSize", - "description": "当区域宽或高（px）小于设定值后，节点的子节点将被隐藏", - "type": "TreemapOptions['minChildrenVisibleSize']", - "originalType": "TreemapOptions['minChildrenVisibleSize']", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "TreemapOptions['minChildrenVisibleSize']" - ] - }, - { - "name": "roam", - "description": "是否开启拖拽和缩放", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "drill", - "description": "下钻配置", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "drillField", - "description": "钻取字段的field", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "leaf", - "description": "leaf 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "nonLeaf", - "description": "nonLeaf 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "Omit", - "originalType": "Omit", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "nonLeafLabel", - "description": "nonLeafLabel 配置", - "type": "Omit & {\n position?: TreemapOptions['labelPosition'];\n padding?: TreemapOptions['labelPadding'];\n }", - "originalType": "Omit & {\n position?: TreemapOptions['labelPosition'];\n padding?: TreemapOptions['labelPadding'];\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [] - } + "defaultValue": "10" + }, + { + "name": "morph", + "description": "morph 动画配置", + "type": "IMorphSeriesSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMorphSeriesSpec" + ] + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nodePadding", + "description": "节点内边距", + "type": "number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "TreemapOptions" ], - "note": "展开自 Omit - 包含 23 个属性（已展开所有继承）", - "expandedFrom": "ITreemapSeriesSpec", - "omittedKeys": [ - "tooltip" + "defaultValue": "[5]" + }, + { + "name": "nonLeaf", + "description": "非叶子节点样式配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "nonLeafLabel", + "description": "非叶子节点标签样式配置，默认不显示", + "type": "(Omit & {\n position?: TreemapOptions[\"labelPosition\"];\n padding?: TreemapOptions[\"labelPadding\"];\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec", + "TreemapOptions" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "roam", + "description": "是否开启拖拽和缩放", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "series 配置", + "type": "ITreemapSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITreemapSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "splitType", + "description": "矩形分割算法", + "type": "\"binary\" | \"dice\" | \"slice\" | \"sliceDice\" | \"squarify\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'binary'", + "literalValues": [ + "binary", + "dice", + "slice", + "sliceDice", + "squarify" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "stackValue", + "description": "堆叠时的分组值\nstackValue 相等的系列将在一起堆积。没有配置的系列将在一组", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"treemap\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "treemap" + ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:56:40.176Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/treemap/interface.d.ts", + ], "complexTypeDefinitions": { - "ITreemapSeriesSpec": { - "typeName": "ITreemapSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/treemap/interface.d.ts", - "note": "类型 ITreemapSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHierarchyData": { + "typeName": "IHierarchyData", + "reference": "type-details/IHierarchyData-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IMorphSeriesSpec": { + "typeName": "IMorphSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d1defc672c7e" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, - "IHierarchyData": { - "typeName": "IHierarchyData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IHierarchyData 的定义位置" - }, - "TreemapOptions['splitType']": { - "typeName": "TreemapOptions['splitType']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['splitType'] 的定义位置" - }, - "TreemapOptions['gapWidth']": { - "typeName": "TreemapOptions['gapWidth']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['gapWidth'] 的定义位置" - }, - "TreemapOptions['padding']": { - "typeName": "TreemapOptions['padding']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['padding'] 的定义位置" - }, - "TreemapOptions['maxDepth']": { - "typeName": "TreemapOptions['maxDepth']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['maxDepth'] 的定义位置" - }, - "TreemapOptions['minVisibleArea']": { - "typeName": "TreemapOptions['minVisibleArea']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['minVisibleArea'] 的定义位置" - }, - "TreemapOptions['minChildrenVisibleArea']": { - "typeName": "TreemapOptions['minChildrenVisibleArea']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['minChildrenVisibleArea'] 的定义位置" - }, - "TreemapOptions['minChildrenVisibleSize']": { - "typeName": "TreemapOptions['minChildrenVisibleSize']", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TreemapOptions['minChildrenVisibleSize'] 的定义位置" + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "ITreemapSeriesSpec": { + "typeName": "ITreemapSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6cdfbc0c0174" }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TreemapAppearPreset": { + "typeName": "TreemapAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-24b5502879db" + }, + "TreemapMark": { + "typeName": "TreemapMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a996892adf6f" + }, + "TreemapOptions": { + "typeName": "TreemapOptions", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5125620c5489", + "package": "@visactor/vlayouts", + "version": "1.0.28" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 53, - "complexTypes": 32, - "typeFileLocations": 32, - "dependencyTypes": 853 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/venn.json b/skills/vchart-development-assistant/references/type-meta/venn.json index a4b58cca39..3feb444675 100644 --- a/skills/vchart-development-assistant/references/type-meta/venn.json +++ b/skills/vchart-development-assistant/references/type-meta/venn.json @@ -1,962 +1,919 @@ { "typeName": "IVennChartSpec", - "description": "IVennChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IVennChartSpec": { - "description": "IVennChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig", + "VennAppearPreset", + "VennMark" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "VennMark" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "VennMark" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "VennMark" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "VennMark" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'venn'", - "originalType": "'venn'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IVennSeriesSpec[]", - "originalType": "IVennSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVennSeriesSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IVennSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互 也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'venn'", - "originalType": "'venn'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "id", - "description": "数据唯一标识", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式 'break'指在该数据点处断开 'link' 指忽略该点保持连续 'zero' 指该点默认数值为0 'ignore' 指不处理", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animation", - "description": "是否开启动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "ISeriesSpec" - }, - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "'growIn' | 'fadeIn' | 'scaleIn' | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "categoryField", - "description": "类别字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "valueField", - "description": "权重字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "circle", - "description": "circle 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IArcMarkSpec" - ] - }, - { - "name": "overlap", - "description": "overlap 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IPathMarkSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "Omit", - "originalType": "Omit", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - }, - { - "name": "overlapLabel", - "description": "overlapLabel 配置", - "type": "Omit", - "originalType": "Omit", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - } + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "VennMark" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "categoryField", + "description": "类别字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "circle", + "description": "圆形图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IArcMarkSpec", + "IMarkSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "圆形图元标签配置", + "type": "Omit | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "overlap", + "description": "重叠部分图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IPathMarkSpec" + ] + }, + { + "name": "overlapLabel", + "description": "重叠部分图元标签配置", + "type": "Omit | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IVennSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVennSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 33 个属性（已展开所有继承）", - "expandedFrom": "IVennSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"venn\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "venn" ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T07:51:16.635Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/venn/interface.d.ts", + ], "complexTypeDefinitions": { - "IVennSeriesSpec": { - "typeName": "IVennSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/venn/interface.d.ts", - "note": "类型 IVennSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IArcMarkSpec": { + "typeName": "IArcMarkSpec", + "reference": "type-details/IArcMarkSpec-Type-Definition.md" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPathMarkSpec": { + "typeName": "IPathMarkSpec", + "reference": "type-details/IPathMarkSpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" - }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" + "IVennSeriesSpec": { + "typeName": "IVennSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3b900b97c368" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "IArcMarkSpec": { - "typeName": "IArcMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IArcMarkSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" }, - "IPathMarkSpec": { - "typeName": "IPathMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IPathMarkSpec 的定义位置" + "VennAppearPreset": { + "typeName": "VennAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1a92a41b84da" }, - "ILabelSpec": { - "typeName": "ILabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ILabelSpec 的定义位置" + "VennMark": { + "typeName": "VennMark", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d1fec4347076" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 65, - "complexTypes": 32, - "typeFileLocations": 32, - "dependencyTypes": 850 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/waterfall.json b/skills/vchart-development-assistant/references/type-meta/waterfall.json index 49631fa2a2..15bfb075a8 100644 --- a/skills/vchart-development-assistant/references/type-meta/waterfall.json +++ b/skills/vchart-development-assistant/references/type-meta/waterfall.json @@ -1,798 +1,1374 @@ { "typeName": "IWaterfallChartSpec", - "description": "IWaterfallChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IWaterfallChartSpec": { - "description": "IWaterfallChartSpec 接口配置", - "directExtends": [ - "ICartesianChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "activePoint", + "description": "是否使用额外的 activePoint 显示交互点，可以在点隐藏时显示被交互的点", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "boolean | IStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BarAppearPreset", + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'waterfall'", - "originalType": "'waterfall'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "系列配置", - "type": "IWaterfallSeriesSpec[]", - "originalType": "IWaterfallSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IWaterfallSeriesSpec" - ] - } - ] - }, - "ICartesianChartSpec": { - "description": "ICartesianChartSpec 接口配置", - "directExtends": [ - "IChartSpec" + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "笛卡尔坐标系的坐标轴配置", + "type": "ICartesianAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "bar", + "description": "图元配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ] + }, + { + "name": "barBackground", + "description": "柱状背景图元", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & IBarBackgroundSpec) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBarBackgroundSpec", + "IMarkProgressiveConfig", + "IMarkSpec", + "IRectMarkSpec" ], - "ownProperties": [ - { - "name": "direction", - "description": "图表的方向配置。 - 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。 - 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", - "type": "'default' | 'reverse'", - "originalType": "DirectionType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "axes", - "description": "笛卡尔坐标系的坐标轴配置", - "type": "ICartesianAxisSpec[]", - "originalType": "ICartesianAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianAxisSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "originalType": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICartesianCrosshairSpec" - ] - }, - { - "name": "markLine", - "description": "参考线配置", - "type": "IMarkLineSpec | IMarkLineSpec[]", - "originalType": "IMarkLineSpec | IMarkLineSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkLineSpec" - ] - }, - { - "name": "markArea", - "description": "参考区域配置", - "type": "IMarkAreaSpec | IMarkAreaSpec[]", - "originalType": "IMarkAreaSpec | IMarkAreaSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkAreaSpec" - ] - }, - { - "name": "markPoint", - "description": "参考点配置", - "type": "IMarkPointSpec | IMarkPointSpec[]", - "originalType": "IMarkPointSpec | IMarkPointSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkPointSpec" - ] - } - ] - }, - "IChartSpec": { - "description": "IChartSpec 接口配置", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "data 配置", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "是否自适应容器大小", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "series 配置", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "自定义布局函数", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "axes 配置", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "默认主题（支持完整主题对象或者主题名称，主题名称需要提前在 `ThemeManager` 中注册）", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置 自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ] - } - ] - }, - "IChartExtendsSeriesSpec": { - "description": "IWaterfallSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "animationAppear", - "description": "入场动画配置", - "type": "BarAppearPreset | IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IAnimationSpec" - }, - { - "name": "type", - "description": "此类型下，默认在数据最后增加一条总计信息", - "type": "'waterfall'", - "originalType": "'waterfall'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "total", - "description": "总计配置", - "type": "IWaterfallTotalEnd | IWaterfallTotalField | IWaterfallTotalCustom", - "originalType": "IWaterfallTotalEnd | IWaterfallTotalField | IWaterfallTotalCustom", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IWaterfallTotalEnd", - "IWaterfallTotalField", - "IWaterfallTotalCustom" - ] - }, - { - "name": "leaderLine", - "description": "leaderLine 配置", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRuleMarkSpec" - ] - }, - { - "name": "stackLabel", - "description": "stackLabel 配置", - "type": "ILabelSpec & {\n position?: IWaterfallStackLabelPosition;\n offset?: number;\n valueType?: IWaterfallStackLabelValueType;\n }", - "originalType": "ILabelSpec & {\n position?: IWaterfallStackLabelPosition;\n offset?: number;\n valueType?: IWaterfallStackLabelValueType;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - }, - { - "name": "totalLabel", - "description": "totalLabel 配置", - "type": "ITotalLabelSpec & {\n position?: IWaterfallStackLabelPosition;\n offset?: number;\n valueType?: IWaterfallStackLabelValueType;\n }", - "originalType": "ITotalLabelSpec & {\n position?: IWaterfallStackLabelPosition;\n offset?: number;\n valueType?: IWaterfallStackLabelValueType;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ] - }, - { - "name": "label", - "description": "label 配置", - "type": "ILabelSpec & {\n visible: boolean;\n offset?: number;\n }", - "originalType": "ILabelSpec & {\n visible: boolean;\n offset?: number;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILabelSpec" - ] - } + "since": "1.6.0" + }, + { + "name": "barGap", + "description": "柱条间 gap 值 @since 1.13.11", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barGapInGroup", + "description": "分组柱图中各个分组内的柱子间距，可以设置绝对的像素值，也可以使用百分比（如 '10%'）。\n当存在多层分组时，可以使用数组来设置不同层级的间距，如 [10, '20%']，表示第一层分组的间距为 10px，第二层分组的间距为 '20%'。\n如果 barGapInGroup 的数组个数小于分组层数，则后面的分组间距使用最后一个值。\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "(number | string)[] | number | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "barMaxWidth", + "description": "柱体最大宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barMinHeight", + "description": "柱条最小高度，可用于防止某数据项的值过小的视觉调整。", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.4.0" + }, + { + "name": "barMinWidth", + "description": "柱体最小宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "barWidth", + "description": "柱体宽度，可以设置绝对的像素值，也可以使用百分比（如 '10%'）\n1. number 类型，表示像素值\n2. string 类型，百分比用法，如 '10%'，该值为对应最后一个分组字段对应的 scale 的 bandWidth 占比(因为柱子是等宽的，所以采用最后一层分组的 scale)", + "type": "number | string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "calculationMode", + "description": "瀑布图类型\n默认为 increase 增长瀑布图", + "type": "\"decrease\" | \"increase\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "2.0.6", + "literalValues": [ + "decrease", + "increase" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICartesianCrosshairSpec | ICartesianCrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "direction", + "description": "图表的方向配置。\n- 'vertical' 垂直布局，即常见的直角坐标系布局，x 轴位于底部，y 轴位于左侧。\n- 'horizontal' 水平布局，可理解为 x 轴和 y 轴位置互换。", + "type": "\"horizontal\" | \"vertical\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "horizontal", + "vertical" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "label", + "description": "标签配置", + "type": "(ILabelSpec & {\n visible: boolean;\n offset?: number | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec" + ] + }, + { + "name": "large", + "description": "是否开启大数据渲染模式，开启后会降低渲染的精度", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "largeThreshold", + "description": "开启大数据渲染优化的阀值，对应的是data的长度;推荐 largeThreshold < progressiveThreshold", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "leaderLine", + "description": "引导线配置", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRuleMarkSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "markArea", + "description": "参考区域配置", + "type": "IMarkAreaSpec | IMarkAreaSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkAreaAngleRadiusSpec", + "IMarkAreaAngleSpec", + "IMarkAreaCoordinateSpec", + "IMarkAreaRadiusSpec", + "IMarkAreaSpec", + "IMarkAreaTheme", + "IMarkAreaXSpec", + "IMarkAreaXYSpec", + "IMarkAreaYSpec", + "IMarkerPositionsSpec" + ] + }, + { + "name": "markLine", + "description": "参考线配置", + "type": "IMarkLineSpec | IMarkLineSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerPositionsSpec", + "IMarkLineAngleSpec", + "IMarkLineAngRadRad1Spec", + "IMarkLineAngRadSpec", + "IMarkLineCoordinateSpec", + "IMarkLineRadAngAng1Spec", + "IMarkLineRadiusSpec", + "IMarkLineSpec", + "IMarkLineTheme", + "IMarkLineXSpec", + "IMarkLineXYSpec", + "IMarkLineXYY1Spec", + "IMarkLineYSpec", + "IMarkLineYXX1Spec", + "MarkCommonLineAnimationType" + ] + }, + { + "name": "markPoint", + "description": "参考点配置", + "type": "IMarkPointSpec | IMarkPointSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "BaseMarkerAnimation", + "IComponentSpec", + "IMarkerSymbol", + "IMarkPointAngleRadiusSpec", + "IMarkPointCoordinateSpec", + "IMarkPointGeoNameSpec", + "IMarkPointPositionsSpec", + "IMarkPointSpec", + "IMarkPointTheme", + "IMarkPointXYSpec", + "MarkPointAnimationType" + ] + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "note": "展开自 Omit - 包含 10 个属性（已展开所有继承）", - "expandedFrom": "IWaterfallSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "progressiveStep", + "description": "分片长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "progressiveThreshold", + "description": "开启分片渲染的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "sampling", + "description": "数据采样 - 采样方法", + "type": "ISamplingMethod | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.6.0", + "literalValues": [ + "average", + "lttb", + "max", + "min", + "sum" + ] + }, + { + "name": "samplingFactor", + "description": "数据采样 - 采样系数", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "1", + "since": "1.6.0" + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列配置", + "type": "IWaterfallSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IWaterfallSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "sortDataByAxis", + "description": "是否将数据按照数轴排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.3.0" + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackCornerRadius", + "description": "堆叠柱整体的圆角 @since 1.10.0\n圆角支持回调配置 @since 1.12.4", + "type": "IStackCornerRadiusCallback | number | number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStackCornerRadiusCallback" ] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackLabel", + "description": "堆积值标签配置", + "type": "(ILabelSpec & {\n position?: IWaterfallStackLabelPosition | undefined;\n offset?: number | undefined;\n valueType?: IWaterfallStackLabelValueType | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec", + "IWaterfallStackLabelPosition", + "IWaterfallStackLabelValueType" + ] + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "total", + "description": "总计配置", + "type": "IWaterfallTotalCustom | IWaterfallTotalEnd | IWaterfallTotalField | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IWaterfallTotalCustom", + "IWaterfallTotalEnd", + "IWaterfallTotalField" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "(Pick & {\n position?: \"bottom\" | \"top\" | undefined;\n alwayCalculateTotal?: boolean | undefined;\n} & {\n position?: IWaterfallStackLabelPosition | undefined;\n offset?: number | undefined;\n valueType?: IWaterfallStackLabelValueType | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILabelSpec", + "ITotalLabelSpec", + "IWaterfallStackLabelPosition", + "IWaterfallStackLabelValueType" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"waterfall\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "waterfall" + ] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "x2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "xField", + "description": "x轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "y2Field", + "description": "用于区间数据，声明区间末尾的数据字段。", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "yField", + "description": "y轴字段", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zField", + "description": "z轴字段\n用于3d散点图等", + "type": "string | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T08:58:04.127Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/chart/waterfall/interface.d.ts", + ], "complexTypeDefinitions": { - "IWaterfallSeriesSpec": { - "typeName": "IWaterfallSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/waterfall/interface.d.ts", - "note": "类型 IWaterfallSeriesSpec 的定义位置" + "BarAppearPreset": { + "typeName": "BarAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2a04d7b5d5bc" + }, + "BaseMarkerAnimation": { + "typeName": "BaseMarkerAnimation", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c807eb5fd121", + "package": "@visactor/vrender-components", + "version": "1.1.12" + }, + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBarBackgroundSpec": { + "typeName": "IBarBackgroundSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-659e249e0870" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" }, "ICartesianAxisSpec": { "typeName": "ICartesianAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/cartesian/interface/spec.d.ts", - "note": "类型 ICartesianAxisSpec 的定义位置" + "reference": "type-details/ICartesianAxisSpec-Type-Definition.md" }, "ICartesianCrosshairSpec": { "typeName": "ICartesianCrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICartesianCrosshairSpec 的定义位置" + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" }, - "IMarkLineSpec": { - "typeName": "IMarkLineSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-line/interface/spec.d.ts", - "note": "类型 IMarkLineSpec 的定义位置" + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" }, - "IMarkAreaSpec": { - "typeName": "IMarkAreaSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-area/interface/spec.d.ts", - "note": "类型 IMarkAreaSpec 的定义位置" + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" }, - "IMarkPointSpec": { - "typeName": "IMarkPointSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/marker/mark-point/interface/spec.d.ts", - "note": "类型 IMarkPointSpec 的定义位置" + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IComponentSpec": { + "typeName": "IComponentSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d23c51c12154" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/layout.d.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/interface/common.d.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/interaction/interface/spec.d.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/region/interface.d.ts", - "note": "类型 RegionSpec 的定义位置" + "ILabelSpec": { + "typeName": "ILabelSpec", + "reference": "type-details/ILabelSpec-Type-Definition.md" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/title/interface/spec.d.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/layout/interface.d.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/legend/interface.d.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/crosshair/interface/spec.d.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/tooltip/interface/spec.d.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkAreaAngleRadiusSpec": { + "typeName": "IMarkAreaAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2457805e643" + }, + "IMarkAreaAngleSpec": { + "typeName": "IMarkAreaAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4eea11d6bf8d" + }, + "IMarkAreaCoordinateSpec": { + "typeName": "IMarkAreaCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-99ea0813e616" + }, + "IMarkAreaRadiusSpec": { + "typeName": "IMarkAreaRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d96016d9da72" + }, + "IMarkAreaSpec": { + "typeName": "IMarkAreaSpec", + "reference": "type-details/IMarkAreaSpec-Type-Definition.md" + }, + "IMarkAreaTheme": { + "typeName": "IMarkAreaTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7880c31abf52" + }, + "IMarkAreaXSpec": { + "typeName": "IMarkAreaXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-ed2c343ef812" + }, + "IMarkAreaXYSpec": { + "typeName": "IMarkAreaXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-23ed00b3b201" + }, + "IMarkAreaYSpec": { + "typeName": "IMarkAreaYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19f94791c9c6" + }, + "IMarkerPositionsSpec": { + "typeName": "IMarkerPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-53a3e8a64bc1" + }, + "IMarkerSymbol": { + "typeName": "IMarkerSymbol", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3acb04a4042d" + }, + "IMarkLineAngleSpec": { + "typeName": "IMarkLineAngleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-cbf79085c0de" + }, + "IMarkLineAngRadRad1Spec": { + "typeName": "IMarkLineAngRadRad1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3df3d54de17a" + }, + "IMarkLineAngRadSpec": { + "typeName": "IMarkLineAngRadSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1818f2e34d58" + }, + "IMarkLineCoordinateSpec": { + "typeName": "IMarkLineCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-25e80ef7b42b" + }, + "IMarkLineRadAngAng1Spec": { + "typeName": "IMarkLineRadAngAng1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-604e38ee5301" + }, + "IMarkLineRadiusSpec": { + "typeName": "IMarkLineRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a2d55cb80bac" + }, + "IMarkLineSpec": { + "typeName": "IMarkLineSpec", + "reference": "type-details/IMarkLineSpec-Type-Definition.md" + }, + "IMarkLineTheme": { + "typeName": "IMarkLineTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1ca140194889" + }, + "IMarkLineXSpec": { + "typeName": "IMarkLineXSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-7ce1823090a0" + }, + "IMarkLineXYSpec": { + "typeName": "IMarkLineXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f50693a23ba0" + }, + "IMarkLineXYY1Spec": { + "typeName": "IMarkLineXYY1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-72d0df8a5295" + }, + "IMarkLineYSpec": { + "typeName": "IMarkLineYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d5755e40af1e" + }, + "IMarkLineYXX1Spec": { + "typeName": "IMarkLineYXX1Spec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9fa06e53cb0e" + }, + "IMarkPointAngleRadiusSpec": { + "typeName": "IMarkPointAngleRadiusSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0acfdd5b8e06" + }, + "IMarkPointCoordinateSpec": { + "typeName": "IMarkPointCoordinateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c827e1a43c9" + }, + "IMarkPointGeoNameSpec": { + "typeName": "IMarkPointGeoNameSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-fd30b323288a" + }, + "IMarkPointPositionsSpec": { + "typeName": "IMarkPointPositionsSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-78d1410fa542" + }, + "IMarkPointSpec": { + "typeName": "IMarkPointSpec", + "reference": "type-details/IMarkPointSpec-Type-Definition.md" + }, + "IMarkPointTheme": { + "typeName": "IMarkPointTheme", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a26d3a0701c1" + }, + "IMarkPointXYSpec": { + "typeName": "IMarkPointXYSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c38f0b023570" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/player/interface/spec.d.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/data-zoom/interface.d.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "IRuleMarkSpec": { + "typeName": "IRuleMarkSpec", + "reference": "type-details/IRuleMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/data-zoom/scroll-bar/interface.d.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/brush/interface.d.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/axis/interface.d.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStackCornerRadiusCallback": { + "typeName": "IStackCornerRadiusCallback", + "reference": "type-details/IStackCornerRadiusCallback-Type-Definition.md" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/theme/interface.d.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/media-query.d.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "IWaterfallSeriesSpec": { + "typeName": "IWaterfallSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-312af991e7a8" + }, + "IWaterfallStackLabelPosition": { + "typeName": "IWaterfallStackLabelPosition", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-000580d95d76" + }, + "IWaterfallStackLabelValueType": { + "typeName": "IWaterfallStackLabelValueType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-bc167196a113" + }, + "IWaterfallTotalCustom": { + "typeName": "IWaterfallTotalCustom", + "reference": "type-details/IWaterfallTotalCustom-Type-Definition.md" }, "IWaterfallTotalEnd": { "typeName": "IWaterfallTotalEnd", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/waterfall/interface.d.ts", - "note": "类型 IWaterfallTotalEnd 的定义位置" + "reference": "type-details/IWaterfallTotalEnd-Type-Definition.md" }, "IWaterfallTotalField": { "typeName": "IWaterfallTotalField", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/waterfall/interface.d.ts", - "note": "类型 IWaterfallTotalField 的定义位置" + "reference": "type-details/IWaterfallTotalField-Type-Definition.md" }, - "IWaterfallTotalCustom": { - "typeName": "IWaterfallTotalCustom", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/series/waterfall/interface.d.ts", - "note": "类型 IWaterfallTotalCustom 的定义位置" - }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/spec/common.d.ts", - "note": "类型 IMarkSpec 的定义位置" + "MarkCommonLineAnimationType": { + "typeName": "MarkCommonLineAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-681f4999f1eb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "IRuleMarkSpec": { - "typeName": "IRuleMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/typings/visual.d.ts", - "note": "类型 IRuleMarkSpec 的定义位置" + "MarkPointAnimationType": { + "typeName": "MarkPointAnimationType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d28c136a90bb", + "package": "@visactor/vrender-components", + "version": "1.1.12" }, - "ILabelSpec": { - "typeName": "ILabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ILabelSpec 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, - "ITotalLabelSpec": { - "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart-types/types/component/label/interface.d.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" } - }, - "statistics": { - "totalInterfaces": 4, - "totalProperties": 48, - "complexTypes": 36, - "typeFileLocations": 36, - "dependencyTypes": 865 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/wordCloud.json b/skills/vchart-development-assistant/references/type-meta/wordCloud.json index d6d1e1a92f..13d6a5cc0b 100644 --- a/skills/vchart-development-assistant/references/type-meta/wordCloud.json +++ b/skills/vchart-development-assistant/references/type-meta/wordCloud.json @@ -1,1167 +1,1071 @@ { "typeName": "IWordCloudChartSpec", - "description": "IWordCloudChartSpec 配置规范的完整实现分析", - "inheritanceTree": { - "IWordCloudChartSpec": { - "description": "IWordCloudChartSpec 接口配置", - "directExtends": [ - "IChartSpec", - "IChartExtendsSeriesSpec" + "formatVersion": 3, + "vchartVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "(IStateAnimateSpec & {\n duration?: number | undefined;\n totalTime?: number | undefined;\n}) | boolean | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig", + "WordcloudAppearPreset" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "colorHexField", + "description": "直接指定 hex 颜色字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "colorList", + "description": "颜色列表", + "type": "string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "colorMode", + "description": "颜色模式\nTODO: 'linear' 待支持", + "type": "\"ordinal\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "ordinal" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "fillingWord", + "description": "形状词云填充词文字图元配置", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & {\n padding?: number | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "ITextMarkSpec" + ], + "deprecated": true + }, + { + "name": "fontFamilyField", + "description": "字体字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontSizeRange", + "description": "字体大小范围", + "type": "\"auto\" | [\n number,\n number\n] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.8.7 如果配置为'auto', 则fontSizeRange不传入, 字体大小会随画布大小改变而改变", + "literalValues": [ + "auto" + ] + }, + { + "name": "fontStyleField", + "description": "字体样式字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontWeightField", + "description": "字重字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontWeightRange", + "description": "字重范围", + "type": "[\n number,\n number\n] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "[200,500]" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "keepAspect", + "description": "TODO: 缩放mask时是否保持比例", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maskShape", + "description": "词云形状", + "type": "GeometricMaskShape | string | TextShapeMask | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "GeometricMaskShape", + "TextShapeMask", + "WordCloudShapeType" + ], + "defaultValue": "'circle'\n\n注意，文字类型和几何形状类型的shape自 1.12.0 版本开始支持" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" ], - "ownProperties": [ - { - "name": "type", - "description": "type 配置", - "type": "'wordCloud'", - "originalType": "'wordCloud'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "series", - "description": "series 配置", - "type": "IWordCloudSeriesSpec[]", - "originalType": "IWordCloudSeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IWordCloudSeriesSpec" - ] - } + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nameField", + "description": "文本字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "random", + "description": "是否开始随机摆放方向(顺时针｜逆时针), 主要用于spec测试", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "rotateAngles", + "description": "可旋转角度 随机取范围", + "type": "number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IWordCloudSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IWordCloudSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" ] }, - "IChartSpec": { - "description": "chart spec", - "directExtends": [], - "ownProperties": [ - { - "name": "type", - "description": "图表类型", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "data", - "description": "数据", - "type": "IData", - "originalType": "IData", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IData" - ] - }, - { - "name": "width", - "description": "画布宽度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "height", - "description": "画布高度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "autoFit", - "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "padding", - "description": "图表整体 padding 设置", - "type": "ILayoutPaddingSpec", - "originalType": "ILayoutPaddingSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutPaddingSpec" - ] - }, - { - "name": "color", - "description": "图表色系配置", - "type": "string[] | Omit, 'id'>", - "originalType": "string[] | Omit, 'id'>", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "series", - "description": "系列", - "type": "ISeriesSpec[]", - "originalType": "ISeriesSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesSpec" - ] - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ] - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "since": "1.2.0" - }, - { - "name": "hover", - "description": "hover 交互", - "type": "boolean | IHoverSpec", - "originalType": "boolean | IHoverSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ] - }, - { - "name": "select", - "description": "select 交互", - "type": "boolean | ISelectSpec", - "originalType": "boolean | ISelectSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ] - }, - { - "name": "region", - "description": "region配置", - "type": "RegionSpec[]", - "originalType": "RegionSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "RegionSpec" - ] - }, - { - "name": "title", - "description": "图表标题配置", - "type": "ITitleSpec", - "originalType": "ITitleSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITitleSpec" - ] - }, - { - "name": "layout", - "description": "布局配置", - "type": "ILayoutSpec", - "originalType": "ILayoutSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILayoutSpec" - ] - }, - { - "name": "legends", - "description": "图例配置", - "type": "ILegendSpec | ILegendSpec[]", - "originalType": "ILegendSpec | ILegendSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ILegendSpec" - ] - }, - { - "name": "crosshair", - "description": "十字辅助线配置", - "type": "ICrosshairSpec | ICrosshairSpec[]", - "originalType": "ICrosshairSpec | ICrosshairSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICrosshairSpec" - ] - }, - { - "name": "tooltip", - "description": "tooltip配置", - "type": "ITooltipSpec", - "originalType": "ITooltipSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITooltipSpec" - ] - }, - { - "name": "player", - "description": "播放器配置", - "type": "IPlayer", - "originalType": "IPlayer", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IPlayer" - ] - }, - { - "name": "dataZoom", - "description": "缩略轴配置", - "type": "IDataZoomSpec | IDataZoomSpec[]", - "originalType": "IDataZoomSpec | IDataZoomSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IDataZoomSpec" - ] - }, - { - "name": "scrollBar", - "description": "滚动条配置", - "type": "IScrollBarSpec | IScrollBarSpec[]", - "originalType": "IScrollBarSpec | IScrollBarSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IScrollBarSpec" - ] - }, - { - "name": "brush", - "description": "框选配置", - "type": "IBrushSpec", - "originalType": "IBrushSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBrushSpec" - ] - }, - { - "name": "scales", - "description": "全局 scale 配置", - "type": "IVisualSpecScale[]", - "originalType": "IVisualSpecScale[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IVisualSpecScale" - ] - }, - { - "name": "customMark", - "description": "自定义mark", - "type": "ICustomMarkSpec[]", - "originalType": "ICustomMarkSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICustomMarkSpec" - ] - }, - { - "name": "axes", - "description": "轴", - "type": "ICommonAxisSpec[]", - "originalType": "ICommonAxisSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ICommonAxisSpec" - ] - }, - { - "name": "theme", - "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", - "type": "Omit | string", - "originalType": "Omit | string", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITheme" - ] - }, - { - "name": "background", - "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", - "type": "IBackgroundSpec", - "originalType": "IBackgroundSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IBackgroundSpec" - ] - }, - { - "name": "stackInverse", - "description": "堆积时是否逆序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "since": "1.4.0", - "defaultValue": "false" - }, - { - "name": "stackSort", - "description": "堆积时是否排序", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "since": "1.10.4", - "defaultValue": "false" - }, - { - "name": "media", - "description": "媒体查询配置", - "type": "IMediaQuerySpec", - "originalType": "IMediaQuerySpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMediaQuerySpec" - ], - "since": "1.8.0" - } + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" ] }, - "IChartExtendsSeriesSpec": { - "description": "IWordCloudSeriesSpec 的属性（排除 data, morph, stackValue, tooltip）", - "directExtends": [], - "ownProperties": [ - { - "name": "hover", - "description": "图表hover相关交互配置，当值为boolean类型时，表示开启或者关闭该交互\n也支持更详细的交互配置", - "type": "IHoverSpec | boolean", - "originalType": "IHoverSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IHoverSpec" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "select", - "description": "图表选中相关交互配置，当值为boolean类型时，表示开启或者关闭该交互\n也支持更详细的交互配置", - "type": "ISelectSpec | boolean", - "originalType": "ISelectSpec | boolean", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISelectSpec" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "interactions", - "description": "其他需要按需注册的类型交互", - "type": "IInteractionItemSpec[]", - "originalType": "IInteractionItemSpec[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IInteractionItemSpec" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "type", - "description": "type 配置", - "type": "'wordCloud'", - "originalType": "'wordCloud'", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [] - }, - { - "name": "name", - "description": "系列名称", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "id", - "description": "用户自定义的 series id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "dataIndex", - "description": "系列关联的数据索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "defaultValue": "0", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "dataId", - "description": "系列关联的数据id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "dataKey", - "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", - "type": "string | string[] | ((data: Datum, index: number) => string)", - "originalType": "DataKeyType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "regionIndex", - "description": "系列关联的region索引", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "defaultValue": "0", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "regionId", - "description": "系列关联的region id", - "type": "string | number", - "originalType": "StringOrNumber", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "seriesField", - "description": "分组字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "seriesStyle", - "description": "系列样式", - "type": "ISeriesStyle", - "originalType": "ISeriesStyle", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ISeriesStyle" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "stack", - "description": "是否对数据进行堆叠处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "totalLabel", - "description": "堆叠汇总标签", - "type": "ITotalLabelSpec", - "originalType": "ITotalLabelSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "ITotalLabelSpec" - ], - "since": "1.3.0", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "percent", - "description": "是否对数据进行百分比处理", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "stackOffsetSilhouette", - "description": "是否围绕中心轴偏移轮廓", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "invalidType", - "description": "非合规数据点连接方式", - "type": "'zero' | 'ignore' | 'link' | 'break'", - "originalType": "IInvalidType", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animation", - "description": "是否开启系列动画", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animationThreshold", - "description": "自动关闭动画的阀值，对应的是单系列data的长度", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "since": "1.2.0", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "support3d", - "description": "是否支持3d视角", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "extensionMark", - "description": "系列的扩展mark，能够获取系列上的数据", - "type": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "originalType": "(IExtensionMarkSpec> | IExtensionGroupMarkSpec)[]", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IExtensionMarkSpec", - "IExtensionGroupMarkSpec" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "zIndex", - "description": "今当通过`series`配置的时候，才会生效", - "type": "number", - "originalType": "number", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animationAppear", - "description": "animationAppear 配置", - "type": "| boolean\n | (IStateAnimateSpec & {\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n })\n | IMarkAnimateSpec", - "originalType": "| boolean\n | (IStateAnimateSpec & {\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n })\n | IMarkAnimateSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "(IStateAnimateSpec", - "{\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n })" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animationEnter", - "description": "数据新增动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animationUpdate", - "description": "数据更新动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "animationExit", - "description": "数据移除动画配置", - "type": "IAnimationConfig", - "originalType": "IAnimationConfig", - "required": false, - "category": "动画配置", - "isSimple": false, - "dependencies": [ - "IAnimationConfig" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "nameField", - "description": "文本字段", - "type": "string", - "originalType": "string", - "required": true, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "valueField", - "description": "权重字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fontFamilyField", - "description": "字体字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fontWeightField", - "description": "字重字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fontStyleField", - "description": "字体样式字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "colorHexField", - "description": "直接指定 hex 颜色字段", - "type": "string", - "originalType": "string", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "colorMode", - "description": "颜色模式\nTODO: 'linear' 待支持", - "type": "'ordinal'", - "originalType": "'ordinal'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "colorList", - "description": "颜色列表", - "type": "string[]", - "originalType": "string[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "rotateAngles", - "description": "可旋转角度 随机取范围", - "type": "number[]", - "originalType": "number[]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fontWeightRange", - "description": "字重范围", - "type": "[number, number]", - "originalType": "[number, number]", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [ - ], - "defaultValue": "[200,500]", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fontSizeRange", - "description": "字体大小范围", - "type": "[number, number] | 'auto'", - "originalType": "[number, number] | 'auto'", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [ - ], - "since": "1.8.7 如果配置为'auto', 则fontSizeRange不传入, 字体大小会随画布大小改变而改变", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "maskShape", - "description": "词云形状", - "type": "string | WordCloudShapeType | TextShapeMask | GeometricMaskShape", - "originalType": "string | WordCloudShapeType | TextShapeMask | GeometricMaskShape", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "WordCloudShapeType", - "TextShapeMask", - "GeometricMaskShape" - ], - "defaultValue": "'circle'\n\n注意，文字类型和几何形状类型的shape自 1.12.0 版本开始支持", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "keepAspect", - "description": "TODO: 缩放mask时是否保持比例", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "random", - "description": "是否开始随机摆放方向(顺时针｜逆时针), 主要用于spec测试", - "type": "boolean", - "originalType": "boolean", - "required": false, - "category": "未分类", - "isSimple": true, - "dependencies": [], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "wordCloudConfig", - "description": "词云特殊配置", - "type": "WordCloudConfigType", - "originalType": "WordCloudConfigType", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "WordCloudConfigType" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "wordCloudShapeConfig", - "description": "形状词云特殊配置", - "type": "WordCloudShapeConfigType", - "originalType": "WordCloudShapeConfigType", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "WordCloudShapeConfigType" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "word", - "description": "词云文字图元配置 或 形状词云核心词文字图元配置", - "type": "IMarkSpec & {\n padding?: number;\n formatMethod?: ITextFormatMethod<[datum?: any]>;\n }", - "originalType": "IMarkSpec & {\n padding?: number;\n formatMethod?: ITextFormatMethod<[datum?: any]>;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ITextMarkSpec" - ], - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "fillingWord", - "description": "形状词云填充词文字图元配置", - "type": "IMarkSpec & {\n padding?: number;\n }", - "originalType": "IMarkSpec & {\n padding?: number;\n }", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "ITextMarkSpec" - ], - "deprecated": true, - "inheritedFrom": "IWordCloudSeriesBaseSpec" - }, - { - "name": "wordMask", - "description": "当形状词云的形状为文字类型和几何形状类型的时候，支持绘制形状轮廓", - "type": "IMarkSpec", - "originalType": "IMarkSpec", - "required": false, - "category": "未分类", - "isSimple": false, - "dependencies": [ - "IMarkSpec", - "IRectMarkSpec" - ], - "since": "1.12.0", - "inheritedFrom": "IWordCloudSeriesBaseSpec" - } + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" ], - "note": "展开自 Omit - 包含 46 个属性（已展开所有继承）", - "expandedFrom": "IWordCloudSeriesSpec", - "omittedKeys": [ - "data", - "morph", - "stackValue", - "tooltip" + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"wordCloud\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "wordCloud" + ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "word", + "description": "词云文字图元配置 或 形状词云核心词文字图元配置", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & {\n padding?: number | undefined;\n formatMethod?: ITextFormatMethod<[\n datum?: any\n ]> | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "ITextFormatMethod", + "ITextMarkSpec" ] + }, + { + "name": "wordCloudConfig", + "description": "词云特殊配置", + "type": "undefined | WordCloudConfigType", + "required": false, + "isSimple": false, + "dependencies": [ + "WordCloudConfigType" + ] + }, + { + "name": "wordCloudShapeConfig", + "description": "形状词云特殊配置", + "type": "undefined | WordCloudShapeConfigType", + "required": false, + "isSimple": false, + "dependencies": [ + "WordCloudShapeConfigType" + ] + }, + { + "name": "wordMask", + "description": "当形状词云的形状为文字类型和几何形状类型的时候，支持绘制形状轮廓", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ], + "since": "1.12.0" + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] } - }, - "timestamp": "2025-08-06T05:48:04.812Z", - "version": "1.0.0", - "sourceFile": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/chart/word-cloud/interface.ts", + ], "complexTypeDefinitions": { - "IWordCloudSeriesSpec": { - "typeName": "IWordCloudSeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/series/word-cloud/interface.ts", - "note": "类型 IWordCloudSeriesSpec 的定义位置" + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "GeometricMaskShape": { + "typeName": "GeometricMaskShape", + "reference": "type-details/GeometricMaskShape-Type-Definition.md", + "package": "@visactor/vlayouts", + "version": "1.0.28" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" }, "IData": { "typeName": "IData", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IData 的定义位置" + "reference": "type-details/IData-Type-Definition.md" }, - "ILayoutPaddingSpec": { - "typeName": "ILayoutPaddingSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/layout.ts", - "note": "类型 ILayoutPaddingSpec 的定义位置" + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" }, - "IVisualSpecScale": { - "typeName": "IVisualSpecScale", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/visual.ts", - "note": "类型 IVisualSpecScale 的定义位置" + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" }, - "ISeriesSpec": { - "typeName": "ISeriesSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 ISeriesSpec 的定义位置" + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" }, - "ISeriesStyle": { - "typeName": "ISeriesStyle", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/series/interface/common.ts", - "note": "类型 ISeriesStyle 的定义位置" + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" }, "IHoverSpec": { "typeName": "IHoverSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/interaction/interface/spec.ts", - "note": "类型 IHoverSpec 的定义位置" + "reference": "type-details/IHoverSpec-Type-Definition.md" }, - "ISelectSpec": { - "typeName": "ISelectSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/interaction/interface/spec.ts", - "note": "类型 ISelectSpec 的定义位置" + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" }, - "RegionSpec": { - "typeName": "RegionSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/region/interface.ts", - "note": "类型 RegionSpec 的定义位置" + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" }, - "ITitleSpec": { - "typeName": "ITitleSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/title/interface/spec.ts", - "note": "类型 ITitleSpec 的定义位置" + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" }, "ILayoutSpec": { "typeName": "ILayoutSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/layout/interface.ts", - "note": "类型 ILayoutSpec 的定义位置" + "reference": "type-details/ILayoutSpec-Type-Definition.md" }, "ILegendSpec": { "typeName": "ILegendSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/legend/interface.ts", - "note": "类型 ILegendSpec 的定义位置" + "reference": "type-details/ILegendSpec-Type-Definition.md" }, - "ICrosshairSpec": { - "typeName": "ICrosshairSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/crosshair/interface/spec.ts", - "note": "类型 ICrosshairSpec 的定义位置" + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" }, - "ITooltipSpec": { - "typeName": "ITooltipSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/tooltip/interface/spec.ts", - "note": "类型 ITooltipSpec 的定义位置" + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" }, "IPlayer": { "typeName": "IPlayer", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/player/interface/spec.ts", - "note": "类型 IPlayer 的定义位置" + "reference": "type-details/IPlayer-Type-Definition.md" }, - "IDataZoomSpec": { - "typeName": "IDataZoomSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/data-zoom/data-zoom/interface.ts", - "note": "类型 IDataZoomSpec 的定义位置" + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" }, "IScrollBarSpec": { "typeName": "IScrollBarSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/data-zoom/scroll-bar/interface.ts", - "note": "类型 IScrollBarSpec 的定义位置" + "reference": "type-details/IScrollBarSpec-Type-Definition.md" }, - "IBrushSpec": { - "typeName": "IBrushSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/brush/interface.ts", - "note": "类型 IBrushSpec 的定义位置" + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" }, - "ICustomMarkSpec": { - "typeName": "ICustomMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 ICustomMarkSpec 的定义位置" + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" }, - "ICommonAxisSpec": { - "typeName": "ICommonAxisSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/axis/interface/spec.ts", - "note": "类型 ICommonAxisSpec 的定义位置" + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITextFormatMethod": { + "typeName": "ITextFormatMethod", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5a8994f84d7b" + }, + "ITextMarkSpec": { + "typeName": "ITextMarkSpec", + "reference": "type-details/ITextMarkSpec-Type-Definition.md" }, "ITheme": { "typeName": "ITheme", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/theme/interface.ts", - "note": "类型 ITheme 的定义位置" + "reference": "type-details/ITheme-Type-Definition.md" }, - "IBackgroundSpec": { - "typeName": "IBackgroundSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IBackgroundSpec 的定义位置" + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" }, - "IMediaQuerySpec": { - "typeName": "IMediaQuerySpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/media-query.ts", - "note": "类型 IMediaQuerySpec 的定义位置" + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" }, - "IInteractionItemSpec": { - "typeName": "IInteractionItemSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/interaction/interface/spec.ts", - "note": "类型 IInteractionItemSpec 的定义位置" + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" }, "ITotalLabelSpec": { "typeName": "ITotalLabelSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/component/label/interface.ts", - "note": "类型 ITotalLabelSpec 的定义位置" + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" }, - "IExtensionMarkSpec": { - "typeName": "IExtensionMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IExtensionMarkSpec 的定义位置" - }, - "IExtensionGroupMarkSpec": { - "typeName": "IExtensionGroupMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IExtensionGroupMarkSpec 的定义位置" - }, - "(IStateAnimateSpec": { - "typeName": "(IStateAnimateSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 (IStateAnimateSpec 的定义位置" - }, - "{\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n })": { - "typeName": "{\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n })", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 {\n /**\n * 默认prest('scaleIn')时，duration为词云中单个词的动画参考时长。当单词数过多，会根据单词总数和总动画时长进行动态调整\n * prest为 'fadeIn' 时，则为总动画时长。\n */\n duration?: number;\n /**\n * 词云入场动画总时长，在默认prest('scaleIn')时生效。\n * @default 1000\n * @since 1.4.0\n */\n totalTime?: number;\n }) 的定义位置" + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" }, - "IAnimationConfig": { - "typeName": "IAnimationConfig", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IAnimationConfig 的定义位置" + "IWordCloudSeriesSpec": { + "typeName": "IWordCloudSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-472dc2c97d50" }, - "WordCloudShapeType": { - "typeName": "WordCloudShapeType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/series/word-cloud/interface.ts", - "note": "类型 WordCloudShapeType 的定义位置" + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" }, "TextShapeMask": { "typeName": "TextShapeMask", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 TextShapeMask 的定义位置" + "reference": "type-details/TextShapeMask-Type-Definition.md", + "package": "@visactor/vlayouts", + "version": "1.0.28" }, - "GeometricMaskShape": { - "typeName": "GeometricMaskShape", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 GeometricMaskShape 的定义位置" + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + }, + "word": { + "typeName": "word", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-dcab00960f46" + }, + "WordcloudAppearPreset": { + "typeName": "WordcloudAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-230d77f59707" }, "WordCloudConfigType": { "typeName": "WordCloudConfigType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/series/word-cloud/interface.ts", - "note": "类型 WordCloudConfigType 的定义位置" + "reference": "type-details/WordCloudConfigType-Type-Definition.md" }, "WordCloudShapeConfigType": { "typeName": "WordCloudShapeConfigType", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/series/word-cloud/interface.ts", - "note": "类型 WordCloudShapeConfigType 的定义位置" - }, - "IMarkSpec": { - "typeName": "IMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/spec/common.ts", - "note": "类型 IMarkSpec 的定义位置" + "reference": "type-details/WordCloudShapeConfigType-Type-Definition.md" }, - "ITextMarkSpec": { - "typeName": "ITextMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/visual.ts", - "note": "类型 ITextMarkSpec 的定义位置" - }, - "IRectMarkSpec": { - "typeName": "IRectMarkSpec", - "filePath": "/Users/bytedance/Documents/opensource/VChart/packages/vchart/src/typings/visual.ts", - "note": "类型 IRectMarkSpec 的定义位置" + "WordCloudShapeType": { + "typeName": "WordCloudShapeType", + "reference": "type-details/WordCloudShapeType-Type-Definition.md" } - }, - "statistics": { - "totalInterfaces": 3, - "totalProperties": 78, - "complexTypes": 39, - "typeFileLocations": 39, - "dependencyTypes": 862 } -} \ No newline at end of file +} diff --git a/skills/vchart-development-assistant/references/type-meta/wordCloud3d.json b/skills/vchart-development-assistant/references/type-meta/wordCloud3d.json new file mode 100644 index 0000000000..ea8d1e1414 --- /dev/null +++ b/skills/vchart-development-assistant/references/type-meta/wordCloud3d.json @@ -0,0 +1,1098 @@ +{ + "typeName": "IWordCloud3dChartSpec", + "formatVersion": 3, + "vchartVersion": "2.1.7", + "extensionVersion": "2.1.7", + "effectiveProperties": [ + { + "name": "animation", + "description": "是否开启系列动画", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "animationAppear", + "description": "图表入场动画\n支持配置图表内置不同动画效果", + "type": "(IStateAnimateSpec & {\n duration?: number | undefined;\n totalTime?: number | undefined;\n}) | boolean | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "IStateAnimateSpec", + "TypeAnimationConfig", + "WordcloudAppearPreset" + ] + }, + { + "name": "animationDisappear", + "description": "图表退场动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationEnter", + "description": "数据更新 - 新增数据动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationExit", + "description": "数据更新 - 数据删除动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationNormal", + "description": "循环动画", + "type": "Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "animationState", + "description": "状态切换动画", + "type": "boolean | IStateAnimationConfig | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IStateAnimationConfig" + ], + "since": "1.12.0" + }, + { + "name": "animationThreshold", + "description": "自动关闭动画的阀值，对应的是单系列data的长度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "since": "1.2.0" + }, + { + "name": "animationUpdate", + "description": "数据更新 - 数据更新动画", + "type": "boolean | ICommonStateAnimateSpec | Partial> | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ChannelAnimationConfig", + "CommonAnimationConfigItem", + "IAnimationConfig", + "IAnimationTimeline", + "ICommonStateAnimateSpec", + "IMarkAnimateSpec", + "TypeAnimationConfig", + "word" + ] + }, + { + "name": "autoFit", + "description": "图表宽高是否自适应容器，浏览器环境下默认为 true。\n该配置的优先级高于构造函数中的 autoFit 配置。\n如果用户配置了 width，则以用户配置的 width 为准，height 同理。", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "axes", + "description": "轴", + "type": "ICommonAxisSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICommonAxisSpec" + ] + }, + { + "name": "background", + "description": "图表背景色配置，优先级高于构造函数中的 background 配置\n自1.11.6版本支持渐变色对象的配置", + "type": "IBackgroundSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ConvertToMarkStyleSpec", + "IBackgroundSpec", + "IConicalGradient", + "IGroupMarkSpec", + "ILinearGradient", + "IRadialGradient" + ] + }, + { + "name": "brush", + "description": "框选配置", + "type": "IBrushSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBrushSpec" + ] + }, + { + "name": "color", + "description": "图表色系配置", + "type": "Omit, \"id\"> | string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "colorHexField", + "description": "直接指定 hex 颜色字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "colorList", + "description": "颜色列表", + "type": "string[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "colorMode", + "description": "颜色模式\nTODO: 'linear' 待支持", + "type": "\"ordinal\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "ordinal" + ] + }, + { + "name": "crosshair", + "description": "十字辅助线配置", + "type": "ICrosshairSpec | ICrosshairSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ICartesianCrosshairSpec", + "ICrosshairSpec", + "IPolarCrosshairSpec" + ] + }, + { + "name": "customMark", + "description": "自定义mark", + "type": "ICustomMarkSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "ICustomMarkSpec" + ] + }, + { + "name": "data", + "description": "数据", + "type": "IData | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataView", + "IData", + "IDataType", + "IDataValues" + ] + }, + { + "name": "dataId", + "description": "系列关联的数据id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "dataIndex", + "description": "系列关联的数据索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "dataKey", + "description": "dataKey用于绑定数据与Mark的关系, 该配置在动画中非常重要.", + "type": "DataKeyType | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "DataKeyType" + ] + }, + { + "name": "dataZoom", + "description": "缩略轴配置", + "type": "IDataZoomSpec | IDataZoomSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IDataZoomSpec" + ] + }, + { + "name": "depth_3d", + "description": "depth_3d 配置", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "extensionMark", + "description": "系列的扩展mark，能够获取系列上的数据", + "type": "(IExtensionGroupMarkSpec | IExtensionMarkSpec<\"arc\" | \"area\" | \"boxPlot\" | \"image\" | \"line\" | \"linkPath\" | \"path\" | \"polygon\" | \"rect\" | \"ripple\" | \"rule\" | \"symbol\" | \"text\">)[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "EnableMarkType", + "IExtensionGroupMarkSpec", + "IExtensionMarkSpec" + ] + }, + { + "name": "fillingWord", + "description": "形状词云填充词文字图元配置", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & {\n padding?: number | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "ITextMarkSpec" + ], + "deprecated": true + }, + { + "name": "fontFamilyField", + "description": "字体字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontSizeRange", + "description": "字体大小范围", + "type": "\"auto\" | [\n number,\n number\n] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "since": "1.8.7 如果配置为'auto', 则fontSizeRange不传入, 字体大小会随画布大小改变而改变", + "literalValues": [ + "auto" + ] + }, + { + "name": "fontStyleField", + "description": "字体样式字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontWeightField", + "description": "字重字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "fontWeightRange", + "description": "字重范围", + "type": "[\n number,\n number\n] | undefined", + "required": false, + "isSimple": false, + "dependencies": [], + "defaultValue": "[200,500]" + }, + { + "name": "height", + "description": "画布高度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "hover", + "description": "hover 交互", + "type": "boolean | IHoverSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IHoverSpec" + ] + }, + { + "name": "id", + "description": "用户自定义的 series id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "interactions", + "description": "其他需要按需注册的类型交互", + "type": "IInteractionItemSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IInteractionItemSpec" + ] + }, + { + "name": "invalidType", + "description": "非合规数据点连接方式", + "type": "IInvalidType | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "'break'\n'break'指在该数据点处断开\n'link' 指忽略该点保持连续\n'zero' 指该点默认数值为0\n'ignore' 指不处理", + "literalValues": [ + "break", + "ignore", + "link", + "zero" + ] + }, + { + "name": "keepAspect", + "description": "TODO: 缩放mask时是否保持比例", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "layout", + "description": "布局配置", + "type": "ILayoutSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IBaseLayoutSpec", + "IGridLayoutSpec", + "ILayoutSpec" + ] + }, + { + "name": "legends", + "description": "图例配置", + "type": "ILegendSpec | ILegendSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IColorLegendSpec", + "IDiscreteLegendSpec", + "ILegendSpec", + "ISizeLegendSpec" + ] + }, + { + "name": "maskShape", + "description": "词云形状", + "type": "GeometricMaskShape | string | TextShapeMask | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "GeometricMaskShape", + "TextShapeMask", + "WordCloudShapeType" + ], + "defaultValue": "'circle'\n\n注意，文字类型和几何形状类型的shape自 1.12.0 版本开始支持" + }, + { + "name": "media", + "description": "媒体查询配置", + "type": "IMediaQuerySpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMediaQuerySpec" + ], + "since": "1.8.0" + }, + { + "name": "name", + "description": "系列名称", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "nameField", + "description": "文本字段", + "type": "string", + "required": true, + "isSimple": true, + "dependencies": [] + }, + { + "name": "padding", + "description": "图表整体 padding 设置", + "type": "ILayoutPaddingSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ILayoutNumber", + "ILayoutOrientPadding", + "ILayoutPaddingSpec", + "IPercentOffset" + ] + }, + { + "name": "percent", + "description": "是否对数据进行百分比处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "player", + "description": "播放器配置", + "type": "IPlayer | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IPlayer" + ] + }, + { + "name": "postProjection", + "description": "postProjection 配置", + "type": "\"StereographicProjection\" | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "StereographicProjection" + ] + }, + { + "name": "random", + "description": "是否开始随机摆放方向(顺时针｜逆时针), 主要用于spec测试", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "region", + "description": "region配置", + "type": "RegionSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "RegionSpec" + ] + }, + { + "name": "regionId", + "description": "系列关联的region id", + "type": "StringOrNumber | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "regionIndex", + "description": "系列关联的region索引", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "0" + }, + { + "name": "rotateAngles", + "description": "可旋转角度 随机取范围", + "type": "number[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [] + }, + { + "name": "scales", + "description": "全局 scale 配置", + "type": "IVisualSpecScale[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IVisualSpecScale" + ] + }, + { + "name": "scrollBar", + "description": "滚动条配置", + "type": "IScrollBarSpec | IScrollBarSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IScrollBarSpec" + ] + }, + { + "name": "select", + "description": "select 交互", + "type": "boolean | ISelectSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISelectSpec" + ] + }, + { + "name": "series", + "description": "系列", + "type": "IWordCloud3dSeriesSpec[] | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IWordCloud3dSeriesSpec" + ] + }, + { + "name": "seriesField", + "description": "分组字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "seriesStyle", + "description": "系列样式", + "type": "ISeriesStyle | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ISeriesStyle" + ] + }, + { + "name": "stack", + "description": "是否对数据进行堆叠处理", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackInverse", + "description": "堆积时是否逆序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.4.0" + }, + { + "name": "stackOffsetSilhouette", + "description": "是否围绕中心轴偏移轮廓", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "stackSort", + "description": "堆积时是否排序", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [], + "defaultValue": "false", + "since": "1.10.4" + }, + { + "name": "support3d", + "description": "是否支持3d视角", + "type": "boolean | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "theme", + "description": "图表上的主题定义。\n可以直接配置主题名，前提是该主题名已经注册", + "type": "Omit | string | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITheme" + ] + }, + { + "name": "title", + "description": "图表标题配置", + "type": "ITitleSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITitleSpec", + "ITitleSpecWithoutText" + ] + }, + { + "name": "tooltip", + "description": "tooltip配置", + "type": "ITooltipSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITooltipSpec" + ] + }, + { + "name": "totalLabel", + "description": "堆叠汇总标签", + "type": "ITotalLabelSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "ITotalLabelSpec" + ], + "since": "1.3.0" + }, + { + "name": "type", + "description": "图表类型", + "type": "\"wordCloud3d\"", + "required": true, + "isSimple": true, + "dependencies": [], + "literalValues": [ + "wordCloud3d" + ] + }, + { + "name": "valueField", + "description": "权重字段", + "type": "string | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "width", + "description": "画布宽度", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + }, + { + "name": "word", + "description": "词云文字图元配置 或 形状词云核心词文字图元配置", + "type": "({\n id?: StringOrNumber | undefined;\n interactive?: boolean | undefined;\n zIndex?: number | undefined;\n visible?: boolean | undefined;\n style?: ConvertToMarkStyleSpec | undefined;\n state?: IMarkStateFullSpec | undefined;\n stateSort?: ((stateA: string, stateB: string) => number) | undefined;\n support3d?: boolean | undefined;\n customShape?: ((datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) | undefined;\n} & IMarkProgressiveConfig & {\n padding?: number | undefined;\n formatMethod?: ITextFormatMethod<[\n datum?: any\n ]> | undefined;\n}) | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkProgressiveConfig", + "IMarkSpec", + "ITextFormatMethod", + "ITextMarkSpec" + ] + }, + { + "name": "wordCloudConfig", + "description": "词云特殊配置", + "type": "undefined | WordCloudConfigType", + "required": false, + "isSimple": false, + "dependencies": [ + "WordCloudConfigType" + ] + }, + { + "name": "wordCloudShapeConfig", + "description": "形状词云特殊配置", + "type": "undefined | WordCloudShapeConfigType", + "required": false, + "isSimple": false, + "dependencies": [ + "WordCloudShapeConfigType" + ] + }, + { + "name": "wordMask", + "description": "当形状词云的形状为文字类型和几何形状类型的时候，支持绘制形状轮廓", + "type": "IMarkSpec | undefined", + "required": false, + "isSimple": false, + "dependencies": [ + "IMarkSpec", + "IRectMarkSpec" + ], + "since": "1.12.0" + }, + { + "name": "zIndex", + "description": "今当通过`series`配置的时候，才会生效", + "type": "number | undefined", + "required": false, + "isSimple": true, + "dependencies": [] + } + ], + "complexTypeDefinitions": { + "ChannelAnimationConfig": { + "typeName": "ChannelAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5d8412d98274" + }, + "CommonAnimationConfigItem": { + "typeName": "CommonAnimationConfigItem", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-a27ba00f90e2" + }, + "ConvertToMarkStyleSpec": { + "typeName": "ConvertToMarkStyleSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3f4d44a2bad5" + }, + "DataKeyType": { + "typeName": "DataKeyType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-4bea0f6c4d4f" + }, + "DataView": { + "typeName": "DataView", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b26ccd36d8e8", + "package": "@visactor/vdataset", + "version": "1.0.28" + }, + "EnableMarkType": { + "typeName": "EnableMarkType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-1fa7d0f6abc4" + }, + "GeometricMaskShape": { + "typeName": "GeometricMaskShape", + "reference": "type-details/GeometricMaskShape-Type-Definition.md", + "package": "@visactor/vlayouts", + "version": "1.0.28" + }, + "IAnimationConfig": { + "typeName": "IAnimationConfig", + "reference": "type-details/IAnimationConfig-Type-Definition.md" + }, + "IAnimationTimeline": { + "typeName": "IAnimationTimeline", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f36951a20ee2" + }, + "IBackgroundSpec": { + "typeName": "IBackgroundSpec", + "reference": "type-details/IBackgroundSpec-Type-Definition.md" + }, + "IBaseLayoutSpec": { + "typeName": "IBaseLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5de1760225a6" + }, + "IBrushSpec": { + "typeName": "IBrushSpec", + "reference": "type-details/IBrushSpec-Type-Definition.md" + }, + "ICartesianCrosshairSpec": { + "typeName": "ICartesianCrosshairSpec", + "reference": "type-details/ICartesianCrosshairSpec-Type-Definition.md" + }, + "IColorLegendSpec": { + "typeName": "IColorLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8565dc89d142" + }, + "ICommonAxisSpec": { + "typeName": "ICommonAxisSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-500cf18886a4" + }, + "ICommonStateAnimateSpec": { + "typeName": "ICommonStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-874c3b173f64" + }, + "IConicalGradient": { + "typeName": "IConicalGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d7015f202839", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "ICrosshairSpec": { + "typeName": "ICrosshairSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-2c1a18c2e6b2" + }, + "ICustomMarkSpec": { + "typeName": "ICustomMarkSpec", + "reference": "type-details/ICustomMarkSpec-Type-Definition.md" + }, + "IData": { + "typeName": "IData", + "reference": "type-details/IData-Type-Definition.md" + }, + "IDataType": { + "typeName": "IDataType", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-3bf45e5ed347" + }, + "IDataValues": { + "typeName": "IDataValues", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-218b08963b1d" + }, + "IDataZoomSpec": { + "typeName": "IDataZoomSpec", + "reference": "type-details/IDataZoomSpec-Type-Definition.md" + }, + "IDiscreteLegendSpec": { + "typeName": "IDiscreteLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-0db130a1ae74" + }, + "IExtensionGroupMarkSpec": { + "typeName": "IExtensionGroupMarkSpec", + "reference": "type-details/IExtensionGroupMarkSpec-Type-Definition.md" + }, + "IExtensionMarkSpec": { + "typeName": "IExtensionMarkSpec", + "reference": "type-details/IExtensionMarkSpec-Type-Definition.md" + }, + "IGridLayoutSpec": { + "typeName": "IGridLayoutSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8c0cc65dc7ab" + }, + "IGroupMarkSpec": { + "typeName": "IGroupMarkSpec", + "reference": "type-details/IGroupMarkSpec-Type-Definition.md" + }, + "IHoverSpec": { + "typeName": "IHoverSpec", + "reference": "type-details/IHoverSpec-Type-Definition.md" + }, + "IInteractionItemSpec": { + "typeName": "IInteractionItemSpec", + "reference": "type-details/IInteractionItemSpec-Type-Definition.md" + }, + "ILayoutNumber": { + "typeName": "ILayoutNumber", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-9638d3997297" + }, + "ILayoutOrientPadding": { + "typeName": "ILayoutOrientPadding", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b2bc0ee5203d" + }, + "ILayoutPaddingSpec": { + "typeName": "ILayoutPaddingSpec", + "reference": "type-details/ILayoutPaddingSpec-Type-Definition.md" + }, + "ILayoutSpec": { + "typeName": "ILayoutSpec", + "reference": "type-details/ILayoutSpec-Type-Definition.md" + }, + "ILegendSpec": { + "typeName": "ILegendSpec", + "reference": "type-details/ILegendSpec-Type-Definition.md" + }, + "ILinearGradient": { + "typeName": "ILinearGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d8d5bda2ce95", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IMarkAnimateSpec": { + "typeName": "IMarkAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-f077d8f2c125" + }, + "IMarkProgressiveConfig": { + "typeName": "IMarkProgressiveConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-059a3e6127d2" + }, + "IMarkSpec": { + "typeName": "IMarkSpec", + "reference": "type-details/IMarkSpec-Type-Definition.md" + }, + "IMediaQuerySpec": { + "typeName": "IMediaQuerySpec", + "reference": "type-details/IMediaQuerySpec-Type-Definition.md" + }, + "IPercentOffset": { + "typeName": "IPercentOffset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-d014dbe57510" + }, + "IPlayer": { + "typeName": "IPlayer", + "reference": "type-details/IPlayer-Type-Definition.md" + }, + "IPolarCrosshairSpec": { + "typeName": "IPolarCrosshairSpec", + "reference": "type-details/IPolarCrosshairSpec-Type-Definition.md" + }, + "IRadialGradient": { + "typeName": "IRadialGradient", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-8830ca87d7a0", + "package": "@visactor/vrender-core", + "version": "1.1.12" + }, + "IRectMarkSpec": { + "typeName": "IRectMarkSpec", + "reference": "type-details/IRectMarkSpec-Type-Definition.md" + }, + "IScrollBarSpec": { + "typeName": "IScrollBarSpec", + "reference": "type-details/IScrollBarSpec-Type-Definition.md" + }, + "ISelectSpec": { + "typeName": "ISelectSpec", + "reference": "type-details/ISelectSpec-Type-Definition.md" + }, + "ISeriesSpec": { + "typeName": "ISeriesSpec", + "reference": "type-details/ISeriesSpec-Type-Definition.md" + }, + "ISeriesStyle": { + "typeName": "ISeriesStyle", + "reference": "type-details/ISeriesStyle-Type-Definition.md" + }, + "ISizeLegendSpec": { + "typeName": "ISizeLegendSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-19c6d929a8de" + }, + "IStateAnimateSpec": { + "typeName": "IStateAnimateSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-c689f8784df3" + }, + "IStateAnimationConfig": { + "typeName": "IStateAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-e4cf848bb846" + }, + "ITextFormatMethod": { + "typeName": "ITextFormatMethod", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-5a8994f84d7b" + }, + "ITextMarkSpec": { + "typeName": "ITextMarkSpec", + "reference": "type-details/ITextMarkSpec-Type-Definition.md" + }, + "ITheme": { + "typeName": "ITheme", + "reference": "type-details/ITheme-Type-Definition.md" + }, + "ITitleSpec": { + "typeName": "ITitleSpec", + "reference": "type-details/ITitleSpec-Type-Definition.md" + }, + "ITitleSpecWithoutText": { + "typeName": "ITitleSpecWithoutText", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-6d4657ffd0d7" + }, + "ITooltipSpec": { + "typeName": "ITooltipSpec", + "reference": "type-details/ITooltipSpec-Type-Definition.md" + }, + "ITotalLabelSpec": { + "typeName": "ITotalLabelSpec", + "reference": "type-details/ITotalLabelSpec-Type-Definition.md" + }, + "IVisualSpecScale": { + "typeName": "IVisualSpecScale", + "reference": "type-details/IVisualSpecScale-Type-Definition.md" + }, + "IWordCloud3dSeriesSpec": { + "typeName": "IWordCloud3dSeriesSpec", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-172112d22f72" + }, + "RegionSpec": { + "typeName": "RegionSpec", + "reference": "type-details/RegionSpec-Type-Definition.md" + }, + "TextShapeMask": { + "typeName": "TextShapeMask", + "reference": "type-details/TextShapeMask-Type-Definition.md", + "package": "@visactor/vlayouts", + "version": "1.0.28" + }, + "TypeAnimationConfig": { + "typeName": "TypeAnimationConfig", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-b4e071966992" + }, + "word": { + "typeName": "word", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-dcab00960f46" + }, + "WordcloudAppearPreset": { + "typeName": "WordcloudAppearPreset", + "reference": "type-details/AdditionalTypes-Type-Definition.md#type-230d77f59707" + }, + "WordCloudConfigType": { + "typeName": "WordCloudConfigType", + "reference": "type-details/WordCloudConfigType-Type-Definition.md" + }, + "WordCloudShapeConfigType": { + "typeName": "WordCloudShapeConfigType", + "reference": "type-details/WordCloudShapeConfigType-Type-Definition.md" + }, + "WordCloudShapeType": { + "typeName": "WordCloudShapeType", + "reference": "type-details/WordCloudShapeType-Type-Definition.md" + } + }, + "registration": [ + "registerWordCloud3dChart" + ], + "registrationNote": "宿主调用图型注册入口；该入口内部已注册 3D plugin，无需重复注册。注册代码不属于 spec。", + "initializationIncludes": [ + "register3DPlugin" + ] +} diff --git a/skills/vchart-development-assistant/scripts/generate_demo_html.py b/skills/vchart-development-assistant/scripts/generate_demo_html.py index 2cfcf763e5..08749360b9 100644 --- a/skills/vchart-development-assistant/scripts/generate_demo_html.py +++ b/skills/vchart-development-assistant/scripts/generate_demo_html.py @@ -22,6 +22,8 @@ def escape_js_string(s: str) -> str: """转义 JavaScript 字符串中的特殊字符""" s = s.replace("\\", "\\\\") s = s.replace("`", "\\`") + # 编辑器中的回调代码是文本，不能被外层模板字符串提前插值。 + s = s.replace("${", "\\${") s = s.replace("\n", "\\n") return s @@ -136,4 +138,4 @@ def main(): sys.exit(1) if __name__ == "__main__": - main() \ No newline at end of file + main() diff --git a/skills/vchart-development-assistant/tests/test_demo_generation.py b/skills/vchart-development-assistant/tests/test_demo_generation.py new file mode 100644 index 0000000000..e610d625b1 --- /dev/null +++ b/skills/vchart-development-assistant/tests/test_demo_generation.py @@ -0,0 +1,32 @@ +"""验证回调代码作为编辑器文本保存，不被 HTML 的模板字符串提前执行。""" +import importlib.util +import json +from pathlib import Path +import subprocess +import unittest + +SCRIPT = Path(__file__).resolve().parents[1] / 'scripts' / 'generate_demo_html.py' +MODULE_SPEC = importlib.util.spec_from_file_location('generate_demo_html', SCRIPT) +generator = importlib.util.module_from_spec(MODULE_SPEC) +MODULE_SPEC.loader.exec_module(generator) + + +class DemoCodeTextTest(unittest.TestCase): + def test_javascript_code_roundtrips_without_template_interpolation(self): + # JS 回调、反引号、Unicode、反斜线和潜在插值副作用都只是代码文本。 + source = ('const spec = { label: { formatMethod: (text, datum) => ' + '`${datum.day}: ${text}` } };\n' + '// 周一 ` \\ ${globalThis.executed = true}') + escaped = generator.escape_js_string(source) + script = ('globalThis.executed = false;\n' + 'const initialCode = `' + escaped + '`;\n' + 'console.log(JSON.stringify({code: initialCode, executed: globalThis.executed}));') + result = subprocess.run(['node', '-e', script], capture_output=True, text=True) + self.assertEqual(result.returncode, 0, result.stderr) + actual = json.loads(result.stdout) + self.assertEqual(actual['code'], source) + self.assertFalse(actual['executed']) + + +if __name__ == '__main__': + unittest.main() diff --git a/skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md b/skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md index eb6ca88525..1460acc013 100644 --- a/skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md +++ b/skills/vchart-development-assistant/workflows/scenario-1-diagnosis.md @@ -27,12 +27,9 @@ if (用户提供了现有 spec 配置) { ### 步骤 1a：收集信息 -请用户提供： +先复用当前请求和已有上下文中的 spec、实际数据/绑定、错误表现与期望效果。只补充会影响定位的缺项，不重复索取已提供信息，也不要求固定数量的数据样本。 -1. 完整的 VChart spec 配置代码 -2. 数据样本（至少 3-5 条） -3. 错误信息或异常表现描述 -4. 期望的正确效果 +真实数据来自可访问文件或数据源时按已知来源读取；绑定只能由宿主提供时保留契约并说明本地无法完成的验收，不以内嵌 mock 替代。 ### 步骤 2a：诊断分析 @@ -58,34 +55,24 @@ if (用户提供了现有 spec 配置) { 1. **问题类型**：布局、样式、交互、性能、数据显示等 2. **图表类型**：推断用户使用的图表类型 3. **期望效果**：用户想要达到的目标 +4. **数据来源**：当前或已有上下文的真实数据、字段、单位及可用绑定；没有原 spec 不代表没有真实数据 ### 步骤 2b：构建解决方案 -1. **Mock 数据**：根据问题场景构建合理的模拟数据（至少 5 条） -2. **生成 spec**：创建能体现解决方案的完整配置 -3. **对比方案**：如适用，提供问题现象 vs 修复后的对比 +1. **选择真实数据或演示数据**：遵循 [主文件的数据规则](../SKILL.md#数据与生成自检)。真实数据或可用绑定已知时沿用字段、记录和口径，不因为缺少 spec 就替换或增加记录；缺少影响诊断的数据/字段时询问必要信息，不伪造完整业务修复配置。 +2. **处理不可访问绑定**：保留真实绑定契约，给出有证据的配置分析或排查方向，并区分候选原因与未完成的运行验收。不能通过填 mock 报告原业务问题已修复。 +3. **按目标构建配置**：已有数据足以构建配置时，保持 HTML/spec 交付目标，生成对应完整产物；只有用户明确请求或允许教学/样式演示时才使用标注来源的 mock，没有固定最少条数。演示与实际业务修复结果分开说明。 +4. **说明诊断依据**：没有原代码或运行证据时不声称已定位原问题的根因；只说明实际完成的配置检查、候选原因和验证范围。 --- ## 输出诊断结果 -根据用户需求和对话上下文，灵活选择输出格式： +遵循 [主文件的交付选择](../SKILL.md#先确定任务与交付目标)，保留用户指定或已有的 HTML/spec/组件目标。尚未建立交付目标时，独立 spec 排错交付整合后的完整修复配置；已有 HTML 内的 spec 排错仍交付完整 HTML。只看改动时才给补丁。没有现有配置的独立演示需求按 HTML 路径处理。 -### 输出格式选择 +纯 JSON 请求不混入诊断说明或实例代码；普通对话的原因与验证说明放在配置之外。spec 交付按 [spec 流程](scenario-2-spec-generation.md)，诊断 HTML 按下方既有模板生成。不要因反馈“没显示”就把 JSON 修复变成 HTML。 -**判断依据**： - -``` -if (用户明确要求"可运行的demo" || "能直接打开的文件" || "完整的HTML") { - → 输出完整 HTML 文件 -} else if (用户询问"配置怎么写" || "代码示例" || 在讨论具体配置) { - → 输出 JavaScript spec 代码 -} else { - → 默认输出 JavaScript spec 代码（更简洁、易于集成） -} -``` - -### 格式一：输出 JavaScript 代码（推荐） +### 格式一：交付修复后的 spec 直接输出可用的 VChart spec 配置代码，便于用户复制到项目中。 @@ -118,8 +105,6 @@ const spec = { } }; -const vchart = new VChart(spec, { dom: 'chart' }); -vchart.renderAsync(); ``` ## 修复方案 @@ -140,13 +125,13 @@ const spec = { } }; -const vchart = new VChart(spec, { dom: 'chart' }); -vchart.renderAsync(); ``` ```` **描述诊断模式输出示例**： +以下是用户已允许使用 mock 的教学示例，A/B/C 为模拟类别；实际诊断应沿用用户的真实数据或绑定。 + ````markdown ## 问题诊断 @@ -177,8 +162,6 @@ const spec = { } }; -const vchart = new VChart(spec, { dom: 'chart' }); -vchart.renderAsync(); ``` ```` @@ -266,7 +249,7 @@ const problemReview = { yField: "values", // 问题行 label: { visible: true, - formatter: (d) => d.value + "%" + formatMethod: (text, datum) => datum.value + "%" } };` }; diff --git a/skills/vchart-development-assistant/workflows/scenario-1-react.md b/skills/vchart-development-assistant/workflows/scenario-1-react.md index 8fbab28200..70805844e3 100644 --- a/skills/vchart-development-assistant/workflows/scenario-1-react.md +++ b/skills/vchart-development-assistant/workflows/scenario-1-react.md @@ -464,21 +464,9 @@ const spec = { ## 输出诊断结果 -根据用户需求和对话上下文，灵活选择输出格式： +React 组件问题保留组件交付，不因新增 spec 场景就改成纯配置。遵循 [主文件的交付选择](../SKILL.md#先确定任务与交付目标)：默认提供可替换的 React 修复代码；明确要可打开演示时使用下方 React 诊断 HTML；明确只要 spec 时提取并修复配置，按 [spec 流程](scenario-2-spec-generation.md) 交付，不混入组件或实例代码。 -### 输出格式选择 - -**判断依据**： - -``` -if (用户明确要求"可运行的demo" || "能直接打开的文件" || "完整的HTML") { - → 输出完整 HTML 文件（使用 Python 脚本生成） -} else if (用户询问"配置怎么写" || "代码示例" || 在讨论具体配置) { - → 输出 React 组件代码 -} else { - → 默认输出 React 组件代码（更简洁、易于集成） -} -``` +事件、hooks 或组件生命周期问题不能只用 spec 修复；如果纯配置不足以完成要求，说明需要修改的组件部分。用户后续改动未改变交付目标时继续沿用原目标。 ### 格式一：输出 React 组件代码（推荐） diff --git a/skills/vchart-development-assistant/workflows/scenario-2-generation.md b/skills/vchart-development-assistant/workflows/scenario-2-generation.md index 0cba55bb7e..f9fa7d0504 100644 --- a/skills/vchart-development-assistant/workflows/scenario-2-generation.md +++ b/skills/vchart-development-assistant/workflows/scenario-2-generation.md @@ -1,362 +1,43 @@ -# 场景二处理流程：配置生成 +# 配置生成：共享流程 -## 适用情况 +用户从零生成图表、修改已有 spec 或询问配置写法时使用。完整生成与增量修改是既有模式，与 HTML/spec 交付目标分别判断。 -**识别信号**： +## 确定交付 -- 用户希望从 0 到 1 创建图表（提供描述/数据结构） -- 用户已有 spec，希望添加/修改某个功能点 -- 用户问"如何配置 xxx"、"怎么实现 xxx 效果" +使用 [主文件的选择规则](../SKILL.md#先确定任务与交付目标)，再只读取所需专项流程： -## 模式分类 +- [HTML 生成](scenario-2-html-generation.md)：直接打开查看、可运行 demo；没有宿主上下文的独立展示默认此路径。 +- [spec 生成](scenario-2-spec-generation.md)：配置写法、完整 spec、JSON 或已知消费配置的宿主。 +- 同时需要两者时，在生成同一份配置后分别交付；已有 React 组件需求沿用 [React 专项](scenario-1-react.md)。 -- **完整生成模式**：用户无现有 spec，需要生成完整配置 -- **增量生成模式**：用户有现有 spec，需要生成增量配置 +后续修改、诊断与还原保留当前交付目标。HTML 内的 spec 是修改输入，不重新触发 spec 交付；显式改变输出要求时按主文件规则切换。增量修改默认交付整合后的完整产物，只有明确要求片段或补丁才仅给改动。 -## 通用步骤 +## 理解目标与数据 -### 步骤 1：意图识别 +检查会影响图义的字段含义、单位、顺序、缺失和分母；不要把数字 ID 当作连续度量。使用真实数据，不默认抽样、聚合、截断或补零。功能教学可以采用明确标注的 mock 数据。 -**使用 `topkey/*.json` 将用户自然语言映射到配置项**： +数据和目标充分时直接选择图型，不逐次询问确认。只有缺失信息改变图义或交付可用性时才澄清。 -| 用户表达 | 匹配的配置项 | 来源 | -| --------------------------- | ----------------------------- | --------------------------------- | -| "加个标签" / "显示数值" | `label` | references/topkey/[type].json | -| "加条参考线" / "画条基准线" | `markLine` | references/topkey/[type].json | -| "堆叠起来" / "累加显示" | `stack: true` | references/topkey/[type].json | -| "分组对比" | `seriesField` + `xField` 数组 | references/topkey/[type].json | -| "加个图例" | `legends` | references/topkey/all_common.json | -| "鼠标悬浮提示" | `tooltip` | references/topkey/all_common.json | -| "坐标轴标题" | `axes[].title` | references/topkey/all_common.json | +## 选图与定位配置 -### 步骤 2：确定生成模式 +完整生成参考 [图型指南](../references/chart/chart-type-guide.md)，根据表达目标和数据含义选择；用户已指定图型时优先尊重要求，数据不能支持时说明原因。 -``` -if (用户提供了现有 spec) { - → 增量生成模式 -} else { - → 完整生成模式 -} -``` +增量修改以现有配置为基础，保留未请求改变的数据、组件、函数和宿主约束。按需查询： ---- +| 意图 | 配置入口 | +| --- | --- | +| 显示数值、加标签 | `label` | +| 参考线或基准线 | `markLine` | +| 累加、堆叠 | `stack` | +| 多系列对比 | `seriesField`；按图型配置分组或堆叠 | +| 图例、悬浮提示、轴标题 | `legends`、`tooltip`、`axes[].title` | -## 完整生成模式 +从 `../references/topkey/[图型].json` 或 `all_common.json` 定位配置；再查询对应 type-meta 和必要的 type-details，不凭近似属性名构造配置。 -### 步骤 2a-1：图表类型推断 +## 生成和检查 -基于用户描述和数据特征，参考 `../references/chart/chart-type-guide.md` 推断： - -| 数据特征 | 可视化目的 | 推荐类型 | -| --------------- | ----------- | ---------------------------- | -| 类目 + 数值 | 比较大小 | `bar` | -| 类目 + 数值 | 占比分布 | `pie` | -| 时间序列 + 数值 | 趋势变化 | `line` | -| 时间序列 + 数值 | 累积量感 | `area` | -| 两个数值维度 | 相关性/分布 | `scatter` | -| 多维度评分 | 综合对比 | `radar` | -| 层级数据 | 占比构成 | `treemap` / `sunburst` | -| 流向数据 | 流量分配 | `sankey` | -| 流程阶段 | 转化漏斗 | `funnel` | -| 进度数据 | 完成度 | `gauge` / `circularProgress` | - -### 步骤 2a-2：与用户确认 - -```markdown -## 图表类型推荐 - -基于您的需求，我推荐使用 **[图表类型中文名]**（`type: '[类型标识]'`） - -**推荐理由**：[简要说明] - -**是否确认？** 如需调整请告诉我。 -``` - -### 步骤 2a-3：构建完整 Spec - -**使用 `type-meta/[图表类型].json` 构建配置结构**： - -1. 从 `inheritanceTree` 获取完整的可用属性列表 -2. 填充 `required: true` 的必填字段 -3. 根据用户需求添加可选配置 -4. 对于复杂类型（`isSimple: false`），查阅 `type-details/[类型名].md` - -```javascript -const spec = { - type: '[图表类型]', - data: [ - { - id: 'dataId', - values: [ - /* 用户数据 */ - ] - } - ], - // 必填字段（从 type-meta 获取） - [requiredField]: [value], - - // 用户需求的配置项 - [配置项]: { - // 从 type-details 获取类型定义 - } -}; - -const vchart = new VChart(spec, { dom: 'container' }); -vchart.renderSync(); -``` - -### 步骤 2a-4：输出配置结果 - -根据用户需求和对话上下文，灵活选择输出格式： - -#### 输出格式选择 - -``` -if (用户明确要求"可运行的demo" || "能直接打开的文件" || "完整的HTML") { - → 输出完整 HTML 文件（使用 Python 脚本生成） -} else if (用户询问"配置怎么写" || "代码示例" || 在讨论具体配置) { - → 输出 JavaScript spec 代码 -} else { - → 默认输出 JavaScript spec 代码（更简洁、易于集成） -} -``` - -#### 格式一：输出 JavaScript 代码（推荐） - -直接输出可用的 VChart spec 配置代码。 - -**输出示例**： - -````markdown -## 图表生成结果 - -基于您的需求，生成了以下 [图表类型] 配置。 - -**配置说明**： - -- [关键配置点说明] - -**完整代码**： - -```javascript -const spec = { - type: 'bar', - data: { - values: [ - { category: 'A', value: 10 }, - { category: 'B', value: 20 }, - { category: 'C', value: 15 } - ] - }, - xField: 'category', - yField: 'value', - label: { - visible: true, - position: 'top' - } -}; - -const vchart = new VChart(spec, { dom: 'chart' }); -vchart.renderAsync(); -``` -```` - -#### 格式二：输出完整 HTML（按需） - -当用户需要完整的可运行演示时，使用 `template/demo.html` + Python 脚本生成。 - -```` - ---- - -## 增量生成模式 - -### 步骤 2b-1：定位配置项 - -**根据用户意图，使用 topkey 定位配置项名称**： - -```javascript -// 用户说："我想给柱子加个标签" -// references/topkey/bar.json 中找到： -{ - "label": { - "key": "label", - "oneDesc": "标签相关配置,包括跟标签相关的引导线配置" - } -} -// → 配置项为 label -```` - -### 步骤 2b-2：查询类型定义 - -**使用 `type-details/[类型名]-Type-Definition.md` 获取详细配置**： - -```javascript -// 查询 type-details/ILabelSpec-Type-Definition.md -// 获取完整的 ILabelSpec 接口定义 -``` - -### 步骤 2b-3：输出配置结果 - -根据用户需求和对话上下文，灵活选择输出格式（同完整生成模式）。 - -**情况 A：用户提供了完整 spec** - -- 输出增量配置的代码片段 -- 或输出整合后的完整 spec（按需使用 HTML 格式） - -**情况 B：用户只描述功能需求，未提供 spec** - -- **Mock 数据**：构建合理的模拟数据（至少 5 条） -- **完整 spec**：生成包含该功能的完整图表配置 -- 默认输出 JavaScript 代码，按需输出 HTML - -#### 使用 Python 脚本生成示例 HTML（按需） - -当用户需要完整的可运行演示时： - -推荐使用 `scripts/generate_demo_html.py` 脚本，通过 spec 文件生成可运行 HTML。 - -> 💡 **参数详情**：参见 [脚本参数参考](../references/SCRIPT_PARAMS_REFERENCE.md#generate_demo_htmlpy) - -#### 脚本使用示例 - -**最小示例**（使用默认参数）： - -```bash -python3 scripts/generate_demo_html.py --spec-file spec.js -``` - -**完整示例**（自定义所有参数）： - -```bash -python3 scripts/generate_demo_html.py \ - --title "功能实现示例" \ - --desc "基于需求生成的配置方案" \ - --feature "实现了标签展示与 tooltip 交互" \ - --tips "可调整 xField/yField、label、tooltip 与配色方案" \ - --spec-file spec.js \ - --output output/demo.html -``` - -#### 主要参数 - -- `--spec-file`：包含完整 VChart spec 配置的 JS 文件 -- `--feature`：主要功能说明（描述图表实现的核心特性） -- `--tips`：编辑提示（指导用户可调整的配置项） -- `--output`：输出 HTML 文件路径（可选，默认 `output/demo.html`） - -#### Spec 文件结构 - -spec 文件应包含完整的 VChart 配置代码（JavaScript 格式）： - -```javascript -const spec = { - type: 'bar', - data: { - values: [ - { category: 'A', value: 10 }, - { category: 'B', value: 20 }, - { category: 'C', value: 15 }, - { category: 'D', value: 12 }, - { category: 'E', value: 18 } - ] - }, - xField: 'category', - yField: 'value', - label: { - visible: true, - style: { fill: '#333' } - }, - tooltip: { - visible: true - } -}; -``` - -#### 实际使用示例 - -**步骤 1：创建 spec 文件 `spec.js`** - -```javascript -const spec = { - type: 'bar', - data: { - values: [ - { category: 'A', value: 10 }, - { category: 'B', value: 20 }, - { category: 'C', value: 15 }, - { category: 'D', value: 12 }, - { category: 'E', value: 18 } - ] - }, - xField: 'category', - yField: 'value', - label: { visible: true } -}; -``` - -**步骤 2：运行脚本生成 HTML** - -```bash -python3 scripts/generate_demo_html.py \ - --title "柱状图标签功能示例" \ - --desc "展示如何配置数据标签" \ - --feature "在柱子上显示数值标签" \ - --tips "可修改 label.position 或 label.style 调整样式" \ - --spec-file spec.js \ - --output output/bar_label_demo.html -``` - -**步骤 3：查看生成结果** - -在浏览器中打开 `output/bar_label_demo.html` 查看可运行示例。 - -**输出格式**： - -````markdown -## 功能实现：[功能名称] - -**配置说明**： - -- `[属性1]`：[类型] - [说明] -- `[属性2]`：[类型] - [说明] - -**可运行示例**： - -将以下内容保存为 `.html`，直接在浏览器打开： - -```html -[使用 template/demo.html 填充后的完整 HTML] -``` -```` - -## 生成模式选择指南 - -### 完整生成模式适用场景 - -- 用户是新手，没有现有 spec -- 用户提供需求描述和数据，希望从零开始 -- 用户说"帮我做一个 xxx 图表" - -### 增量生成模式适用场景 - -- 用户已有基础图表配置 -- 用户希望在现有图表上添加特定功能 -- 用户提供当前 spec，询问如何修改 - ---- - -## React 场景补充 - -- 若用户明确使用 React-VChart，输出时应提供 React 代码或指向 `template/diagnosis-react.html` 的可运行 HTML，说明依赖安装（`npm i @visactor/react-vchart @visactor/vchart`）。 -- 如用户不接受纯 JS 示例，可同时给出 React 版本与 JS 版本，标注差异。 - ---- - -## 相关资源 - -- [配置项索引](../references/topkey/) - 快速查找配置项 -- [示例库](../references/examples/) - 常用图表完整示例 -- [类型详情](../references/type-details/) - 详细的类型定义 -- [图表类型指南](../references/chart/chart-type-guide.md) - 各类图表特性参考 +1. 根据实际图型配置数据、字段映射和必需属性。VChart 支持的数据对象/数组写法均可，不机械套用唯一数据结构。 +2. 对复杂属性或函数按需查类型签名；例如标签回调用 `formatMethod`，`formatter` 是模板字符串能力，不能混用。 +3. 声明式交互直接写 spec；实例 API 只在用户需要应用代码时追加，遵循主文件的交互边界。 +4. 检查字段是否存在、数据是否保留、配置是否符合已知版本/宿主要求；发现问题直接修正。 +5. 进入所选交付流程。能渲染时检查实际数据和图元，不能时如实说明；JSON 解析不能代替渲染检查，本期不使用 schema。 diff --git a/skills/vchart-development-assistant/workflows/scenario-2-html-generation.md b/skills/vchart-development-assistant/workflows/scenario-2-html-generation.md new file mode 100644 index 0000000000..0df9477b35 --- /dev/null +++ b/skills/vchart-development-assistant/workflows/scenario-2-html-generation.md @@ -0,0 +1,47 @@ +# HTML 生成 + +用于独立展示、可打开查看的 HTML 和可运行 demo。复用 [共享生成流程](scenario-2-generation.md) 的配置，不重新定义选图规则。 + +## 输入与产物 + +表达目标与数据充分时直接生成。独立页面默认原生 JS，不机械追问框架；已有 React 上下文按 [专项流程](scenario-1-react.md) 交付组件代码，明确要可运行页面时再提供 React 诊断 HTML。 + +最终 HTML 包含依赖引用、完整 spec、容器和标准实例创建。外部按钮、点击处理、导出等应用逻辑只按需求添加；模板本身的编辑演示保留，不能仅给 spec 后声称已交付 HTML。 + +## 使用既有生成器 + +先保存实际生成的配置为 JS 文件，格式为 `const spec = {...};`。只包含配置声明，不在该输入文件里放 `new VChart`、render 或事件绑定，因为演示模板负责实例创建。 + +脚本的模板路径相对工作目录；从实际技能目录运行： + +```sh +cd /实际技能目录 +python3 scripts/generate_demo_html.py \ + --title "周数据比较" \ + --desc "比较四天的实际数值" \ + --feature "展示周一至周四的数值" \ + --tips "可编辑配置调整图表" \ + --spec-file /实际输出目录/spec.js \ + --output /实际输出目录/chart.html +``` + +参数见 [脚本参考](../references/SCRIPT_PARAMS_REFERENCE.md)。生成器用于配置演示，不会把输入文件里的外部事件代码自动绑定到模板创建的实例；应用 API 需求应基于生成页面和其真实实例按文档接入，不另建第二个图表。 + +脚本无法使用时可按 `../template/demo.html` 生成完整页面。正确替换占位符并检查依赖；不是只返回被截断的 HTML 片段。 + +## 按需交互 + +图例、tooltip 和标签等声明式能力直接使用 spec。点击读取 datum、外部状态联动、实例数据更新等参考主文件的 API 导航，接到实际实例。 + +仅请求 spec 的任务不能因交互而自动转为 HTML；两类产物同时请求时，页面使用所交付的同一份 spec，应用事件代码单独存在于页面。 + +## 验收与交付 + +实际打开生成页面，检查： + +- 用户数据、字段、单位和顺序一致；有真实数据图元，不只看文件或 canvas 是否存在。 +- 可见效果对应表达目标；回调标签、tooltip 等内容正确。 +- 有明确交互需求时，执行真实动作并检查 datum、筛选结果或状态变化，不能只记录“点击成功”。 +- 记录实际运行环境与版本证据。CDN 或浏览器不可用时说明未完成的渲染验收，不把生成成功写成图表验证通过。 + +给出完整 HTML 文件链接及必要用途说明。用户同时要 spec 时附配置产物；只需要 HTML 时无需再强制交付一组额外文件。诊断或图片还原沿用专项解释要求。 diff --git a/skills/vchart-development-assistant/workflows/scenario-2-spec-generation.md b/skills/vchart-development-assistant/workflows/scenario-2-spec-generation.md new file mode 100644 index 0000000000..d59fb94c12 --- /dev/null +++ b/skills/vchart-development-assistant/workflows/scenario-2-spec-generation.md @@ -0,0 +1,50 @@ +# spec 生成 + +用于用户需要完整 VChart 配置、机器消费的 JSON，或已有宿主负责渲染的场景。复用 [共享生成流程](scenario-2-generation.md)，不要求用户提供 JS/React 技术栈。 + +## 目标与已知约束 + +使用表达目标、真实数据、已知图型及已有上下文。只检查会影响当前产物的宿主约束：版本、支持图型、尺寸、JSON/JS、回调和外部资源。未知不代表完全支持或完全禁止，不为填满检查表逐项追问。 + +上下文已说明宿主接收配置时，后续“用合适图表展示”继续交付 spec。新增样式、切换图型、修复报错不改变交付目标；只有用户明确要求 HTML、组件或其他产物时才转换。 + +## 完整配置与增量修改 + +交付包含实际数据或明确可用数据绑定、图型必需字段和用户要求配置的完整 spec。柱图常用 xField/yField，饼图常用 categoryField/valueField，不能给所有图型套用统一字段清单。 + +修改已有 spec 时保留未请求变更的部分并返回整合后的完整配置。只有用户明确要求“只给改动”“补丁”“片段”时才返回增量；“加标签”本身不代表要求补丁。 + +配置不包含 HTML、实例创建、render 调用、外部事件绑定、飞书卡片外壳或传输代码。宿主适配由调用方负责，不能把特定宿主的包装当作 VChart spec。 + +## JSON 与 JS + +选择顺序：用户要求 → 已知宿主契约 → 已有配置格式。均未指定时，可序列化配置采用 JSON；实际需要且环境允许函数时采用 JS spec，并说明格式要求。 + +- JSON：只使用 JSON 值。用标准解析器检查，不含注释、函数、undefined、NaN/Infinity。数据中的 0、null、Unicode 和顺序保留。 +- JS：保留文档化回调与其签名，不经 JSON 序列化往返。可交付 `const spec = {...};` 配置声明，但不附应用实例代码。 +- `formatter` 模板字符串和 `formatMethod` 函数按 [标签类型](../references/type-details/ILabelSpec-Type-Definition.md) 区分；先查询声明式能力，不把所有格式化需求判成函数。 +- 纯 JSON 宿主不能携带实例事件、任意回调或业务副作用。无法声明式实现时说明限制与宿主所需能力；不删除函数后声称完成，也不擅自转为 HTML。 + +完整 JSON 和回调示例见 [示例说明](../examples/spec-generation/README.md)。示例数据只供参考，不能替代真实任务数据。 + +## 交互边界 + +tooltip、图例、标签及其他支持的声明式交互可包含在 spec 内。外部按钮、点击发业务请求、实例更新等属于应用 API，不混入纯配置。用户需要 spec 加应用接入说明时分别交付；只要 JSON 时不能混入这些说明。 + +## 验证 + +根据可用环境完成并区分： + +1. 数据/配置检查：字段实际存在，数据绑定可用，类型和必要配置正确；单位、顺序、缺失、零和分母未被静默改变。 +2. 格式检查：JSON 使用标准解析器；JS 对照函数签名并检查实际代码。本期不采用 schema 校验。 +3. 真实渲染：可用时用交付的同一份配置验证数据图元与效果。临时 JS 声明可以包装 JSON，临时 HTML 可复用既有演示工具；它们只用于验证，不取代 spec 产物。 + +数据引用需要宿主提供时，在可用的实际绑定环境验收；环境缺失则说明限制，不填 mock 数据伪装成功。浏览器验证记录其实际环境，不能据此声称飞书或其他宿主验证通过。 + +发现字段或配置问题直接修正并重检。没有浏览器时仍可交付完成自检的配置，明确未执行渲染，不将解析成功写成渲染通过。 + +## 交付 + +机器消费的“只返回 JSON”只返回配置本身，不加 Markdown 围栏、说明、自定义检查字段或实例代码。普通对话可交付 `.json`/`.js` 文件和简短说明，验证证据与配置分开。 + +同时要求 HTML 预览时交付配置与使用它的页面。后续调整两者使用同一配置，不维护两份不同数据或字段映射。 diff --git a/skills/vchart-development-assistant/workflows/scenario-3-image-replication.md b/skills/vchart-development-assistant/workflows/scenario-3-image-replication.md index b133fb3084..66617ff73d 100644 --- a/skills/vchart-development-assistant/workflows/scenario-3-image-replication.md +++ b/skills/vchart-development-assistant/workflows/scenario-3-image-replication.md @@ -44,41 +44,17 @@ - 辅助图形 ``` -### 步骤 2：与用户确认 +### 步骤 2：处理必要的不确定性 -```markdown -## 图表分析结果 - -根据您提供的图片，我识别到以下信息： - -**图表类型**：[识别的类型] - -**数据结构**： - -- X 轴：[类目/时间/数值]，示例值：[从图中读取的示例] -- Y 轴：[数值范围] -- 系列：[系列数量及含义] - -**视觉特征**： - -- [颜色/布局/样式等描述] - -**组件配置**： +图片、真实数据和要求充分时直接还原，不逐项确认图型和样式。只澄清会改变图义、真实数据口径或还原目标的信息。 -- [识别到的组件列表] - -**请确认**： - -1. 以上分析是否准确？ -2. 请提供实际数据（如有），或确认使用模拟数据 -3. 是否有其他细节需要补充？ -``` +从清晰标签读出的数值与估算值需要区分；无法读取的真实业务值不能按柱高猜测后当作真值交付。仅需样式演示且允许模拟数据时明确标注 mock，保留实际数据要求及用户指定的 HTML/spec 交付目标。 ### 步骤 3：生成配置 -确认后，按照以下优先级匹配配置： +信息充分后，按照以下优先级匹配配置： -1. **查找相似示例**：在 `../examples/` 中查找最接近的示例作为基础 +1. **查找相似示例**：在 `../references/examples/` 中查找最接近的示例作为基础 2. **构建 spec**： - 使用 `type-meta/[图表类型].json` 确定可用属性 - 使用 `type-details/*.md` 获取样式配置的详细类型 @@ -90,21 +66,11 @@ ### 步骤 4：输出还原结果 -根据用户需求和对话上下文，灵活选择输出格式： - -#### 输出格式选择 +遵循 [主文件的交付选择](../SKILL.md#先确定任务与交付目标)。明确只要 spec 或已有宿主消费配置时使用 [spec 流程](scenario-2-spec-generation.md)；独立可查看还原默认使用 [HTML 流程](scenario-2-html-generation.md)。同时要两者时 HTML 使用所交付的同一份 spec。 -``` -if (用户明确要求"可运行的demo" || "能直接打开的文件" || "完整的HTML") { - → 输出完整 HTML 文件（使用 Python 脚本生成） -} else if (用户询问"配置怎么写" || "代码示例" || 在讨论具体配置) { - → 输出 JavaScript spec 代码 -} else { - → 默认输出 JavaScript spec 代码（更简洁、易于集成） -} -``` +还原范围、读图不确定性和验证证据与配置分开；纯 JSON 要求不混入这些说明。后续调整或诊断保留原交付目标。 -#### 格式一：输出 JavaScript 代码（推荐） +#### 格式一：输出还原后的 spec 直接输出基于图片分析的 VChart spec 配置代码。 @@ -147,8 +113,6 @@ const spec = { } }; -const vchart = new VChart(spec, { dom: 'chart' }); -vchart.renderAsync(); ``` ```` @@ -311,7 +275,7 @@ python3 scripts/generate_demo_html.py \ 当用户未提供真实数据时： 1. **从图片读取**：尽量从坐标轴、标签中读取数值 -2. **合理估算**：根据图形比例估算数据大小 +2. **明确估算边界**：仅样式演示且允许模拟数据时按图形比例构造 mock，不把估算当作真实业务数值 3. **保持趋势**：确保模拟数据体现图片中的趋势特征 4. **数量匹配**：模拟数据的数量与图片中的数据点数量一致 @@ -476,7 +440,7 @@ Stop 2: #69C0FF at 100% - 图表区域：[宽] x [高] - 内边距：[值] -**请确认以上提取的样式值是否准确？** +存在影响还原目标的歧义时再确认；已取得精确样式且数据充分时直接生成。 ``` #### 步骤 F3：生成精确配置