• 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 Line constructor options.
23 *
24 * @interface LineOptions
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @crossplatform
27 * @form
28 * @atomicservice
29 * @since 18
30 */
31interface LineOptions {
32  /**
33   * Width of the rectangle where the line resides.
34   *
35   * @type { ?(string | number) }
36   * @syscap SystemCapability.ArkUI.ArkUI.Full
37   * @since 7
38   */
39  /**
40   * Width of the rectangle where the line resides.
41   *
42   * @type { ?(string | number) }
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @form
45   * @since 9
46   */
47  /**
48   * Width of the rectangle where the line resides.
49   *
50   * @type { ?(string | number) }
51   * @syscap SystemCapability.ArkUI.ArkUI.Full
52   * @crossplatform
53   * @form
54   * @since 10
55   */
56  /**
57   * Width of the rectangle where the line resides.
58   *
59   * @type { ?(string | number) }
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @crossplatform
62   * @form
63   * @atomicservice
64   * @since 11
65   */
66  /**
67   * Width of the rectangle where the line resides.
68   * Anonymous Object Rectification.
69   *
70   * @type { ?(string | number) }
71   * @syscap SystemCapability.ArkUI.ArkUI.Full
72   * @crossplatform
73   * @form
74   * @atomicservice
75   * @since 18
76   */
77  width?: string | number;
78
79  /**
80   * Height of the rectangle where the line resides.
81   *
82   * @type { ?(string | number) }
83   * @syscap SystemCapability.ArkUI.ArkUI.Full
84   * @since 7
85   */
86  /**
87   * Height of the rectangle where the line resides.
88   *
89   * @type { ?(string | number) }
90   * @syscap SystemCapability.ArkUI.ArkUI.Full
91   * @form
92   * @since 9
93   */
94  /**
95   * Height of the rectangle where the line resides.
96   *
97   * @type { ?(string | number) }
98   * @syscap SystemCapability.ArkUI.ArkUI.Full
99   * @crossplatform
100   * @form
101   * @since 10
102   */
103  /**
104   * Height of the rectangle where the line resides.
105   *
106   * @type { ?(string | number) }
107   * @syscap SystemCapability.ArkUI.ArkUI.Full
108   * @crossplatform
109   * @form
110   * @atomicservice
111   * @since 11
112   */
113  /**
114   * Height of the rectangle where the line resides.
115   * Anonymous Object Rectification.
116   *
117   * @type { ?(string | number) }
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @form
121   * @atomicservice
122   * @since 18
123   */
124  height?: string | number;
125}
126
127/**
128 * Line drawing component.
129 *
130 * @interface LineInterface
131 * @syscap SystemCapability.ArkUI.ArkUI.Full
132 * @since 7
133 */
134/**
135 * Line drawing component.
136 *
137 * @interface LineInterface
138 * @syscap SystemCapability.ArkUI.ArkUI.Full
139 * @form
140 * @since 9
141 */
142/**
143 * Line drawing component.
144 *
145 * @interface LineInterface
146 * @syscap SystemCapability.ArkUI.ArkUI.Full
147 * @crossplatform
148 * @form
149 * @since 10
150 */
151/**
152 * Line drawing component.
153 *
154 * @interface LineInterface
155 * @syscap SystemCapability.ArkUI.ArkUI.Full
156 * @crossplatform
157 * @form
158 * @atomicservice
159 * @since 11
160 */
161interface LineInterface {
162  /**
163   * Uses new to create the line.
164   * width: Width of the rectangle where the line resides..
165   * height: Height of the rectangle where the line resides.
166   *
167   * @param { object } value
168   * @returns { LineAttribute }
169   * @syscap SystemCapability.ArkUI.ArkUI.Full
170   * @since 7
171   */
172  /**
173   * Uses new to create the line.
174   * width: Width of the rectangle where the line resides..
175   * height: Height of the rectangle where the line resides.
176   *
177   * @param { object } value
178   * @returns { LineAttribute }
179   * @syscap SystemCapability.ArkUI.ArkUI.Full
180   * @form
181   * @since 9
182   */
183  /**
184   * Uses new to create the line.
185   * width: Width of the rectangle where the line resides..
186   * height: Height of the rectangle where the line resides.
187   *
188   * @param { object } value
189   * @returns { LineAttribute }
190   * @syscap SystemCapability.ArkUI.ArkUI.Full
191   * @crossplatform
192   * @form
193   * @since 10
194   */
195  /**
196   * Uses new to create the line.
197   * width: Width of the rectangle where the line resides..
198   * height: Height of the rectangle where the line resides.
199   *
200   * @param { object } value
201   * @returns { LineAttribute }
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @crossplatform
204   * @form
205   * @atomicservice
206   * @since 11
207   */
208  /**
209   * Uses new to create the line.
210   * Anonymous Object Rectification.
211   *
212   * @param { LineOptions } [options] - Line options
213   * @returns { LineAttribute }
214   * @syscap SystemCapability.ArkUI.ArkUI.Full
215   * @crossplatform
216   * @form
217   * @atomicservice
218   * @since 18
219   */
220  new (options?: LineOptions): LineAttribute;
221
222  /**
223   * The return value of the parameter is Line.
224   * width: Width of the rectangle where the line resides..
225   * height: Height of the rectangle where the line resides.
226   *
227   * @param { object } value
228   * @returns { LineAttribute }
229   * @syscap SystemCapability.ArkUI.ArkUI.Full
230   * @since 7
231   */
232  /**
233   * The return value of the parameter is Line.
234   * width: Width of the rectangle where the line resides..
235   * height: Height of the rectangle where the line resides.
236   *
237   * @param { object } value
238   * @returns { LineAttribute }
239   * @syscap SystemCapability.ArkUI.ArkUI.Full
240   * @form
241   * @since 9
242   */
243  /**
244   * The return value of the parameter is Line.
245   * width: Width of the rectangle where the line resides..
246   * height: Height of the rectangle where the line resides.
247   *
248   * @param { object } value
249   * @returns { LineAttribute }
250   * @syscap SystemCapability.ArkUI.ArkUI.Full
251   * @crossplatform
252   * @form
253   * @since 10
254   */
255  /**
256   * The return value of the parameter is Line.
257   * width: Width of the rectangle where the line resides..
258   * height: Height of the rectangle where the line resides.
259   *
260   * @param { object } value
261   * @returns { LineAttribute }
262   * @syscap SystemCapability.ArkUI.ArkUI.Full
263   * @crossplatform
264   * @form
265   * @atomicservice
266   * @since 11
267   */
268  /**
269   * The return value of the parameter is Line.
270   * Anonymous Object Rectification.
271   *
272   * @param { LineOptions } [options] - Line options
273   * @returns { LineAttribute }
274   * @syscap SystemCapability.ArkUI.ArkUI.Full
275   * @crossplatform
276   * @form
277   * @atomicservice
278   * @since 18
279   */
280  (options?: LineOptions): LineAttribute;
281}
282
283/**
284 * inheritance CommonShapeMethod.
285 *
286 * @extends CommonShapeMethod<LineAttribute>
287 * @syscap SystemCapability.ArkUI.ArkUI.Full
288 * @since 7
289 */
290/**
291 * inheritance CommonShapeMethod.
292 *
293 * @extends CommonShapeMethod<LineAttribute>
294 * @syscap SystemCapability.ArkUI.ArkUI.Full
295 * @form
296 * @since 9
297 */
298/**
299 * inheritance CommonShapeMethod.
300 *
301 * @extends CommonShapeMethod<LineAttribute>
302 * @syscap SystemCapability.ArkUI.ArkUI.Full
303 * @crossplatform
304 * @form
305 * @since 10
306 */
307/**
308 * inheritance CommonShapeMethod.
309 *
310 * @extends CommonShapeMethod<LineAttribute>
311 * @syscap SystemCapability.ArkUI.ArkUI.Full
312 * @crossplatform
313 * @form
314 * @atomicservice
315 * @since 11
316 */
317declare class LineAttribute extends CommonShapeMethod<LineAttribute> {
318  /**
319   * Coordinate of the start point of the line (relative coordinate).
320   *
321   * @param { Array<any> } value
322   * @returns { LineAttribute }
323   * @syscap SystemCapability.ArkUI.ArkUI.Full
324   * @since 7
325   */
326  /**
327   * Coordinate of the start point of the line (relative coordinate).
328   *
329   * @param { Array<any> } value
330   * @returns { LineAttribute }
331   * @syscap SystemCapability.ArkUI.ArkUI.Full
332   * @form
333   * @since 9
334   */
335  /**
336   * Coordinate of the start point of the line (relative coordinate).
337   *
338   * @param { Array<any> } value
339   * @returns { LineAttribute }
340   * @syscap SystemCapability.ArkUI.ArkUI.Full
341   * @crossplatform
342   * @form
343   * @since 10
344   */
345  /**
346   * Coordinate of the start point of the line (relative coordinate).
347   *
348   * @param { Array<any> } value
349   * @returns { LineAttribute }
350   * @syscap SystemCapability.ArkUI.ArkUI.Full
351   * @crossplatform
352   * @form
353   * @atomicservice
354   * @since 11
355   */
356  startPoint(value: Array<any>): LineAttribute;
357
358  /**
359   * Line end coordinates (relative coordinates).
360   *
361   * @param { Array<any> } value
362   * @returns { LineAttribute }
363   * @syscap SystemCapability.ArkUI.ArkUI.Full
364   * @since 7
365   */
366  /**
367   * Line end coordinates (relative coordinates).
368   *
369   * @param { Array<any> } value
370   * @returns { LineAttribute }
371   * @syscap SystemCapability.ArkUI.ArkUI.Full
372   * @form
373   * @since 9
374   */
375  /**
376   * Line end coordinates (relative coordinates).
377   *
378   * @param { Array<any> } value
379   * @returns { LineAttribute }
380   * @syscap SystemCapability.ArkUI.ArkUI.Full
381   * @crossplatform
382   * @form
383   * @since 10
384   */
385  /**
386   * Line end coordinates (relative coordinates).
387   *
388   * @param { Array<any> } value
389   * @returns { LineAttribute }
390   * @syscap SystemCapability.ArkUI.ArkUI.Full
391   * @crossplatform
392   * @form
393   * @atomicservice
394   * @since 11
395   */
396  endPoint(value: Array<any>): LineAttribute;
397}
398
399/**
400 * Defines Line Component.
401 *
402 * @syscap SystemCapability.ArkUI.ArkUI.Full
403 * @since 7
404 */
405/**
406 * Defines Line Component.
407 *
408 * @syscap SystemCapability.ArkUI.ArkUI.Full
409 * @form
410 * @since 9
411 */
412/**
413 * Defines Line Component.
414 *
415 * @syscap SystemCapability.ArkUI.ArkUI.Full
416 * @crossplatform
417 * @form
418 * @since 10
419 */
420/**
421 * Defines Line Component.
422 *
423 * @syscap SystemCapability.ArkUI.ArkUI.Full
424 * @crossplatform
425 * @form
426 * @atomicservice
427 * @since 11
428 */
429declare const Line: LineInterface;
430
431/**
432 * Defines Line Component instance.
433 *
434 * @syscap SystemCapability.ArkUI.ArkUI.Full
435 * @since 7
436 */
437/**
438 * Defines Line Component instance.
439 *
440 * @syscap SystemCapability.ArkUI.ArkUI.Full
441 * @form
442 * @since 9
443 */
444/**
445 * Defines Line Component instance.
446 *
447 * @syscap SystemCapability.ArkUI.ArkUI.Full
448 * @crossplatform
449 * @form
450 * @since 10
451 */
452/**
453 * Defines Line Component instance.
454 *
455 * @syscap SystemCapability.ArkUI.ArkUI.Full
456 * @crossplatform
457 * @form
458 * @atomicservice
459 * @since 11
460 */
461declare const LineInstance: LineAttribute;
462