## uni.createSelectorQuery() 返回一个 ``SelectorQuery`` 对象实例。可以在这个实例上使用 ``select`` 等方法选择节点,并使用 ``boundingClientRect`` 等方法选择需要查询的信息。 **Tips:** * 使用 `uni.createSelectorQuery()` 需要在生命周期 `mounted` 后进行调用。 * 自定义组件编译模式(默认模式),需要使用到 `selectorQuery.in` 方法。 ## SelectorQuery 查询节点信息的对象 ### selectorQuery.in(component) 将选择器的选取范围更改为自定义组件 ``component`` 内,返回一个 ``SelectorQuery`` 对象实例。(初始时,选择器仅选取页面范围的节点,不会选取任何自定义组件中的节点)。 **代码示例** ```javascript const query = uni.createSelectorQuery().in(this); query.select('#id').boundingClientRect(data => { console.log("得到布局位置信息" + JSON.stringify(data)); console.log("节点离页面顶部的距离为" + data.top); }).exec(); ``` ### selectorQuery.select(selector) 在当前页面下选择第一个匹配选择器 ``selector`` 的节点,返回一个 ``NodesRef`` 对象实例,可以用于获取节点信息。 **selector 说明:** ``selector`` 类似于 CSS 的选择器,但仅支持下列语法。 - ID选择器:``#the-id`` - class选择器(可以连续指定多个):``.a-class.another-class`` - 子元素选择器:``.the-parent > .the-child`` - 后代选择器:``.the-ancestor .the-descendant`` - 跨自定义组件的后代选择器:``.the-ancestor >>> .the-descendant`` - 多选择器的并集:``#a-node, .some-other-nodes`` ### selectorQuery.selectAll(selector) 在当前页面下选择匹配选择器 ``selector`` 的所有节点,返回一个 ``NodesRef`` 对象实例,可以用于获取节点信息。 ### selectorQuery.selectViewport() 选择显示区域,可用于获取显示区域的尺寸、滚动位置等信息,返回一个 ``NodesRef`` 对象实例。 ### selectorQuery.exec(callback) 执行所有的请求。请求结果按请求次序构成数组,在callback的第一个参数中返回。 ## NodesRef 用于获取节点信息的对象 ### nodesRef.fields(object,callback) 获取节点的相关信息。第一个参数是节点相关信息配置(必选);第二参数是方法的回调函数,参数是指定的相关节点信息。 **object 参数说明** |字段名|类型|默认值|必填|说明|平台差异说明| |:-|:-|:-|:-|:-|:-| |id|Boolean|false|否|是否返回节点 ``id``|| |dataset|Boolean|false|否|是否返回节点 ``dataset``|| |rect|Boolean|false|否|是否返回节点布局位置(``left`` ``right`` ``top`` ``bottom``)|| |size|Boolean|false|否|是否返回节点尺寸(``width`` ``height``)|| |scrollOffset|Boolean|false|否|是否返回节点的 ``scrollLeft`` ``scrollTop``,节点必须是 ``scroll-view`` 或者 ``viewport``|| | properties | Array<string> | [] | 否 | 指定属性名列表,返回节点对应属性名的当前属性值(只能获得组件文档中标注的常规属性值,id class style 和事件绑定的属性值不可获取) | 仅 App 和微信小程序支持 | | computedStyle | Array<string> | [] | 否 | 指定样式名列表,返回节点对应样式名的当前值 | 仅 App 和微信小程序支持 | | context | Boolean | false | 否 | 是否返回节点对应的 Context 对象 | 仅 App 和微信小程序支持 | ### nodesRef.boundingClientRect(callback) 添加节点的布局位置的查询请求。相对于显示区域,以像素为单位。其功能类似于 DOM 的 ``getBoundingClientRect``。返回 ``NodesRef`` 对应的 ``SelectorQuery``。 **callback 返回参数** |属性 |类型 |说明 | |---|---|---| |id |String |节点的 ID| |dataset |Object |节点的 dataset| |left |Number |节点的左边界坐标| |right |Number |节点的右边界坐标| |top |Number |节点的上边界坐标| |bottom |Number |节点的下边界坐标| |width |Number |节点的宽度| |height |Number |节点的高度| ### nodesRef.scrollOffset(callback) 添加节点的滚动位置查询请求。以像素为单位。节点必须是 ``scroll-view`` 或者 ``viewport``。返回 ``NodesRef`` 对应的 ``SelectorQuery``。 **callback 返回参数** |属性 |类型 |说明 | |---|---|---| |id |String |节点的 ID| |dataset |Object |节点的 dataset| |scrollLeft |Number |节点的水平滚动位置| |scrollTop |Number |节点的竖直滚动位置 | ### nodesRef.context(callback) 添加节点的 Context 对象查询请求。支持 [`VideoContext`](/api/media/video-context)、[`CanvasContext`](/api/canvas/CanvasContext)、和 [`MapContext`](/api/location/map) 等的获取。 **平台差异说明** |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|x|x|x| **callback 返回参数** | 属性 | 类型 | 说明 | | --- | --- | --- | | context | Object | 节点对应的 Context 对象 | ### 代码示例 ```javascript uni.createSelectorQuery().selectViewport().scrollOffset(res => { console.log("竖直滚动位置" + res.scrollTop); }).exec(); let view = uni.createSelectorQuery().in(this).select(".test"); view.fields({ size: true, scrollOffset: true }, data => { console.log("得到节点信息" + JSON.stringify(data)); console.log("节点的宽为" + data.width); }).exec(); view.boundingClientRect(data => { console.log("得到布局位置信息" + JSON.stringify(data)); console.log("节点离页面顶部的距离为" + data.top); }).exec(); ```