• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit ArkUI
19 */
20
21/**
22 * Defines the Column Component.
23 *
24 * @interface ColumnInterface
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @since 7
27 */
28/**
29 * Defines the Column Component.
30 *
31 * @interface ColumnInterface
32 * @syscap SystemCapability.ArkUI.ArkUI.Full
33 * @form
34 * @since 9
35 */
36/**
37 * Defines the Column Component.
38 *
39 * @interface ColumnInterface
40 * @syscap SystemCapability.ArkUI.ArkUI.Full
41 * @crossplatform
42 * @form
43 * @since 10
44 */
45/**
46 * Defines the Column Component.
47 *
48 * @interface ColumnInterface
49 * @syscap SystemCapability.ArkUI.ArkUI.Full
50 * @crossplatform
51 * @form
52 * @atomicservice
53 * @since 11
54 */
55interface ColumnInterface {
56  /**
57   * Set the value.
58   * useAlign:Use a custom alignment.
59   * space: Vertical layout element spacing.
60   *
61   * @param { object } value
62   * @returns { ColumnAttribute }
63   * @syscap SystemCapability.ArkUI.ArkUI.Full
64   * @since 7
65   */
66  /**
67   * Set the value.
68   * useAlign:Use a custom alignment.
69   * space: Vertical layout element spacing.
70   *
71   * @param { object } value
72   * @returns { ColumnAttribute }
73   * @syscap SystemCapability.ArkUI.ArkUI.Full
74   * @form
75   * @since 9
76   */
77  /**
78   * Set the value.
79   * useAlign:Use a custom alignment.
80   * space: Vertical layout element spacing.
81   *
82   * @param { object } value
83   * @returns { ColumnAttribute }
84   * @syscap SystemCapability.ArkUI.ArkUI.Full
85   * @crossplatform
86   * @form
87   * @since 10
88   */
89  /**
90   * Set the value.
91   * useAlign:Use a custom alignment.
92   * space: Vertical layout element spacing.
93   *
94   * @param { object } value
95   * @returns { ColumnAttribute }
96   * @syscap SystemCapability.ArkUI.ArkUI.Full
97   * @crossplatform
98   * @form
99   * @atomicservice
100   * @since 11
101   */
102  (value?: { space?: string | number }): ColumnAttribute;
103}
104
105/**
106 * Defines the Column component attribute functions.
107 *
108 * @extends CommonMethod<ColumnAttribute>
109 * @syscap SystemCapability.ArkUI.ArkUI.Full
110 * @since 7
111 */
112/**
113 * Defines the Column component attribute functions.
114 *
115 * @extends CommonMethod<ColumnAttribute>
116 * @syscap SystemCapability.ArkUI.ArkUI.Full
117 * @form
118 * @since 9
119 */
120/**
121 * Defines the Column component attribute functions.
122 *
123 * @extends CommonMethod<ColumnAttribute>
124 * @syscap SystemCapability.ArkUI.ArkUI.Full
125 * @crossplatform
126 * @form
127 * @since 10
128 */
129/**
130 * Defines the Column component attribute functions.
131 *
132 * @extends CommonMethod<ColumnAttribute>
133 * @syscap SystemCapability.ArkUI.ArkUI.Full
134 * @crossplatform
135 * @form
136 * @atomicservice
137 * @since 11
138 */
139declare class ColumnAttribute extends CommonMethod<ColumnAttribute> {
140  /**
141   * Sets the alignment format of the subassembly in the horizontal direction.
142   *
143   * @param { HorizontalAlign } value
144   * @returns { ColumnAttribute }
145   * @syscap SystemCapability.ArkUI.ArkUI.Full
146   * @since 7
147   */
148  /**
149   * Sets the alignment format of the subassembly in the horizontal direction.
150   *
151   * @param { HorizontalAlign } value
152   * @returns { ColumnAttribute }
153   * @syscap SystemCapability.ArkUI.ArkUI.Full
154   * @form
155   * @since 9
156   */
157  /**
158   * Sets the alignment format of the subassembly in the horizontal direction.
159   *
160   * @param { HorizontalAlign } value
161   * @returns { ColumnAttribute }
162   * @syscap SystemCapability.ArkUI.ArkUI.Full
163   * @crossplatform
164   * @form
165   * @since 10
166   */
167  /**
168   * Sets the alignment format of the subassembly in the horizontal direction.
169   *
170   * @param { HorizontalAlign } value
171   * @returns { ColumnAttribute }
172   * @syscap SystemCapability.ArkUI.ArkUI.Full
173   * @crossplatform
174   * @form
175   * @atomicservice
176   * @since 11
177   */
178  alignItems(value: HorizontalAlign): ColumnAttribute;
179
180  /**
181   * Sets the alignment format of the subassembly in the vertical direction.
182   *
183   * @param { FlexAlign } value
184   * @returns { ColumnAttribute }
185   * @syscap SystemCapability.ArkUI.ArkUI.Full
186   * @since 8
187   */
188  /**
189   * Sets the alignment format of the subassembly in the vertical direction.
190   *
191   * @param { FlexAlign } value
192   * @returns { ColumnAttribute }
193   * @syscap SystemCapability.ArkUI.ArkUI.Full
194   * @form
195   * @since 9
196   */
197  /**
198   * Sets the alignment format of the subassembly in the vertical direction.
199   *
200   * @param { FlexAlign } value
201   * @returns { ColumnAttribute }
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @crossplatform
204   * @form
205   * @since 10
206   */
207  /**
208   * Sets the alignment format of the subassembly in the vertical direction.
209   *
210   * @param { FlexAlign } value
211   * @returns { ColumnAttribute }
212   * @syscap SystemCapability.ArkUI.ArkUI.Full
213   * @crossplatform
214   * @form
215   * @atomicservice
216   * @since 11
217   */
218  justifyContent(value: FlexAlign): ColumnAttribute;
219  /**
220   * Defines the PointLight
221   *
222   * @param { PointLightStyle } value - The point light style.
223   * @returns { ColumnAttribute } The attribute of the column.
224   * @syscap SystemCapability.ArkUI.ArkUI.Full
225   * @systemapi
226   * @since 11
227   */
228  pointLight(value: PointLightStyle): ColumnAttribute;
229  /**
230   * Called when the Main-Axis's direction is set reversed or not
231   *
232   * @param { Optional<boolean> } isReversed - If the main axis is reversed.
233   * @returns { ColumnAttribute } The attribute of the column.
234   * @syscap SystemCapability.ArkUI.ArkUI.Full
235   * @crossplatform
236   * @form
237   * @atomicservice
238   * @since 12
239   */
240  reverse(isReversed: Optional<boolean>): ColumnAttribute;
241}
242
243/**
244 * Defines Column Component.
245 *
246 * @syscap SystemCapability.ArkUI.ArkUI.Full
247 * @since 7
248 */
249/**
250 * Defines Column Component.
251 *
252 * @syscap SystemCapability.ArkUI.ArkUI.Full
253 * @form
254 * @since 9
255 */
256/**
257 * Defines Column Component.
258 *
259 * @syscap SystemCapability.ArkUI.ArkUI.Full
260 * @crossplatform
261 * @form
262 * @since 10
263 */
264/**
265 * Defines Column Component.
266 *
267 * @syscap SystemCapability.ArkUI.ArkUI.Full
268 * @crossplatform
269 * @form
270 * @atomicservice
271 * @since 11
272 */
273declare const Column: ColumnInterface;
274
275/**
276 * Defines Column Component instance.
277 *
278 * @syscap SystemCapability.ArkUI.ArkUI.Full
279 * @since 7
280 */
281/**
282 * Defines Column Component instance.
283 *
284 * @syscap SystemCapability.ArkUI.ArkUI.Full
285 * @form
286 * @since 9
287 */
288/**
289 * Defines Column Component instance.
290 *
291 * @syscap SystemCapability.ArkUI.ArkUI.Full
292 * @crossplatform
293 * @form
294 * @since 10
295 */
296/**
297 * Defines Column Component instance.
298 *
299 * @syscap SystemCapability.ArkUI.ArkUI.Full
300 * @crossplatform
301 * @form
302 * @atomicservice
303 * @since 11
304 */
305declare const ColumnInstance: ColumnAttribute;
306