• 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 * Provides the path drawing interface.
23 *
24 * @interface PathInterface
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @since 7
27 */
28/**
29 * Provides the path drawing interface.
30 *
31 * @interface PathInterface
32 * @syscap SystemCapability.ArkUI.ArkUI.Full
33 * @form
34 * @since 9
35 */
36/**
37 * Provides the path drawing interface.
38 *
39 * @interface PathInterface
40 * @syscap SystemCapability.ArkUI.ArkUI.Full
41 * @crossplatform
42 * @form
43 * @since 10
44 */
45/**
46 * Provides the path drawing interface.
47 *
48 * @interface PathInterface
49 * @syscap SystemCapability.ArkUI.ArkUI.Full
50 * @crossplatform
51 * @form
52 * @atomicservice
53 * @since 11
54 */
55interface PathInterface {
56  /**
57   * Use new to create Path.
58   *
59   * @param { object } value
60   * @returns { PathAttribute }
61   * @syscap SystemCapability.ArkUI.ArkUI.Full
62   * @since 7
63   */
64  /**
65   * Use new to create Path.
66   *
67   * @param { object } value
68   * @returns { PathAttribute }
69   * @syscap SystemCapability.ArkUI.ArkUI.Full
70   * @form
71   * @since 9
72   */
73  /**
74   * Use new to create Path.
75   *
76   * @param { object } value
77   * @returns { PathAttribute }
78   * @syscap SystemCapability.ArkUI.ArkUI.Full
79   * @crossplatform
80   * @form
81   * @since 10
82   */
83  /**
84   * Use new to create Path.
85   *
86   * @param { object } value
87   * @returns { PathAttribute }
88   * @syscap SystemCapability.ArkUI.ArkUI.Full
89   * @crossplatform
90   * @form
91   * @atomicservice
92   * @since 11
93   */
94  new (value?: { width?: number | string; height?: number | string; commands?: string }): PathAttribute;
95
96  /**
97   * Called when drawing path.
98   *
99   * @param { object } value
100   * @returns { PathAttribute }
101   * @syscap SystemCapability.ArkUI.ArkUI.Full
102   * @since 7
103   */
104  /**
105   * Called when drawing path.
106   *
107   * @param { object } value
108   * @returns { PathAttribute }
109   * @syscap SystemCapability.ArkUI.ArkUI.Full
110   * @form
111   * @since 9
112   */
113  /**
114   * Called when drawing path.
115   *
116   * @param { object } value
117   * @returns { PathAttribute }
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @form
121   * @since 10
122   */
123  /**
124   * Called when drawing path.
125   *
126   * @param { object } value
127   * @returns { PathAttribute }
128   * @syscap SystemCapability.ArkUI.ArkUI.Full
129   * @crossplatform
130   * @form
131   * @atomicservice
132   * @since 11
133   */
134  (value?: { width?: number | string; height?: number | string; commands?: string }): PathAttribute;
135}
136
137/**
138 * Provides methods for attribute path component.
139 *
140 * @extends CommonShapeMethod<PathAttribute>
141 * @syscap SystemCapability.ArkUI.ArkUI.Full
142 * @since 7
143 */
144/**
145 * Provides methods for attribute path component.
146 *
147 * @extends CommonShapeMethod<PathAttribute>
148 * @syscap SystemCapability.ArkUI.ArkUI.Full
149 * @form
150 * @since 9
151 */
152/**
153 * Provides methods for attribute path component.
154 *
155 * @extends CommonShapeMethod<PathAttribute>
156 * @syscap SystemCapability.ArkUI.ArkUI.Full
157 * @crossplatform
158 * @form
159 * @since 10
160 */
161/**
162 * Provides methods for attribute path component.
163 *
164 * @extends CommonShapeMethod<PathAttribute>
165 * @syscap SystemCapability.ArkUI.ArkUI.Full
166 * @crossplatform
167 * @form
168 * @atomicservice
169 * @since 11
170 */
171declare class PathAttribute extends CommonShapeMethod<PathAttribute> {
172  /**
173   * Called when the command string drawn by the path is set.
174   *
175   * @param { string } value
176   * @returns { PathAttribute }
177   * @syscap SystemCapability.ArkUI.ArkUI.Full
178   * @since 7
179   */
180  /**
181   * Called when the command string drawn by the path is set.
182   *
183   * @param { string } value
184   * @returns { PathAttribute }
185   * @syscap SystemCapability.ArkUI.ArkUI.Full
186   * @form
187   * @since 9
188   */
189  /**
190   * Called when the command string drawn by the path is set.
191   *
192   * @param { string } value
193   * @returns { PathAttribute }
194   * @syscap SystemCapability.ArkUI.ArkUI.Full
195   * @crossplatform
196   * @form
197   * @since 10
198   */
199  /**
200   * Called when the command string drawn by the path is set.
201   *
202   * @param { string } value
203   * @returns { PathAttribute }
204   * @syscap SystemCapability.ArkUI.ArkUI.Full
205   * @crossplatform
206   * @form
207   * @atomicservice
208   * @since 11
209   */
210  commands(value: string): PathAttribute;
211}
212
213/**
214 * Defines Path Component.
215 *
216 * @syscap SystemCapability.ArkUI.ArkUI.Full
217 * @since 7
218 */
219/**
220 * Defines Path Component.
221 *
222 * @syscap SystemCapability.ArkUI.ArkUI.Full
223 * @form
224 * @since 9
225 */
226/**
227 * Defines Path Component.
228 *
229 * @syscap SystemCapability.ArkUI.ArkUI.Full
230 * @crossplatform
231 * @form
232 * @since 10
233 */
234/**
235 * Defines Path Component.
236 *
237 * @syscap SystemCapability.ArkUI.ArkUI.Full
238 * @crossplatform
239 * @form
240 * @atomicservice
241 * @since 11
242 */
243declare const Path: PathInterface;
244
245/**
246 * Defines Path Component instance.
247 *
248 * @syscap SystemCapability.ArkUI.ArkUI.Full
249 * @since 7
250 */
251/**
252 * Defines Path Component instance.
253 *
254 * @syscap SystemCapability.ArkUI.ArkUI.Full
255 * @form
256 * @since 9
257 */
258/**
259 * Defines Path Component instance.
260 *
261 * @syscap SystemCapability.ArkUI.ArkUI.Full
262 * @crossplatform
263 * @form
264 * @since 10
265 */
266/**
267 * Defines Path Component instance.
268 *
269 * @syscap SystemCapability.ArkUI.ArkUI.Full
270 * @crossplatform
271 * @form
272 * @atomicservice
273 * @since 11
274 */
275declare const PathInstance: PathAttribute;
276