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 space property with string, number and resource unit. 23 * 24 * @typedef { string | number | Resource } SpaceType 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @crossplatform 27 * @form 28 * @atomicservice 29 * @since 18 30 */ 31declare type SpaceType = string | number | Resource; 32 33/** 34 * Column constructor options. 35 * 36 * @interface ColumnOptions 37 * @syscap SystemCapability.ArkUI.ArkUI.Full 38 * @crossplatform 39 * @form 40 * @atomicservice 41 * @since 18 42 */ 43interface ColumnOptions { 44 /** 45 * Vertical layout element spacing 46 * 47 * @type { ?(string | number) } 48 * @syscap SystemCapability.ArkUI.ArkUI.Full 49 * @since 7 50 */ 51 /** 52 * Vertical layout element spacing. 53 * 54 * @type { ?(string | number) } 55 * @syscap SystemCapability.ArkUI.ArkUI.Full 56 * @form 57 * @since 9 58 */ 59 /** 60 * Vertical layout element spacing. 61 * 62 * @type { ?(string | number) } 63 * @syscap SystemCapability.ArkUI.ArkUI.Full 64 * @crossplatform 65 * @form 66 * @since 10 67 */ 68 /** 69 * Vertical layout element spacing. 70 * 71 * @type { ?(string | number) } 72 * @syscap SystemCapability.ArkUI.ArkUI.Full 73 * @crossplatform 74 * @form 75 * @atomicservice 76 * @since 11 77 */ 78 /** 79 * Vertical layout element spacing. 80 * 81 * Anonymous Object Rectification 82 * @type { ?(string | number) } 83 * @syscap SystemCapability.ArkUI.ArkUI.Full 84 * @crossplatform 85 * @form 86 * @atomicservice 87 * @since 18 88 */ 89 space?: string | number; 90} 91 92/** 93 * Column constructor options. 94 * 95 * @interface ColumnOptionsV2 96 * @syscap SystemCapability.ArkUI.ArkUI.Full 97 * @crossplatform 98 * @form 99 * @atomicservice 100 * @since 18 101 */ 102interface ColumnOptionsV2 { 103 /** 104 * Vertical layout element spacing. 105 * 106 * @type { ?SpaceType } 107 * @syscap SystemCapability.ArkUI.ArkUI.Full 108 * @crossplatform 109 * @form 110 * @atomicservice 111 * @since 18 112 */ 113 space?: SpaceType; 114} 115 116/** 117 * Defines the Column Component. 118 * 119 * @interface ColumnInterface 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @since 7 122 */ 123/** 124 * Defines the Column Component. 125 * 126 * @interface ColumnInterface 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @form 129 * @since 9 130 */ 131/** 132 * Defines the Column Component. 133 * 134 * @interface ColumnInterface 135 * @syscap SystemCapability.ArkUI.ArkUI.Full 136 * @crossplatform 137 * @form 138 * @since 10 139 */ 140/** 141 * Defines the Column Component. 142 * 143 * @interface ColumnInterface 144 * @syscap SystemCapability.ArkUI.ArkUI.Full 145 * @crossplatform 146 * @form 147 * @atomicservice 148 * @since 11 149 */ 150interface ColumnInterface { 151 /** 152 * Set the value. 153 * useAlign:Use a custom alignment. 154 * space: Vertical layout element spacing. 155 * 156 * @param { object } value 157 * @returns { ColumnAttribute } 158 * @syscap SystemCapability.ArkUI.ArkUI.Full 159 * @since 7 160 */ 161 /** 162 * Set the value. 163 * useAlign:Use a custom alignment. 164 * space: Vertical layout element spacing. 165 * 166 * @param { object } value 167 * @returns { ColumnAttribute } 168 * @syscap SystemCapability.ArkUI.ArkUI.Full 169 * @form 170 * @since 9 171 */ 172 /** 173 * Set the value. 174 * useAlign:Use a custom alignment. 175 * space: Vertical layout element spacing. 176 * 177 * @param { object } value 178 * @returns { ColumnAttribute } 179 * @syscap SystemCapability.ArkUI.ArkUI.Full 180 * @crossplatform 181 * @form 182 * @since 10 183 */ 184 /** 185 * Set the value. 186 * useAlign:Use a custom alignment. 187 * space: Vertical layout element spacing. 188 * 189 * @param { object } value 190 * @returns { ColumnAttribute } 191 * @syscap SystemCapability.ArkUI.ArkUI.Full 192 * @crossplatform 193 * @form 194 * @atomicservice 195 * @since 11 196 */ 197 /** 198 * Set the options. 199 * 200 * Anonymous Object Rectification 201 * @param { ColumnOptions } [options] - column options 202 * @returns { ColumnAttribute } 203 * @syscap SystemCapability.ArkUI.ArkUI.Full 204 * @crossplatform 205 * @form 206 * @atomicservice 207 * @since 18 208 */ 209 (options?: ColumnOptions): ColumnAttribute; 210 /** 211 * Set the options. 212 * 213 * Anonymous Object Rectification 214 * @param { ColumnOptions | ColumnOptionsV2 } [options] - column options 215 * @returns { ColumnAttribute } 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @form 219 * @atomicservice 220 * @since 18 221 */ 222 (options?: ColumnOptions | ColumnOptionsV2): ColumnAttribute; 223} 224 225/** 226 * Defines the Column component attribute functions. 227 * 228 * @extends CommonMethod<ColumnAttribute> 229 * @syscap SystemCapability.ArkUI.ArkUI.Full 230 * @since 7 231 */ 232/** 233 * Defines the Column component attribute functions. 234 * 235 * @extends CommonMethod<ColumnAttribute> 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @form 238 * @since 9 239 */ 240/** 241 * Defines the Column component attribute functions. 242 * 243 * @extends CommonMethod<ColumnAttribute> 244 * @syscap SystemCapability.ArkUI.ArkUI.Full 245 * @crossplatform 246 * @form 247 * @since 10 248 */ 249/** 250 * Defines the Column component attribute functions. 251 * 252 * @extends CommonMethod<ColumnAttribute> 253 * @syscap SystemCapability.ArkUI.ArkUI.Full 254 * @crossplatform 255 * @form 256 * @atomicservice 257 * @since 11 258 */ 259declare class ColumnAttribute extends CommonMethod<ColumnAttribute> { 260 /** 261 * Sets the alignment format of the subassembly in the horizontal direction. 262 * 263 * @param { HorizontalAlign } value 264 * @returns { ColumnAttribute } 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @since 7 267 */ 268 /** 269 * Sets the alignment format of the subassembly in the horizontal direction. 270 * 271 * @param { HorizontalAlign } value 272 * @returns { ColumnAttribute } 273 * @syscap SystemCapability.ArkUI.ArkUI.Full 274 * @form 275 * @since 9 276 */ 277 /** 278 * Sets the alignment format of the subassembly in the horizontal direction. 279 * 280 * @param { HorizontalAlign } value 281 * @returns { ColumnAttribute } 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @crossplatform 284 * @form 285 * @since 10 286 */ 287 /** 288 * Sets the alignment format of the subassembly in the horizontal direction. 289 * 290 * @param { HorizontalAlign } value 291 * @returns { ColumnAttribute } 292 * @syscap SystemCapability.ArkUI.ArkUI.Full 293 * @crossplatform 294 * @form 295 * @atomicservice 296 * @since 11 297 */ 298 alignItems(value: HorizontalAlign): ColumnAttribute; 299 300 /** 301 * Sets the alignment format of the subassembly in the vertical direction. 302 * 303 * @param { FlexAlign } value 304 * @returns { ColumnAttribute } 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @since 8 307 */ 308 /** 309 * Sets the alignment format of the subassembly in the vertical direction. 310 * 311 * @param { FlexAlign } value 312 * @returns { ColumnAttribute } 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @form 315 * @since 9 316 */ 317 /** 318 * Sets the alignment format of the subassembly in the vertical direction. 319 * 320 * @param { FlexAlign } value 321 * @returns { ColumnAttribute } 322 * @syscap SystemCapability.ArkUI.ArkUI.Full 323 * @crossplatform 324 * @form 325 * @since 10 326 */ 327 /** 328 * Sets the alignment format of the subassembly in the vertical direction. 329 * 330 * @param { FlexAlign } value 331 * @returns { ColumnAttribute } 332 * @syscap SystemCapability.ArkUI.ArkUI.Full 333 * @crossplatform 334 * @form 335 * @atomicservice 336 * @since 11 337 */ 338 justifyContent(value: FlexAlign): ColumnAttribute; 339 /** 340 * Defines the PointLight 341 * 342 * @param { PointLightStyle } value - The point light style. 343 * @returns { ColumnAttribute } The attribute of the column. 344 * @syscap SystemCapability.ArkUI.ArkUI.Full 345 * @systemapi 346 * @since 11 347 */ 348 pointLight(value: PointLightStyle): ColumnAttribute; 349 /** 350 * Called when the Main-Axis's direction is set reversed or not 351 * 352 * @param { Optional<boolean> } isReversed - If the main axis is reversed. 353 * @returns { ColumnAttribute } The attribute of the column. 354 * @syscap SystemCapability.ArkUI.ArkUI.Full 355 * @crossplatform 356 * @form 357 * @atomicservice 358 * @since 12 359 */ 360 reverse(isReversed: Optional<boolean>): ColumnAttribute; 361} 362 363/** 364 * Defines Column Component. 365 * 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @since 7 368 */ 369/** 370 * Defines Column Component. 371 * 372 * @syscap SystemCapability.ArkUI.ArkUI.Full 373 * @form 374 * @since 9 375 */ 376/** 377 * Defines Column Component. 378 * 379 * @syscap SystemCapability.ArkUI.ArkUI.Full 380 * @crossplatform 381 * @form 382 * @since 10 383 */ 384/** 385 * Defines Column Component. 386 * 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @crossplatform 389 * @form 390 * @atomicservice 391 * @since 11 392 */ 393declare const Column: ColumnInterface; 394 395/** 396 * Defines Column Component instance. 397 * 398 * @syscap SystemCapability.ArkUI.ArkUI.Full 399 * @since 7 400 */ 401/** 402 * Defines Column Component instance. 403 * 404 * @syscap SystemCapability.ArkUI.ArkUI.Full 405 * @form 406 * @since 9 407 */ 408/** 409 * Defines Column Component instance. 410 * 411 * @syscap SystemCapability.ArkUI.ArkUI.Full 412 * @crossplatform 413 * @form 414 * @since 10 415 */ 416/** 417 * Defines Column Component instance. 418 * 419 * @syscap SystemCapability.ArkUI.ArkUI.Full 420 * @crossplatform 421 * @form 422 * @atomicservice 423 * @since 11 424 */ 425declare const ColumnInstance: ColumnAttribute; 426