• 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 * Define options used to construct a polyline.
23 *
24 * @interface PolylineOptions
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @crossplatform
27 * @form
28 * @atomicservice
29 * @since 18
30 */
31declare interface PolylineOptions {
32  /**
33   * Polyline width.
34   *
35   * @type { ?(string | number) }
36   * @syscap SystemCapability.ArkUI.ArkUI.Full
37   * @since 7
38   */
39  /**
40   * Polyline width.
41   *
42   * @type { ?(string | number) }
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @form
45   * @since 9
46   */
47  /**
48   * Polyline width.
49   *
50   * @type { ?(string | number) }
51   * @syscap SystemCapability.ArkUI.ArkUI.Full
52   * @crossplatform
53   * @form
54   * @since 10
55   */
56  /**
57   * Polyline width.
58   *
59   * @type { ?(string | number) }
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @crossplatform
62   * @form
63   * @atomicservice
64   * @since 11
65   */
66  /**
67   * Polyline width.
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   * Polyline height.
81   *
82   * @type { ?(string | number) }
83   * @syscap SystemCapability.ArkUI.ArkUI.Full
84   * @since 7
85   */
86  /**
87   * Polyline height.
88   *
89   * @type { ?(string | number) }
90   * @syscap SystemCapability.ArkUI.ArkUI.Full
91   * @form
92   * @since 9
93   */
94  /**
95   * Polyline height.
96   *
97   * @type { ?(string | number) }
98   * @syscap SystemCapability.ArkUI.ArkUI.Full
99   * @crossplatform
100   * @form
101   * @since 10
102   */
103  /**
104   * Polyline height.
105   *
106   * @type { ?(string | number) }
107   * @syscap SystemCapability.ArkUI.ArkUI.Full
108   * @crossplatform
109   * @form
110   * @atomicservice
111   * @since 11
112   */
113  /**
114   * Polyline height.
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 * Provides an interface for drawing polylines.
129 *
130 * @interface PolylineInterface
131 * @syscap SystemCapability.ArkUI.ArkUI.Full
132 * @since 7
133 */
134/**
135 * Provides an interface for drawing polylines.
136 *
137 * @interface PolylineInterface
138 * @syscap SystemCapability.ArkUI.ArkUI.Full
139 * @form
140 * @since 9
141 */
142/**
143 * Provides an interface for drawing polylines.
144 *
145 * @interface PolylineInterface
146 * @syscap SystemCapability.ArkUI.ArkUI.Full
147 * @crossplatform
148 * @form
149 * @since 10
150 */
151/**
152 * Provides an interface for drawing polylines.
153 *
154 * @interface PolylineInterface
155 * @syscap SystemCapability.ArkUI.ArkUI.Full
156 * @crossplatform
157 * @form
158 * @atomicservice
159 * @since 11
160 */
161interface PolylineInterface {
162  /**
163   * Uses new to create Polyline.
164   *
165   * @syscap SystemCapability.ArkUI.ArkUI.Full
166   * @since 7
167   */
168  /**
169   * Uses new to create Polyline.
170   *
171   * @syscap SystemCapability.ArkUI.ArkUI.Full
172   * @form
173   * @since 9
174   */
175  /**
176   * Uses new to create Polyline.
177   *
178   * @syscap SystemCapability.ArkUI.ArkUI.Full
179   * @crossplatform
180   * @form
181   * @since 10
182   */
183  /**
184   * Uses new to create Polyline.
185   *
186   * @syscap SystemCapability.ArkUI.ArkUI.Full
187   * @crossplatform
188   * @form
189   * @atomicservice
190   * @since 11
191   */
192  /**
193   * Uses new to create Polyline.
194   * Anonymous Object Rectification.
195   *
196   * @param { PolylineOptions } [options] - Poly line options
197   * @returns { PolylineAttribute }
198   * @syscap SystemCapability.ArkUI.ArkUI.Full
199   * @crossplatform
200   * @form
201   * @atomicservice
202   * @since 18
203   */
204  new (options?: PolylineOptions): PolylineAttribute;
205
206  /**
207   * Called when using the draw fold.
208   *
209   * @param { object } value
210   * @returns { PolylineAttribute }
211   * @syscap SystemCapability.ArkUI.ArkUI.Full
212   * @since 7
213   */
214  /**
215   * Called when using the draw fold.
216   *
217   * @param { object } value
218   * @returns { PolylineAttribute }
219   * @syscap SystemCapability.ArkUI.ArkUI.Full
220   * @form
221   * @since 9
222   */
223  /**
224   * Called when using the draw fold.
225   *
226   * @param { object } value
227   * @returns { PolylineAttribute }
228   * @syscap SystemCapability.ArkUI.ArkUI.Full
229   * @crossplatform
230   * @form
231   * @since 10
232   */
233  /**
234   * Called when using the draw fold.
235   *
236   * @param { object } value
237   * @returns { PolylineAttribute }
238   * @syscap SystemCapability.ArkUI.ArkUI.Full
239   * @crossplatform
240   * @form
241   * @atomicservice
242   * @since 11
243   */
244  /**
245   * Called when using the draw fold.
246   * Anonymous Object Rectification.
247   *
248   * @param { PolylineOptions } [options] - Poly line options
249   * @returns { PolylineAttribute }
250   * @syscap SystemCapability.ArkUI.ArkUI.Full
251   * @crossplatform
252   * @form
253   * @atomicservice
254   * @since 18
255   */
256  (options?: PolylineOptions): PolylineAttribute;
257}
258
259/**
260 * @extends CommonShapeMethod<PolylineAttribute>
261 * @syscap SystemCapability.ArkUI.ArkUI.Full
262 * @since 7
263 */
264/**
265 * @extends CommonShapeMethod<PolylineAttribute>
266 * @syscap SystemCapability.ArkUI.ArkUI.Full
267 * @form
268 * @since 9
269 */
270/**
271 * @extends CommonShapeMethod<PolylineAttribute>
272 * @syscap SystemCapability.ArkUI.ArkUI.Full
273 * @crossplatform
274 * @form
275 * @since 10
276 */
277/**
278 * @extends CommonShapeMethod<PolylineAttribute>
279 * @syscap SystemCapability.ArkUI.ArkUI.Full
280 * @crossplatform
281 * @form
282 * @atomicservice
283 * @since 11
284 */
285declare class PolylineAttribute extends CommonShapeMethod<PolylineAttribute> {
286  /**
287   * Called when the polyline is set to pass through the coordinate point list.
288   *
289   * @param { Array<any> } value
290   * @returns { PolylineAttribute }
291   * @syscap SystemCapability.ArkUI.ArkUI.Full
292   * @since 7
293   */
294  /**
295   * Called when the polyline is set to pass through the coordinate point list.
296   *
297   * @param { Array<any> } value
298   * @returns { PolylineAttribute }
299   * @syscap SystemCapability.ArkUI.ArkUI.Full
300   * @form
301   * @since 9
302   */
303  /**
304   * Called when the polyline is set to pass through the coordinate point list.
305   *
306   * @param { Array<any> } value
307   * @returns { PolylineAttribute }
308   * @syscap SystemCapability.ArkUI.ArkUI.Full
309   * @crossplatform
310   * @form
311   * @since 10
312   */
313  /**
314   * Called when the polyline is set to pass through the coordinate point list.
315   *
316   * @param { Array<any> } value
317   * @returns { PolylineAttribute }
318   * @syscap SystemCapability.ArkUI.ArkUI.Full
319   * @crossplatform
320   * @form
321   * @atomicservice
322   * @since 11
323   */
324  points(value: Array<any>): PolylineAttribute;
325}
326
327/**
328 * Defines Polyline Component.
329 *
330 * @syscap SystemCapability.ArkUI.ArkUI.Full
331 * @since 7
332 */
333/**
334 * Defines Polyline Component.
335 *
336 * @syscap SystemCapability.ArkUI.ArkUI.Full
337 * @form
338 * @since 9
339 */
340/**
341 * Defines Polyline Component.
342 *
343 * @syscap SystemCapability.ArkUI.ArkUI.Full
344 * @crossplatform
345 * @form
346 * @since 10
347 */
348/**
349 * Defines Polyline Component.
350 *
351 * @syscap SystemCapability.ArkUI.ArkUI.Full
352 * @crossplatform
353 * @form
354 * @atomicservice
355 * @since 11
356 */
357declare const Polyline: PolylineInterface;
358
359/**
360 * Defines Polyline Component instance.
361 *
362 * @syscap SystemCapability.ArkUI.ArkUI.Full
363 * @since 7
364 */
365/**
366 * Defines Polyline Component instance.
367 *
368 * @syscap SystemCapability.ArkUI.ArkUI.Full
369 * @form
370 * @since 9
371 */
372/**
373 * Defines Polyline Component instance.
374 *
375 * @syscap SystemCapability.ArkUI.ArkUI.Full
376 * @crossplatform
377 * @form
378 * @since 10
379 */
380/**
381 * Defines Polyline Component instance.
382 *
383 * @syscap SystemCapability.ArkUI.ArkUI.Full
384 * @crossplatform
385 * @form
386 * @atomicservice
387 * @since 11
388 */
389declare const PolylineInstance: PolylineAttribute;
390