• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# RelativeContainer
2
3相对布局组件，用于复杂场景中元素对齐的布局。
4
5>  **说明：**
6>
7> 该组件从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9## 规则说明
10
11 * 容器内子组件区分水平方向，垂直方向：
12   * 水平方向为left， middle， right，对应容器的HorizontalAlign.Start， HorizontalAlign.Center， HorizontalAlign.End。
13   * 垂直方向为top， center， bottom，对应容器的VerticalAlign.Top， VerticalAlign.Center， VerticalAlign.Bottom。
14 * 子组件可以将容器或者其他子组件设为锚点：
15   * 参与相对布局的容器内组件必须设置id，不设置id的组件不显示，容器id固定为__container__。
16   * 此子组件某一方向上的三个位置（水平方向为left、middle、right，垂直方向为top、center、bottom）可以指定容器或其他子组件同方向的三个位置（水平方向为HorizontalAlign.Start、HorizontalAlign.Center、HorizontalAlign.End，垂直方向为VerticalAlign.Top、VerticalAlign.Center、VerticalAlign.Bottom）为锚点。若同方向上设置两个以上锚点，水平方向Start和Center优先，垂直方向Top和Center优先。例如，水平方向上指定了left以容器的HorizontalAlign.Start为锚点，middle以容器的HorizontalAlign.Center为锚点，又指定right的锚点为容器的HorizontalAlign.End，当组件的width和容器的width不能同时满足3条约束规则时，优先取Start和Center的约束规则。
17   * 当同时存在前端页面设置的子组件尺寸和相对布局规则时，子组件的绘制尺寸取决于约束规则。从API Version 11开始，该规则发生变化，子组件绘制尺寸取决于前端页面设置的尺寸。
18   * 对齐后需要额外偏移可设置offset(API Version 11上新增了bias， 不建议再使用offset和position)。
19   * 从API Version 11开始，在RelativeContainer组件中，width、height设置auto表示自适应子组件。
20   * 当width设置auto时，如果水平方向上子组件以容器作为锚点，则auto不生效，垂直方向上同理。
21 * 特殊情况
22   * 根据约束条件和子组件本身的size属性无法确定子组件大小，则子组件不绘制。
23   * 互相依赖、环形依赖时容器内子组件全部不绘制。
24   * 同方向上两个及以上位置设置锚点但锚点位置逆序时此子组件大小为0，即不绘制。
25
26## 子组件
27
28支持多个子组件。
29
30
31## 接口
32
33RelativeContainer()
34
35从API version 9开始，该接口支持在ArkTS卡片中使用。
36
37## 属性
38
39除支持[通用属性](ts-universal-attributes-size.md)外，还支持如下属性：
40
41| 名称       | 参数类型      |  必填   | 描述                   |
42| -------- | ------- |  ---- | -------------------- |
43| guideLine<sup>11+</sup> | Array<[GuideLineStyle](#guidelinestyle11)> | 否    | 声明RelativeContaine容器内的辅助线，Array中每个项目即为一条guideline。 |
44| barrier<sup>11+</sup> | Array<[BarrierStyle](#barrierstyle11)> | 否    | 声明RelativeContaine容器内的屏障，Array中每个项目即为一条barrier。 |
45
46
47## GuideLineStyle<sup>11+</sup>
48
49guideLine参数，用于定义一条guideline的id、方向和位置。
50
51**参数：**
52
53| 名称    | 类型      | 必填   | 描述                    |
54| ----- | ------- | ---- | --------------------- |
55| id  | string  | 是    | guideline的id，必须是唯一的并且不可与容器内组件重名。   |
56| direction | [Axis](ts-appendix-enums.md#axis) | 是    | 指定guideline的方向。<br />默认值：Axis.Vertical |
57| position | [GuideLinePosition](#guidelineposition11) | 是    | 指定guideline的位置。<br />默认值：<br />{<br />start: 0<br />} |
58
59## GuideLinePosition<sup>11+</sup>
60
61guideLine位置参数，用于定义guideline的位置。
62
63**参数：**
64
65| 名称    | 类型      | 必填   | 描述                    |
66| ----- | ------- | ---- | --------------------- |
67| start  | [Dimension](ts-types.md#dimension10)  | 否    | guideline距离容器左侧或者顶部的距离。   |
68| end | [Dimension](ts-types.md#dimension10) | 否    | guideline距离容器右侧或者底部的距离。 |
69
70## BarrierStyle<sup>11+</sup>
71
72barrier参数，用于定义一条barrier的id、方向和生成时所依赖的组件。
73
74**参数：**
75
76| 名称    | 类型      | 必填   | 描述                    |
77| ----- | ------- | ---- | --------------------- |
78| id  | string  | 是    | barrier的id，必须是唯一的并且不可与容器内组件重名。   |
79| direction | [BarrierDirection](ts-appendix-enums.md#barrierdirection11) | 是    | 指定barrier的方向。<br />默认值：BarrierDirection.LEFT |
80| referencedId | Array\<string> | 是    | 指定生成barrier所依赖的组件。 |
81
82## 示例
83
84```ts
85@Entry
86@Component
87struct Index {
88  build() {
89    Row() {
90
91      RelativeContainer() {
92        Row().width(100).height(100)
93          .backgroundColor("#FF3333")
94          .alignRules({
95            top: {anchor: "__container__", align: VerticalAlign.Top},
96            left: {anchor: "__container__", align: HorizontalAlign.Start}
97          })
98          .id("row1")
99
100        Row().width(100).height(100)
101          .backgroundColor("#FFCC00")
102          .alignRules({
103            top: {anchor: "__container__", align: VerticalAlign.Top},
104            right: {anchor: "__container__", align: HorizontalAlign.End}
105          })
106          .id("row2")
107
108        Row().height(100)
109          .backgroundColor("#FF6633")
110          .alignRules({
111            top: {anchor: "row1", align: VerticalAlign.Bottom},
112            left: {anchor: "row1", align: HorizontalAlign.End},
113            right: {anchor: "row2", align: HorizontalAlign.Start}
114          })
115          .id("row3")
116
117        Row()
118          .backgroundColor("#FF9966")
119          .alignRules({
120            top: {anchor: "row3", align: VerticalAlign.Bottom},
121            bottom: {anchor: "__container__", align: VerticalAlign.Bottom},
122            left: {anchor: "__container__", align: HorizontalAlign.Start},
123            right: {anchor: "row1", align: HorizontalAlign.End}
124          })
125          .id("row4")
126
127        Row()
128          .backgroundColor("#FF66FF")
129          .alignRules({
130            top: {anchor: "row3", align: VerticalAlign.Bottom},
131            bottom: {anchor: "__container__", align: VerticalAlign.Bottom},
132            left: {anchor: "row2", align: HorizontalAlign.Start},
133            right: {anchor: "__container__", align: HorizontalAlign.End}
134          })
135          .id("row5")
136      }
137      .width(300).height(300)
138      .margin({left: 50})
139      .border({width:2, color: "#6699FF"})
140    }
141    .height('100%')
142  }
143}
144
145```
146![relative container](figures/relativecontainer.png)