抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 交互反馈
  • 导航栏
  • 菜单
  • tt.getCustomButtonBoundingClientRect
  • tt.getMenuButtonBoundingClientRect
  • 动画
  • 页面位置
  • 滑动返回
  • 下拉刷新
  • 键盘
  • TabBar
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • 生活服务(即将废弃)
  • tt.getCustomButtonBoundingClientRect
    收藏
    我的收藏

    基础库 2.42.0 开始支持本方法,低版本需做兼容处理,这是一个同步方法。
    获取自定义导航栏下不可改变的元素(左上角 logo 或 返回按钮 以及 右上角反馈、更多、关闭按钮)的位置信息。坐标信息以屏幕左上角为原点。
    建议在 Page.onReady 或者更后的时机调用,调用过早可能出现获取的宽高等位置信息不准确。

    语法

    tt.getCustomButtonBoundingClientRect(options)

    参数说明

    options

    为 object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    measurementUnit
    string
    px
    否
    设置返回值的单位,支持px、rpx
    3.38.0

    返回值

    返回 object 类型数据,属性如下:
    属性
    类型
    说明
    最低支持版本
    leftIcon
    object | undefined
    左上角 logo/返回的位置信息,不存在或获取时机太早时为undefined
    2.42.0
    capsule
    object | undefined
    右上角反馈+more+close 的位置信息,不存在或获取时机太早时为undefined
    2.42.0
    customNavigation
    object
    自定义导航栏可绘制区域
    3.38.0
    leftIcon 的属性如下:
    属性名
    类型
    说明
    最低支持版本
    width
    number
    宽度
    2.42.0
    height
    number
    高度
    2.42.0
    top
    number
    上边界坐标
    2.42.0
    right
    number
    右边界坐标
    2.42.0
    bottom
    number
    下边界坐标
    2.42.0
    left
    number
    左边界坐标
    2.42.0
    capsule 的属性如下:
    属性名
    类型
    说明
    最低支持版本
    width
    number
    宽度
    2.42.0
    height
    number
    高度
    2.42.0
    top
    number
    上边界坐标
    2.42.0
    right
    number
    右边界坐标
    2.42.0
    bottom
    number
    下边界坐标
    2.42.0
    left
    number
    左边界坐标
    2.42.0
    customNavigation 的属性如下:
    属性名
    类型
    说明
    最低支持版本
    width
    number
    自定义导航栏可绘制区域的宽度
    3.38.0
    height
    number
    自定义导航栏可绘制区域的高度
    3.38.0
    marginLeft
    number
    自定义导航栏可绘制区域距离可使用窗口的左边距
    3.38.0
    marginRight
    number
    自定义导航栏可绘制区域距离可使用窗口的右边距
    3.38.0
    marginTop
    number
    自定义导航栏可绘制区域距离可使用窗口的上边距
    3.38.0
    centerLineToTop
    ​
    number
    中线和顶部的距离
    3.38.0

    扫码体验

    ​

    代码示例

    Bug & Tip

      •仅在自定义导航栏下调用该 api 才返回真实数据。默认导航栏下调用该 api 返回调用失败。
      •仅在真实显示的时候才返回数据(如左上角无组件,则不返回 leftIcon 相关数据)。
      •x 分屏情况下返回 x 分屏还原 100% 全屏时候的样式布局信息。