@dfeidao/atom-wxapp > api_xml节点操作类

External module: api_xml节点操作类

Index

Functions

• bounding_client_rect
• create_selector_query
• fields
• scroll_offset
• select
• select_component
• select_viewport
• selector_query_in
• selector_query_select_all

Functions

bounding_client_rect

▸ bounding_client_rect(nodes_ref: NodesRef): Promise<NodesRefRect | NodesRefRect[]>

Defined in api/xml/bounding-client-rect.ts:11

添加节点的布局位置的查询请求

description: 相对于显示区域，以像素为单位。其功能类似于 DOM 的 getBoundingClientRect。返回 NodesRef 对应的 SelectorQuery

see: 微信官方文档

Parameters:

Returns: Promise<NodesRefRect | NodesRefRect[]>

create_selector_query

▸ create_selector_query(): SelectorQuery

Defined in api/xml/create.ts:9

返回一个 SelectorQuery 对象实例

see: 微信官方文档

Returns: SelectorQuery

fields

▸ fields(nodes_ref: NodesRef, id?: undefined | false | true, dataset?: undefined | false | true, rect?: undefined | false | true, size?: undefined | false | true, scrollOffset?: undefined | false | true, properties?: string[]): Promise<any>

Defined in api/xml/fields.ts:11

获取节点的相关信息

description: 需要获取的字段在fields中指定。返回值是 nodesRef 对应的 selectorQuery

see: 微信官方文档

Parameters:

Returns: Promise<any>

scroll_offset

▸ scroll_offset(nodes_ref: NodesRef): Promise<object>

Defined in api/xml/scroll-offset.ts:11

添加节点的滚动位置查询请求

description: 以像素为单位。节点必须是 scroll-view 或者 viewport，返回 NodesRef 对应的 SelectorQuery。

see: 微信官方文档

Parameters:

Returns: Promise<object>

select

▸ select(query: SelectorQuery, selector: string): NodesRef

Defined in api/xml/select.ts:10

在当前页面下选择第一个匹配选择器 selector 的节点。返回一个 NodesRef 对象实例，可以用于获取节点信息。

see: 微信官方文档

Parameters:

Returns: NodesRef

select_component

▸ select_component(fd: IFeidaoAiWeappPage, selector: string): Component<any, any, []>

Defined in api/xml/select-component.ts:17

获取自定义组件

example:

import select_component from '@dfeidao/atom-wxapp/api/xml/select-component';
const selector = select_component('#selector');

Parameters:

Returns: Component<any, any, []>

select_viewport

▸ select_viewport(query: SelectorQuery): NodesRef

Defined in api/xml/select-viewport.ts:11

选择显示区域

description: 可用于获取显示区域的尺寸、滚动位置等信息。

see: 微信官方文档

Parameters:

Returns: NodesRef

selector_query_in

▸ selector_query_in(query: SelectorQuery, component: Component<object, object>): SelectorQuery

Defined in api/xml/in.ts:10

将选择器的选取范围更改为自定义组件 component 内。（初始时，选择器仅选取页面范围的节点，不会选取任何自定义组件中的节点）。

see: 微信官方文档

Parameters:

Returns: SelectorQuery

selector_query_select_all

▸ selector_query_select_all(query: SelectorQuery, selector: string): NodesRef

Defined in api/xml/select-all.ts:10

在当前页面下选择匹配选择器 selector 的所有节点。

see: 微信官方文档

Parameters:

Returns: NodesRef