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