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