diff --git a/packages/g6/src/runtime/graph.ts b/packages/g6/src/runtime/graph.ts index b51a70975fc..1eef612e4ac 100644 --- a/packages/g6/src/runtime/graph.ts +++ b/packages/g6/src/runtime/graph.ts @@ -424,7 +424,7 @@ export class Graph extends EventEmitter { * 获取插件实例 * * Get plugin instance - * @param key - 插件 key | plugin key + * @param key - 插件 key(在配置 plugin 时需要手动传入指定) | plugin key(need to be specified manually when configuring plugin) * @returns 插件实例 | plugin instance * @remarks * 一些插件提供了 API 方法可供调用,例如全屏插件可以调用 `request` 和 `exit` 方法来请求和退出全屏 diff --git a/packages/site/examples/plugin/minimap/demo/basic.js b/packages/site/examples/plugin/minimap/demo/basic.js new file mode 100644 index 00000000000..70b326ecd54 --- /dev/null +++ b/packages/site/examples/plugin/minimap/demo/basic.js @@ -0,0 +1,22 @@ +import { Graph } from '@antv/g6'; + +const graph = new Graph({ + container: 'container', + data: { nodes: Array.from({ length: 20 }).map((_, i) => ({ id: `node${i}` })) }, + behaviors: ['drag-canvas', 'zoom-canvas', 'drag-element'], + plugins: [ + { + type: 'minimap', + size: [240, 160], + }, + ], + node: { + palette: 'spectral', + }, + layout: { + type: 'circular', + }, + autoFit: 'view', +}); + +graph.render(); diff --git a/packages/site/examples/plugin/minimap/demo/meta.json b/packages/site/examples/plugin/minimap/demo/meta.json new file mode 100644 index 00000000000..99f333624c0 --- /dev/null +++ b/packages/site/examples/plugin/minimap/demo/meta.json @@ -0,0 +1,16 @@ +{ + "title": { + "zh": "中文分类", + "en": "Category" + }, + "demos": [ + { + "filename": "basic.js", + "title": { + "zh": "小地图", + "en": "Minimap" + }, + "screenshot": "https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*asv5Roh25YkAAAAAAAAAAAAADmJ7AQ/original" + } + ] +} diff --git a/packages/site/examples/plugin/minimap/index.en.md b/packages/site/examples/plugin/minimap/index.en.md new file mode 100644 index 00000000000..3d3f836c576 --- /dev/null +++ b/packages/site/examples/plugin/minimap/index.en.md @@ -0,0 +1,3 @@ +--- +title: Minimap +--- diff --git a/packages/site/examples/plugin/minimap/index.zh.md b/packages/site/examples/plugin/minimap/index.zh.md new file mode 100644 index 00000000000..6b2a5cb458a --- /dev/null +++ b/packages/site/examples/plugin/minimap/index.zh.md @@ -0,0 +1,3 @@ +--- +title: Minimap 小地图 +---