logo

G

  • 教程
  • API
  • 示例
  • 插件
  • 所有产品antv logo arrow
  • 6.1.26
  • 画布
    • 简介
    • 初始化参数
    • 场景图能力与生命周期
    • 内置对象
    • 坐标系
    • 画布事件
    • OffscreenCanvas 和服务端渲染
    • CustomElementRegistry
    • 常见问题
  • 渲染器
    • 简介
    • Canvas 渲染器
    • Canvaskit 渲染器
    • SVG 渲染器
    • WebGL 渲染器
    • WebGPU 渲染器
    • 自定义渲染器
  • 相机
    • 简介
    • 相机参数
    • 相机动作
    • 相机动画
  • 事件
    • 简介
    • 事件对象
    • 手势和拖放
    • 常见问题
  • 动画
    • Web Animations API
    • Lottie 动画
  • 基础图形
    • 基础概念
    • DisplayObject
    • Group 图形分组
    • Text 文本
    • Circle 圆形
    • Ellipse 椭圆
    • Rect 矩形
    • Image 图片
    • Line 直线
    • Polygon 多边形
    • Polyline 折线
    • Path 路径
    • HTML 内容
  • 样式系统
    • 简介
    • 继承机制
    • CSS Typed OM
    • CSS Properties & Values API
    • CSS Layout API
    • Pattern
    • Gradient
  • 三维世界
    • 材质
    • 几何
    • 光源
    • Mesh
    • 雾
    • 交互
  • 内置对象
    • EventTarget
    • Node
    • Element
    • Document
    • MutationObserver
    • 工具方法
  • GPGPU
    • 简介
    • 编程模型
    • Kernel API
    • 经典 GPGPU 的实现原理
    • webgpu-graph
  • 声明式用法
    • 使用 Web Components
  • 开发调试工具
    • G 开发者工具
    • 内置的渲染统计信息
    • 第三方开发调试工具

场景图能力与生命周期

上一篇
初始化参数
下一篇
内置对象

资源

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

添加/删除场景图节点

由于画布并没有继承 Node,因此它本身并不具备节点操作能力。但我们增加了一些快捷方式,以下节点操作本质上都是在根节点上完成的,例如以下两种写法等价:

canvas.appendChild(circle);
canvas.document.documentElement.appendChild(circle);

appendChild

向画布中添加待渲染对象。如果该对象有子节点也会一并加入。

const circle = new Circle({ style: { r: 10 } });
canvas.appendChild(circle);
// or canvas.document.documentElement.appendChild(circle);

方法签名如下:

appendChild(object: DisplayObject): DisplayObject;

removeChild

从画布中移除对象。如果该对象有子节点也会一并移除。

canvas.removeChild(circle);
// or canvas.document.documentElement.removeChild(circle);

方法签名如下:

removeChild(object: DisplayObject): DisplayObject;

为了和 DOM API 保持一致,仅移除对象并不会销毁。如果要销毁需要调用 destroy()。

removeChildren

移除画布中所有对象。

canvas.removeChildren();
// or canvas.document.documentElement.removeChildren();

destroyChildren

移除并销毁画布中所有对象。

canvas.destroyChildren();

生命周期

在实例化时会进行初始化逻辑,随后可调用以下生命周期方法。

ready

初始化工作完成后,返回一个 Promise,等价于监听 CanvasEvent.READY 事件:

await canvas.ready;
// 等价于
import { CanvasEvent } from '@antv/g';
canvas.addEventListener(CanvasEvent.READY, () => {});

render

渲染画布,由于渲染器默认开启了自动渲染,大多数情况下不需要手动调用。但有些场景需要手动控制渲染时机,此时可以进行按需渲染 示例:

// 关闭自动渲染
const webglRenderer = new WebGLRenderer({
enableAutoRendering: false,
});
canvas.render();

destroy(destroyScenegraph = true)

销毁画布,依次执行以下销毁逻辑:

  • 如果开启了自动渲染,停止主渲染循环
  • 将整个场景图从画布中移除,如果设置了 destroyScenegraph 还会销毁整个场景图
  • 销毁渲染上下文
// 仅销毁画布,保留场景图
canvas.destroy();
// 一并销毁画布中的场景图
canvas.destroy(true);