Module: zrender/ZRender

zrender~ zrender/ZRender

new require("zrender/ZRender")(id, dom){ZRender}

zrender.js, line 127

ZRender接口类,对外可用的所有接口都在这里 非get接口统一返回支持链式调用

Name Type Description
id string

唯一标识

dom HTMLElement

dom对象,不帮你做document.getElementById

Members

idstring

实例 id

Methods

addElement(el)

zrender.js, line 242

添加元素

Name Type Description
el string | module:zrender/Group | module:zrender/shape/Base

addGroup(group)

zrender.js, line 191

添加组到根节点

Name Type Description
group module:zrender/Group
Deprecated
  • Use module:zrender/ZRender.prototype.addElement instead

    addHoverShape(shape)

    zrender.js, line 301

    添加额外高亮层显示,仅提供添加方法,每次刷新后高亮层图形均被清空

    Name Type Description
    shape Object

    形状对象

    addShape(shape)

    zrender.js, line 181

    添加图形形状到根节点

    Name Type Description
    shape module:zrender/shape/Base

    形状对象,可用属性全集,详见各shape

    Deprecated
    • Use module:zrender/ZRender.prototype.addElement instead

      animate(el, path, loop){module:zrender/animation/Animation~Animator}

      zrender.js, line 377

      动画

      Name Type Description
      el string | module:zrender/Group | module:zrender/shape/Base

      动画对象

      path string

      需要添加动画的属性获取路径,可以通过a.b.c来获取深层的属性

      loop boolean optional

      动画是否循环

      clear()

      zrender.js, line 552

      清除当前ZRender下所有类图的数据和显示,clear后MVC和已绑定事件均还存在在,ZRender可用

      clearAnimation()

      zrender.js, line 456

      停止所有动画

      delElement(el)

      zrender.js, line 252

      删除元素

      Name Type Description
      el string | module:zrender/Group | module:zrender/shape/Base

      delGroup(groupId)

      zrender.js, line 211

      从根节点删除组

      Name Type Description
      groupId string
      Deprecated
      • Use module:zrender/ZRender.prototype.delElement instead

        delShape(shapeId)

        zrender.js, line 201

        从根节点删除图形形状

        Name Type Description
        shapeId string

        形状对象唯一标识

        Deprecated
        • Use module:zrender/ZRender.prototype.delElement instead

          dispose()

          zrender.js, line 561

          释放当前ZR实例(删除包括dom,数据、显示和事件绑定),dispose后ZR不可用

          getHeight()

          zrender.js, line 489

          获取视图高度

          getId(){string}

          zrender.js, line 172

          获取实例唯一标识

          getWidth()

          zrender.js, line 482

          获取视图宽度

          hideLoading()

          zrender.js, line 474

          loading结束

          modElement(el, params)

          zrender.js, line 269

          修改元素, 主要标记图形或者组需要在下一帧刷新。 第二个参数为需要覆盖到元素上的参数,不建议使用。

          Name Type Description
          el string | module:zrender/Group | module:zrender/shape/Base
          params Object optional
          Example
          el.style.color = 'red';
              el.position = [10, 10];
              zr.modElement(el);

          modGroup(groupId, group)

          zrender.js, line 233

          修改组

          Name Type Description
          groupId string
          group Object
          Deprecated
          • Use module:zrender/ZRender.prototype.modElement instead

            modLayer(zLevel, config)

            zrender.js, line 290

            修改指定zlevel的绘制配置项

            Name Type Description
            zLevel string
            config Object

            配置对象

            Name Type Default Description
            clearColor string 0 optional

            每次清空画布的颜色

            motionBlur string false optional

            是否开启动态模糊

            lastFrameAlpha number 0.7 optional

            在开启动态模糊的时候使用,与上一帧混合的alpha值,值越大尾迹越明显

            position Array.<number> optional

            层的平移

            rotation Array.<number> optional

            层的旋转

            scale Array.<number> optional

            层的缩放

            zoomable boolean false optional

            层是否支持鼠标缩放操作

            panable boolean false optional

            层是否支持鼠标平移操作

            modShape(shapeId, shape)

            zrender.js, line 222

            修改图形形状

            Name Type Description
            shapeId string

            形状对象唯一标识

            shape Object

            形状对象

            Deprecated
            • Use module:zrender/ZRender.prototype.modElement instead

              on(eventName, eventHandler, context)

              zrender.js, line 521

              事件绑定

              Name Type Description
              eventName string

              事件名称

              eventHandler function

              响应函数

              context Object optional

              响应函数

              refresh(callback)

              zrender.js, line 322

              视图更新

              Name Type Description
              callback function

              视图更新后回调函数

              refreshHover(callback)

              zrender.js, line 340

              绘制高亮层

              Name Type Description
              callback function

              视图更新后回调函数

              refreshNextFrame()

              zrender.js, line 331

              标记视图在浏览器下一帧需要绘制

              refreshShapes(shapeList, callback)

              zrender.js, line 351

              视图更新

              Name Type Description
              shapeList Array.<module:zrender/shape/Base>

              需要更新的图形列表

              callback function

              视图更新后回调函数

              render(callback)

              zrender.js, line 311

              渲染

              Name Type Description
              callback function

              渲染结束后回调函数

              resize()

              zrender.js, line 359

              调整视图大小

              shapeToImage(e, width, height)

              zrender.js, line 509

              将常规shape转成image shape

              Name Type Description
              e module:zrender/shape/Base
              width number
              height number

              showLoading(loadingEffect)

              zrender.js, line 466

              loading显示

              Name Type Description
              loadingEffect Object optional

              loading效果对象

              stopAnimation(el)

              zrender.js, line 441

              停止动画对象的动画

              Name Type Description
              el string | module:zrender/Group | module:zrender/shape/Base

              toDataURL(type, backgroundColor){string}

              zrender.js, line 499

              图像导出

              Name Type Default Description
              type string
              backgroundColor string '#fff' optional

              背景色

              Returns:
              url

              trigger(eventName, event)

              zrender.js, line 543

              事件触发

              Name Type Description
              eventName string

              事件名称,resize,hover,drag,etc

              event event optional

              event dom事件对象

              un(eventName, eventHandler)

              zrender.js, line 532

              事件解绑定,参数为空则解绑所有自定义事件

              Name Type Description
              eventName string

              事件名称

              eventHandler function

              响应函数