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 { CommonMethod, Callback, PixelMap } from './common'; 23import { FrameNode } from '../FrameNode'; 24import { ImageAIOptions, ImageAnalyzerConfig } from './imageCommon'; 25import { Matrix2D } from './matrix2d'; 26import { VoidCallback, LengthMetricsUnit, LengthMetrics } from './units'; 27import { Size } from '../Graphics'; 28/*** endif */ 29 30/** 31 * Import the drawing canvas type object for Canvas. 32 * 33 * @typedef { import('../api/@ohos.graphics.drawing').default.Canvas } DrawingCanvas 34 * @syscap SystemCapability.ArkUI.ArkUI.Full 35 * @crossplatform 36 * @atomicservice 37 * @since 12 38 */ 39declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Canvas; 40 41/** 42 * Filling style algorithm, which determines whether a point is within or outside the path. The following 43 * two configurations are supported: 44 * "evenodd": odd and even round rule 45 * "nonzero": (Default) Non-zero Wrap Rules 46 * 47 * @typedef { "evenodd" | "nonzero" } CanvasFillRule 48 * @syscap SystemCapability.ArkUI.ArkUI.Full 49 * @since 8 50 */ 51/** 52 * Filling style algorithm, which determines whether a point is within or outside the path. The following 53 * two configurations are supported: 54 * "evenodd": odd and even round rule 55 * "nonzero": (Default) Non-zero Wrap Rules 56 * 57 * @typedef { "evenodd" | "nonzero" } CanvasFillRule 58 * @syscap SystemCapability.ArkUI.ArkUI.Full 59 * @form 60 * @since 9 61 */ 62/** 63 * Filling style algorithm, which determines whether a point is within or outside the path. The following 64 * two configurations are supported: 65 * "evenodd": odd and even round rule 66 * "nonzero": (Default) Non-zero Wrap Rules 67 * 68 * @typedef { "evenodd" | "nonzero" } CanvasFillRule 69 * @syscap SystemCapability.ArkUI.ArkUI.Full 70 * @crossplatform 71 * @form 72 * @since 10 73 */ 74/** 75 * Filling style algorithm, which determines whether a point is within or outside the path. The following 76 * two configurations are supported: 77 * "evenodd": odd and even round rule 78 * "nonzero": (Default) Non-zero Wrap Rules 79 * 80 * @typedef { "evenodd" | "nonzero" } CanvasFillRule 81 * @syscap SystemCapability.ArkUI.ArkUI.Full 82 * @crossplatform 83 * @form 84 * @atomicservice 85 * @since arkts {'1.1':'11','1.2':'20'} 86 * @arkts 1.1&1.2 87 */ 88declare type CanvasFillRule = "evenodd" | "nonzero"; 89 90/** 91 * Specifies the attribute of drawing the end of each line segment. The following configurations are supported: 92 * "butt": (Default) Segment Ends in Square 93 * "round": Segment ends in a circle 94 * "square": The end of the segment ends in a square, but a rectangular area is added that is the same width 95 * as the segment and is half the thickness of the segment. 96 * 97 * @typedef { "butt" | "round" | "square" } CanvasLineCap 98 * @syscap SystemCapability.ArkUI.ArkUI.Full 99 * @since 8 100 */ 101/** 102 * Specifies the attribute of drawing the end of each line segment. The following configurations are supported: 103 * "butt": (Default) Segment Ends in Square 104 * "round": Segment ends in a circle 105 * "square": The end of the segment ends in a square, but a rectangular area is added that is the same width 106 * as the segment and is half the thickness of the segment. 107 * 108 * @typedef { "butt" | "round" | "square" } CanvasLineCap 109 * @syscap SystemCapability.ArkUI.ArkUI.Full 110 * @form 111 * @since 9 112 */ 113/** 114 * Specifies the attribute of drawing the end of each line segment. The following configurations are supported: 115 * "butt": (Default) Segment Ends in Square 116 * "round": Segment ends in a circle 117 * "square": The end of the segment ends in a square, but a rectangular area is added that is the same width 118 * as the segment and is half the thickness of the segment. 119 * 120 * @typedef { "butt" | "round" | "square" } CanvasLineCap 121 * @syscap SystemCapability.ArkUI.ArkUI.Full 122 * @crossplatform 123 * @form 124 * @since 10 125 */ 126/** 127 * Specifies the attribute of drawing the end of each line segment. The following configurations are supported: 128 * "butt": (Default) Segment Ends in Square 129 * "round": Segment ends in a circle 130 * "square": The end of the segment ends in a square, but a rectangular area is added that is the same width 131 * as the segment and is half the thickness of the segment. 132 * 133 * @typedef { "butt" | "round" | "square" } CanvasLineCap 134 * @syscap SystemCapability.ArkUI.ArkUI.Full 135 * @crossplatform 136 * @form 137 * @atomicservice 138 * @since arkts {'1.1':'11','1.2':'20'} 139 * @arkts 1.1&1.2 140 */ 141declare type CanvasLineCap = "butt" | "round" | "square"; 142 143/** 144 * Sets the attribute of how two connected parts (line segments, arcs, and curves) whose length is not 0 145 * are connected together. The following three configurations are supported: 146 * "bevel": Fill the ends of the connected sections with an additional triangle-base area, 147 * each with its own independent rectangular corner. 148 * "miter": (Default) An additional diamond region is formed by extending the outer edges of the connected portions 149 * so that they intersect at a point. 150 * "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the 151 * connected section. The radius of the fillet is the width of the segment. 152 * 153 * @typedef { "bevel" | "miter" | "round" } CanvasLineJoin 154 * @syscap SystemCapability.ArkUI.ArkUI.Full 155 * @since 8 156 */ 157/** 158 * Sets the attribute of how two connected parts (line segments, arcs, and curves) whose length is not 0 159 * are connected together. The following three configurations are supported: 160 * "bevel": Fill the ends of the connected sections with an additional triangle-base area, 161 * each with its own independent rectangular corner. 162 * "miter": (Default) An additional diamond region is formed by extending the outer edges of the connected portions 163 * so that they intersect at a point. 164 * "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the 165 * connected section. The radius of the fillet is the width of the segment. 166 * 167 * @typedef { "bevel" | "miter" | "round" } CanvasLineJoin 168 * @syscap SystemCapability.ArkUI.ArkUI.Full 169 * @form 170 * @since 9 171 */ 172/** 173 * Sets the attribute of how two connected parts (line segments, arcs, and curves) whose length is not 0 174 * are connected together. The following three configurations are supported: 175 * "bevel": Fill the ends of the connected sections with an additional triangle-base area, 176 * each with its own independent rectangular corner. 177 * "miter": (Default) An additional diamond region is formed by extending the outer edges of the connected portions 178 * so that they intersect at a point. 179 * "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the 180 * connected section. The radius of the fillet is the width of the segment. 181 * 182 * @typedef { "bevel" | "miter" | "round" } CanvasLineJoin 183 * @syscap SystemCapability.ArkUI.ArkUI.Full 184 * @crossplatform 185 * @form 186 * @since 10 187 */ 188/** 189 * Sets the attribute of how two connected parts (line segments, arcs, and curves) whose length is not 0 190 * are connected together. The following three configurations are supported: 191 * "bevel": Fill the ends of the connected sections with an additional triangle-base area, 192 * each with its own independent rectangular corner. 193 * "miter": (Default) An additional diamond region is formed by extending the outer edges of the connected portions 194 * so that they intersect at a point. 195 * "round": Draw the shape of the corner by filling in an additional sector with the center at the end of the 196 * connected section. The radius of the fillet is the width of the segment. 197 * 198 * @typedef { "bevel" | "miter" | "round" } CanvasLineJoin 199 * @syscap SystemCapability.ArkUI.ArkUI.Full 200 * @crossplatform 201 * @form 202 * @atomicservice 203 * @since arkts {'1.1':'11','1.2':'20'} 204 * @arkts 1.1&1.2 205 */ 206declare type CanvasLineJoin = "bevel" | "miter" | "round"; 207 208/** 209 * Indicates the attribute of the current text direction. The options are as follows: 210 * "inherit": (Default) Inherit current Canvas component settings 211 * "ltr": The text direction is left to right. 212 * "rtl": The text direction is from right to left. 213 * 214 * @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection 215 * @syscap SystemCapability.ArkUI.ArkUI.Full 216 * @since 8 217 */ 218/** 219 * Indicates the attribute of the current text direction. The options are as follows: 220 * "inherit": (Default) Inherit current Canvas component settings 221 * "ltr": The text direction is left to right. 222 * "rtl": The text direction is from right to left. 223 * 224 * @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @form 227 * @since 9 228 */ 229/** 230 * Indicates the attribute of the current text direction. The options are as follows: 231 * "inherit": (Default) Inherit current Canvas component settings 232 * "ltr": The text direction is left to right. 233 * "rtl": The text direction is from right to left. 234 * 235 * @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection 236 * @syscap SystemCapability.ArkUI.ArkUI.Full 237 * @crossplatform 238 * @form 239 * @since 10 240 */ 241/** 242 * Indicates the attribute of the current text direction. The options are as follows: 243 * "inherit": (Default) Inherit current Canvas component settings 244 * "ltr": The text direction is left to right. 245 * "rtl": The text direction is from right to left. 246 * 247 * @typedef { "inherit" | "ltr" | "rtl" } CanvasDirection 248 * @syscap SystemCapability.ArkUI.ArkUI.Full 249 * @crossplatform 250 * @form 251 * @atomicservice 252 * @since arkts {'1.1':'11','1.2':'20'} 253 * @arkts 1.1&1.2 254 */ 255declare type CanvasDirection = "inherit" | "ltr" | "rtl"; 256 257/** 258 * Describes the alignment mode for drawing text. The options are as follows: 259 * "center": The text is centered. 260 * "end": Where text aligns lines end (Left alignment refers to the local from left to right, 261 * and right alignment refers to the local from right to left) 262 * "left": (Default) The text is left-aligned. 263 * "right": The text is right-aligned. 264 * "start": Where the text snap line begins (Left alignment refers to the local from left to right, 265 * and right alignment refers to the local from right to left) 266 * 267 * @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign 268 * @syscap SystemCapability.ArkUI.ArkUI.Full 269 * @since 8 270 */ 271/** 272 * Describes the alignment mode for drawing text. The options are as follows: 273 * "center": The text is centered. 274 * "end": Where text aligns lines end (Left alignment refers to the local from left to right, 275 * and right alignment refers to the local from right to left) 276 * "left": (Default) The text is left-aligned. 277 * "right": The text is right-aligned. 278 * "start": Where the text snap line begins (Left alignment refers to the local from left to right, 279 * and right alignment refers to the local from right to left) 280 * 281 * @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @form 284 * @since 9 285 */ 286/** 287 * Describes the alignment mode for drawing text. The options are as follows: 288 * "center": The text is centered. 289 * "end": Where text aligns lines end (Left alignment refers to the local from left to right, 290 * and right alignment refers to the local from right to left) 291 * "left": (Default) The text is left-aligned. 292 * "right": The text is right-aligned. 293 * "start": Where the text snap line begins (Left alignment refers to the local from left to right, 294 * and right alignment refers to the local from right to left) 295 * 296 * @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign 297 * @syscap SystemCapability.ArkUI.ArkUI.Full 298 * @crossplatform 299 * @form 300 * @since 10 301 */ 302/** 303 * Describes the alignment mode for drawing text. The options are as follows: 304 * "center": The text is centered. 305 * "end": Where text aligns lines end (Left alignment refers to the local from left to right, 306 * and right alignment refers to the local from right to left) 307 * "left": (Default) The text is left-aligned. 308 * "right": The text is right-aligned. 309 * "start": Where the text snap line begins (Left alignment refers to the local from left to right, 310 * and right alignment refers to the local from right to left) 311 * 312 * @typedef { "center" | "end" | "left" | "right" | "start" } CanvasTextAlign 313 * @syscap SystemCapability.ArkUI.ArkUI.Full 314 * @crossplatform 315 * @form 316 * @atomicservice 317 * @since arkts {'1.1':'11','1.2':'20'} 318 * @arkts 1.1&1.2 319 */ 320declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start"; 321 322/** 323 * Text baseline, which supports the following configurations: 324 * "alphabetic": (Default) The text baseline is the standard letter baseline. 325 * "bottom": The text baseline is at the bottom of the text block. The difference between the ideographic baseline 326 * and the ideographic baseline is that the ideographic baseline does not need to consider downlink letters. 327 * "hanging": The text baseline is a hanging baseline. 328 * "ideographic": The text baseline is the ideographic baseline; If the character itself exceeds the alphabetic 329 * baseline, the ideographic baseline is at the bottom of the character itself. 330 * "middle": The text baseline is in the middle of the text block. 331 * "top": The text baseline is at the top of the text block. 332 * 333 * @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline 334 * @syscap SystemCapability.ArkUI.ArkUI.Full 335 * @since 8 336 */ 337/** 338 * Text baseline, which supports the following configurations: 339 * "alphabetic": (Default) The text baseline is the standard letter baseline. 340 * "bottom": The text baseline is at the bottom of the text block. The difference between the ideographic baseline 341 * and the ideographic baseline is that the ideographic baseline does not need to consider downlink letters. 342 * "hanging": The text baseline is a hanging baseline. 343 * "ideographic": The text baseline is the ideographic baseline; If the character itself exceeds the alphabetic 344 * baseline, the ideographic baseline is at the bottom of the character itself. 345 * "middle": The text baseline is in the middle of the text block. 346 * "top": The text baseline is at the top of the text block. 347 * 348 * @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline 349 * @syscap SystemCapability.ArkUI.ArkUI.Full 350 * @form 351 * @since 9 352 */ 353/** 354 * Text baseline, which supports the following configurations: 355 * "alphabetic": (Default) The text baseline is the standard letter baseline. 356 * "bottom": The text baseline is at the bottom of the text block. The difference between the ideographic baseline 357 * and the ideographic baseline is that the ideographic baseline does not need to consider downlink letters. 358 * "hanging": The text baseline is a hanging baseline. 359 * "ideographic": The text baseline is the ideographic baseline; If the character itself exceeds the alphabetic 360 * baseline, the ideographic baseline is at the bottom of the character itself. 361 * "middle": The text baseline is in the middle of the text block. 362 * "top": The text baseline is at the top of the text block. 363 * 364 * @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline 365 * @syscap SystemCapability.ArkUI.ArkUI.Full 366 * @crossplatform 367 * @form 368 * @since 10 369 */ 370/** 371 * Text baseline, which supports the following configurations: 372 * "alphabetic": (Default) The text baseline is the standard letter baseline. 373 * "bottom": The text baseline is at the bottom of the text block. The difference between the ideographic baseline 374 * and the ideographic baseline is that the ideographic baseline does not need to consider downlink letters. 375 * "hanging": The text baseline is a hanging baseline. 376 * "ideographic": The text baseline is the ideographic baseline; If the character itself exceeds the alphabetic 377 * baseline, the ideographic baseline is at the bottom of the character itself. 378 * "middle": The text baseline is in the middle of the text block. 379 * "top": The text baseline is at the top of the text block. 380 * 381 * @typedef { "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top" } CanvasTextBaseline 382 * @syscap SystemCapability.ArkUI.ArkUI.Full 383 * @crossplatform 384 * @form 385 * @atomicservice 386 * @since arkts {'1.1':'11','1.2':'20'} 387 * @arkts 1.1&1.2 388 */ 389declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top"; 390 391/** 392 * Sets the image smoothness attribute. The options are as follows: 393 * "high": height 394 * "low": (default)low 395 * "medium": medium 396 * 397 * @typedef { "high" | "low" | "medium" } ImageSmoothingQuality 398 * @syscap SystemCapability.ArkUI.ArkUI.Full 399 * @since 8 400 */ 401/** 402 * Sets the image smoothness attribute. The options are as follows: 403 * "high": height 404 * "low": (default)low 405 * "medium": medium 406 * 407 * @typedef { "high" | "low" | "medium" } ImageSmoothingQuality 408 * @syscap SystemCapability.ArkUI.ArkUI.Full 409 * @form 410 * @since 9 411 */ 412/** 413 * Sets the image smoothness attribute. The options are as follows: 414 * "high": height 415 * "low": (default)low 416 * "medium": medium 417 * 418 * @typedef { "high" | "low" | "medium" } ImageSmoothingQuality 419 * @syscap SystemCapability.ArkUI.ArkUI.Full 420 * @crossplatform 421 * @form 422 * @since 10 423 */ 424/** 425 * Sets the image smoothness attribute. The options are as follows: 426 * "high": height 427 * "low": (default)low 428 * "medium": medium 429 * 430 * @typedef { "high" | "low" | "medium" } ImageSmoothingQuality 431 * @syscap SystemCapability.ArkUI.ArkUI.Full 432 * @crossplatform 433 * @form 434 * @atomicservice 435 * @since arkts {'1.1':'11','1.2':'20'} 436 * @arkts 1.1&1.2 437 */ 438declare type ImageSmoothingQuality = "high" | "low" | "medium"; 439 440/** 441 * Import the frame node type object for Canvas. 442 * 443 * @typedef { import('../api/arkui/FrameNode').FrameNode } FrameNode 444 * @syscap SystemCapability.ArkUI.ArkUI.Full 445 * @crossplatform 446 * @atomicservice 447 * @since 13 448 */ 449declare type FrameNode = import('../api/arkui/FrameNode').FrameNode; 450 451/** 452 * Opaque objects that describe gradients, created by createLinearGradient() or createRadialGradient() 453 * 454 * @syscap SystemCapability.ArkUI.ArkUI.Full 455 * @since 8 456 */ 457/** 458 * Opaque objects that describe gradients, created by createLinearGradient() or createRadialGradient() 459 * 460 * @syscap SystemCapability.ArkUI.ArkUI.Full 461 * @form 462 * @since 9 463 */ 464/** 465 * Opaque objects that describe gradients, created by createLinearGradient() or createRadialGradient() 466 * 467 * @syscap SystemCapability.ArkUI.ArkUI.Full 468 * @crossplatform 469 * @form 470 * @since 10 471 */ 472/** 473 * Opaque objects that describe gradients, created by createLinearGradient() or createRadialGradient() 474 * 475 * @syscap SystemCapability.ArkUI.ArkUI.Full 476 * @crossplatform 477 * @form 478 * @atomicservice 479 * @since arkts {'1.1':'11','1.2':'20'} 480 * @arkts 1.1&1.2 481 */ 482declare class CanvasGradient { 483 /** 484 * Add a breakpoint defined by offset and color to the gradient 485 * 486 * @param { number } offset - Value between 0 and 1, out of range throws INDEX_SIZE_ERR error 487 * @param { string } color - CSS color value <color>. If the color value cannot be resolved to a valid CSS color value <color> 488 * a SYNTAX_ERR error is thrown. 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @since 8 491 */ 492 /** 493 * Add a breakpoint defined by offset and color to the gradient 494 * 495 * @param { number } offset - Value between 0 and 1, out of range throws INDEX_SIZE_ERR error 496 * @param { string } color - CSS color value <color>. If the color value cannot be resolved to a valid CSS color value <color> 497 * a SYNTAX_ERR error is thrown. 498 * @syscap SystemCapability.ArkUI.ArkUI.Full 499 * @form 500 * @since 9 501 */ 502 /** 503 * Add a breakpoint defined by offset and color to the gradient 504 * 505 * @param { number } offset - Value between 0 and 1, out of range throws INDEX_SIZE_ERR error 506 * @param { string } color - Set the gradient color. 507 * a SYNTAX_ERR error is thrown. 508 * @syscap SystemCapability.ArkUI.ArkUI.Full 509 * @crossplatform 510 * @form 511 * @since 10 512 */ 513 /** 514 * Add a breakpoint defined by offset and color to the gradient 515 * 516 * @param { number } offset - Value between 0 and 1, out of range throws INDEX_SIZE_ERR error 517 * @param { string } color - Set the gradient color. 518 * a SYNTAX_ERR error is thrown. 519 * @syscap SystemCapability.ArkUI.ArkUI.Full 520 * @crossplatform 521 * @form 522 * @atomicservice 523 * @since arkts {'1.1':'11','1.2':'20'} 524 * @arkts 1.1&1.2 525 */ 526 addColorStop(offset: number, color: string): void; 527 528 /** 529 * Add a breakpoint defined by offset and color to the gradient 530 * 531 * @param { number } offset - Value between 0 and 1. 532 * @param { string | ColorMetrics } color - Set the gradient color. 533 * @throws { BusinessError } 103701 - The color's ColorSpace is not the same as the last color's. 534 * @syscap SystemCapability.ArkUI.ArkUI.Full 535 * @crossplatform 536 * @form 537 * @atomicservice 538 * @since 20 539 */ 540 addColorStop(offset: number, color: string | ColorMetrics): void; 541} 542 543/** 544 * Path object, which provides basic methods for drawing paths. 545 * 546 * @syscap SystemCapability.ArkUI.ArkUI.Full 547 * @since 8 548 */ 549/** 550 * Path object, which provides basic methods for drawing paths. 551 * 552 * @syscap SystemCapability.ArkUI.ArkUI.Full 553 * @form 554 * @since 9 555 */ 556/** 557 * Path object, which provides basic methods for drawing paths. 558 * 559 * @syscap SystemCapability.ArkUI.ArkUI.Full 560 * @crossplatform 561 * @form 562 * @since 10 563 */ 564/** 565 * Path object, which provides basic methods for drawing paths. 566 * 567 * @syscap SystemCapability.ArkUI.ArkUI.Full 568 * @crossplatform 569 * @form 570 * @atomicservice 571 * @since arkts {'1.1':'11','1.2':'20'} 572 * @arkts 1.1&1.2 573 */ 574declare class CanvasPath { 575 /** 576 * Draw an arc path 577 * 578 * @param { number } x - The x-axis coordinate of the center (center of the circle) of the arc. 579 * @param { number } y - The y-axis coordinate of the center (center of the circle) of the arc. 580 * @param { number } radius - Radius of the arc. 581 * @param { number } startAngle - Start point of an arc, which starts to be calculated in the x-axis direction. The unit is radian. 582 * @param { number } endAngle - The end point of the arc, in radians. 583 * @param { boolean } counterclockwise - If the value is true, the arc is drawn counterclockwise. Otherwise, 584 * the arc is drawn clockwise. The default value is false. 585 * @syscap SystemCapability.ArkUI.ArkUI.Full 586 * @since 8 587 */ 588 /** 589 * Draw an arc path 590 * 591 * @param { number } x - The x-axis coordinate of the center (center of the circle) of the arc. 592 * @param { number } y - The y-axis coordinate of the center (center of the circle) of the arc. 593 * @param { number } radius - Radius of the arc. 594 * @param { number } startAngle - Start point of an arc, which starts to be calculated in the x-axis direction. The unit is radian. 595 * @param { number } endAngle - The end point of the arc, in radians. 596 * @param { boolean } counterclockwise - If the value is true, the arc is drawn counterclockwise. Otherwise, 597 * the arc is drawn clockwise. The default value is false. 598 * @syscap SystemCapability.ArkUI.ArkUI.Full 599 * @form 600 * @since 9 601 */ 602 /** 603 * Draw an arc path 604 * 605 * @param { number } x - The x-axis coordinate of the center (center of the circle) of the arc. 606 * @param { number } y - The y-axis coordinate of the center (center of the circle) of the arc. 607 * @param { number } radius - Radius of the arc. 608 * @param { number } startAngle - Start point of an arc, which starts to be calculated in the x-axis direction. The unit is radian. 609 * @param { number } endAngle - The end point of the arc, in radians. 610 * @param { boolean } counterclockwise - If the value is true, the arc is drawn counterclockwise. Otherwise, 611 * the arc is drawn clockwise. The default value is false. 612 * @syscap SystemCapability.ArkUI.ArkUI.Full 613 * @crossplatform 614 * @form 615 * @since 10 616 */ 617 /** 618 * Draw an arc path 619 * 620 * @param { number } x - The x-axis coordinate of the center (center of the circle) of the arc. 621 * @param { number } y - The y-axis coordinate of the center (center of the circle) of the arc. 622 * @param { number } radius - Radius of the arc. 623 * @param { number } startAngle - Start point of an arc, which starts to be calculated in the x-axis direction. The unit is radian. 624 * @param { number } endAngle - The end point of the arc, in radians. 625 * @param { boolean } counterclockwise - If the value is true, the arc is drawn counterclockwise. Otherwise, 626 * the arc is drawn clockwise. The default value is false. 627 * @syscap SystemCapability.ArkUI.ArkUI.Full 628 * @crossplatform 629 * @form 630 * @atomicservice 631 * @since arkts {'1.1':'11','1.2':'20'} 632 * @arkts 1.1&1.2 633 */ 634 arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void; 635 636 /** 637 * Draw arc paths based on control points and radius 638 * 639 * @param { number } x1 - The x-axis coordinate of the first control point. 640 * @param { number } y1 - The y-axis coordinate of the first control point. 641 * @param { number } x2 - The x-axis coordinate of the second control point. 642 * @param { number } y2 - The y-axis coordinate of the second control point. 643 * @param { number } radius - Radius of the arc. 644 * @syscap SystemCapability.ArkUI.ArkUI.Full 645 * @since 8 646 */ 647 /** 648 * Draw arc paths based on control points and radius 649 * 650 * @param { number } x1 - The x-axis coordinate of the first control point. 651 * @param { number } y1 - The y-axis coordinate of the first control point. 652 * @param { number } x2 - The x-axis coordinate of the second control point. 653 * @param { number } y2 - The y-axis coordinate of the second control point. 654 * @param { number } radius - Radius of the arc. 655 * @syscap SystemCapability.ArkUI.ArkUI.Full 656 * @form 657 * @since 9 658 */ 659 /** 660 * Draw arc paths based on control points and radius 661 * 662 * @param { number } x1 - The x-axis coordinate of the first control point. 663 * @param { number } y1 - The y-axis coordinate of the first control point. 664 * @param { number } x2 - The x-axis coordinate of the second control point. 665 * @param { number } y2 - The y-axis coordinate of the second control point. 666 * @param { number } radius - Radius of the arc. 667 * @syscap SystemCapability.ArkUI.ArkUI.Full 668 * @crossplatform 669 * @form 670 * @since 10 671 */ 672 /** 673 * Draw arc paths based on control points and radius 674 * 675 * @param { number } x1 - The x-axis coordinate of the first control point. 676 * @param { number } y1 - The y-axis coordinate of the first control point. 677 * @param { number } x2 - The x-axis coordinate of the second control point. 678 * @param { number } y2 - The y-axis coordinate of the second control point. 679 * @param { number } radius - Radius of the arc. 680 * @syscap SystemCapability.ArkUI.ArkUI.Full 681 * @crossplatform 682 * @form 683 * @atomicservice 684 * @since arkts {'1.1':'11','1.2':'20'} 685 * @arkts 1.1&1.2 686 */ 687 arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void; 688 689 /** 690 * Drawing Cubic Bessel Curve Paths 691 * 692 * @param { number } cp1x - The x-axis coordinate of the first control point. 693 * @param { number } cp1y - The y-axis coordinate of the first control point. 694 * @param { number } cp2x - The x-axis coordinate of the second control point. 695 * @param { number } cp2y - The y-axis coordinate of the second control point. 696 * @param { number } x - x-axis coordinate of the end point. 697 * @param { number } y - y-axis coordinate of the end point. 698 * @syscap SystemCapability.ArkUI.ArkUI.Full 699 * @since 8 700 */ 701 /** 702 * Drawing Cubic Bessel Curve Paths 703 * 704 * @param { number } cp1x - The x-axis coordinate of the first control point. 705 * @param { number } cp1y - The y-axis coordinate of the first control point. 706 * @param { number } cp2x - The x-axis coordinate of the second control point. 707 * @param { number } cp2y - The y-axis coordinate of the second control point. 708 * @param { number } x - x-axis coordinate of the end point. 709 * @param { number } y - y-axis coordinate of the end point. 710 * @syscap SystemCapability.ArkUI.ArkUI.Full 711 * @form 712 * @since 9 713 */ 714 /** 715 * Drawing Cubic Bessel Curve Paths 716 * 717 * @param { number } cp1x - The x-axis coordinate of the first control point. 718 * @param { number } cp1y - The y-axis coordinate of the first control point. 719 * @param { number } cp2x - The x-axis coordinate of the second control point. 720 * @param { number } cp2y - The y-axis coordinate of the second control point. 721 * @param { number } x - x-axis coordinate of the end point. 722 * @param { number } y - y-axis coordinate of the end point. 723 * @syscap SystemCapability.ArkUI.ArkUI.Full 724 * @crossplatform 725 * @form 726 * @since 10 727 */ 728 /** 729 * Drawing Cubic Bessel Curve Paths 730 * 731 * @param { number } cp1x - The x-axis coordinate of the first control point. 732 * @param { number } cp1y - The y-axis coordinate of the first control point. 733 * @param { number } cp2x - The x-axis coordinate of the second control point. 734 * @param { number } cp2y - The y-axis coordinate of the second control point. 735 * @param { number } x - x-axis coordinate of the end point. 736 * @param { number } y - y-axis coordinate of the end point. 737 * @syscap SystemCapability.ArkUI.ArkUI.Full 738 * @crossplatform 739 * @form 740 * @atomicservice 741 * @since arkts {'1.1':'11','1.2':'20'} 742 * @arkts 1.1&1.2 743 */ 744 bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void; 745 746 /** 747 * Returns the pen point to the start point of the current sub-path 748 * 749 * @syscap SystemCapability.ArkUI.ArkUI.Full 750 * @since 8 751 */ 752 /** 753 * Returns the pen point to the start point of the current sub-path 754 * 755 * @syscap SystemCapability.ArkUI.ArkUI.Full 756 * @form 757 * @since 9 758 */ 759 /** 760 * Returns the pen point to the start point of the current sub-path 761 * 762 * @syscap SystemCapability.ArkUI.ArkUI.Full 763 * @crossplatform 764 * @form 765 * @since 10 766 */ 767 /** 768 * Returns the pen point to the start point of the current sub-path 769 * 770 * @syscap SystemCapability.ArkUI.ArkUI.Full 771 * @crossplatform 772 * @form 773 * @atomicservice 774 * @since arkts {'1.1':'11','1.2':'20'} 775 * @arkts 1.1&1.2 776 */ 777 closePath(): void; 778 779 /** 780 * Draw an Elliptic Path 781 * 782 * @param { number } x - x-axis coordinate of the center of the ellipse. 783 * @param { number } y - y-axis coordinate of the center of the ellipse. 784 * @param { number } radiusX - Radius of the major axis of the ellipse. 785 * @param { number } radiusY - Radius of the minor axis of the ellipse. 786 * @param { number } rotation - The rotation angle of the ellipse, in radians (not angular degrees). 787 * @param { number } startAngle - The angle of the starting point to be drawn, measured from the x-axis in radians 788 * (not angular degrees). 789 * @param { number } endAngle - The angle, in radians, at which the ellipse is to be drawn (not angular degrees). 790 * @param { boolean } counterclockwise - If the value is true, the ellipse is drawn counterclockwise. Otherwise, 791 * the ellipse is drawn clockwise. The default value is false. 792 * @syscap SystemCapability.ArkUI.ArkUI.Full 793 * @since 8 794 */ 795 /** 796 * Draw an Elliptic Path 797 * 798 * @param { number } x - x-axis coordinate of the center of the ellipse. 799 * @param { number } y - y-axis coordinate of the center of the ellipse. 800 * @param { number } radiusX - Radius of the major axis of the ellipse. 801 * @param { number } radiusY - Radius of the minor axis of the ellipse. 802 * @param { number } rotation - The rotation angle of the ellipse, in radians (not angular degrees). 803 * @param { number } startAngle - The angle of the starting point to be drawn, measured from the x-axis in radians 804 * (not angular degrees). 805 * @param { number } endAngle - The angle, in radians, at which the ellipse is to be drawn (not angular degrees). 806 * @param { boolean } counterclockwise - If the value is true, the ellipse is drawn counterclockwise. Otherwise, 807 * the ellipse is drawn clockwise. The default value is false. 808 * @syscap SystemCapability.ArkUI.ArkUI.Full 809 * @form 810 * @since 9 811 */ 812 /** 813 * Draw an Elliptic Path 814 * 815 * @param { number } x - x-axis coordinate of the center of the ellipse. 816 * @param { number } y - y-axis coordinate of the center of the ellipse. 817 * @param { number } radiusX - Radius of the major axis of the ellipse. 818 * @param { number } radiusY - Radius of the minor axis of the ellipse. 819 * @param { number } rotation - The rotation angle of the ellipse, in radians (not angular degrees). 820 * @param { number } startAngle - The angle of the starting point to be drawn, measured from the x-axis in radians 821 * (not angular degrees). 822 * @param { number } endAngle - The angle, in radians, at which the ellipse is to be drawn (not angular degrees). 823 * @param { boolean } counterclockwise - If the value is true, the ellipse is drawn counterclockwise. Otherwise, 824 * the ellipse is drawn clockwise. The default value is false. 825 * @syscap SystemCapability.ArkUI.ArkUI.Full 826 * @crossplatform 827 * @form 828 * @since 10 829 */ 830 /** 831 * Draw an Elliptic Path 832 * 833 * @param { number } x - x-axis coordinate of the center of the ellipse. 834 * @param { number } y - y-axis coordinate of the center of the ellipse. 835 * @param { number } radiusX - Radius of the major axis of the ellipse. 836 * @param { number } radiusY - Radius of the minor axis of the ellipse. 837 * @param { number } rotation - The rotation angle of the ellipse, in radians (not angular degrees). 838 * @param { number } startAngle - The angle of the starting point to be drawn, measured from the x-axis in radians 839 * (not angular degrees). 840 * @param { number } endAngle - The angle, in radians, at which the ellipse is to be drawn (not angular degrees). 841 * @param { boolean } counterclockwise - If the value is true, the ellipse is drawn counterclockwise. Otherwise, 842 * the ellipse is drawn clockwise. The default value is false. 843 * @syscap SystemCapability.ArkUI.ArkUI.Full 844 * @crossplatform 845 * @form 846 * @atomicservice 847 * @since arkts {'1.1':'11','1.2':'20'} 848 * @arkts 1.1&1.2 849 */ 850 ellipse( 851 x: number, 852 y: number, 853 radiusX: number, 854 radiusY: number, 855 rotation: number, 856 startAngle: number, 857 endAngle: number, 858 counterclockwise?: boolean, 859 ): void; 860 861 /** 862 * Connect sub-path using straight lines 863 * 864 * @param { number } x - The x-axis coordinate of the end point of the line. 865 * @param { number } y - The y-axis coordinate of the end point of the line. 866 * @syscap SystemCapability.ArkUI.ArkUI.Full 867 * @since 8 868 */ 869 /** 870 * Connect sub-path using straight lines 871 * 872 * @param { number } x - The x-axis coordinate of the end point of the line. 873 * @param { number } y - The y-axis coordinate of the end point of the line. 874 * @syscap SystemCapability.ArkUI.ArkUI.Full 875 * @form 876 * @since 9 877 */ 878 /** 879 * Connect sub-path using straight lines 880 * 881 * @param { number } x - The x-axis coordinate of the end point of the line. 882 * @param { number } y - The y-axis coordinate of the end point of the line. 883 * @syscap SystemCapability.ArkUI.ArkUI.Full 884 * @crossplatform 885 * @form 886 * @since 10 887 */ 888 /** 889 * Connect sub-path using straight lines 890 * 891 * @param { number } x - The x-axis coordinate of the end point of the line. 892 * @param { number } y - The y-axis coordinate of the end point of the line. 893 * @syscap SystemCapability.ArkUI.ArkUI.Full 894 * @crossplatform 895 * @form 896 * @atomicservice 897 * @since arkts {'1.1':'11','1.2':'20'} 898 * @arkts 1.1&1.2 899 */ 900 lineTo(x: number, y: number): void; 901 902 /** 903 * Moves the start point of a new sub-path to the (x, y) coordinate. 904 * 905 * @param { number } x - The x-axis coordinate of the point. 906 * @param { number } y - The y-axis coordinate of the point. 907 * @syscap SystemCapability.ArkUI.ArkUI.Full 908 * @since 8 909 */ 910 /** 911 * Moves the start point of a new sub-path to the (x, y) coordinate. 912 * 913 * @param { number } x - The x-axis coordinate of the point. 914 * @param { number } y - The y-axis coordinate of the point. 915 * @syscap SystemCapability.ArkUI.ArkUI.Full 916 * @form 917 * @since 9 918 */ 919 /** 920 * Moves the start point of a new sub-path to the (x, y) coordinate. 921 * 922 * @param { number } x - The x-axis coordinate of the point. 923 * @param { number } y - The y-axis coordinate of the point. 924 * @syscap SystemCapability.ArkUI.ArkUI.Full 925 * @crossplatform 926 * @form 927 * @since 10 928 */ 929 /** 930 * Moves the start point of a new sub-path to the (x, y) coordinate. 931 * 932 * @param { number } x - The x-axis coordinate of the point. 933 * @param { number } y - The y-axis coordinate of the point. 934 * @syscap SystemCapability.ArkUI.ArkUI.Full 935 * @crossplatform 936 * @form 937 * @atomicservice 938 * @since arkts {'1.1':'11','1.2':'20'} 939 * @arkts 1.1&1.2 940 */ 941 moveTo(x: number, y: number): void; 942 943 /** 944 * Draw quadratic Bezier curve paths 945 * 946 * @param { number } cpx - The x-axis coordinate of the control point. 947 * @param { number } cpy - The y-axis coordinate of the control point. 948 * @param { number } x - x-axis coordinate of the end point. 949 * @param { number } y - y-axis coordinate of the end point. 950 * @syscap SystemCapability.ArkUI.ArkUI.Full 951 * @since 8 952 */ 953 /** 954 * Draw quadratic Bezier curve paths 955 * 956 * @param { number } cpx - The x-axis coordinate of the control point. 957 * @param { number } cpy - The y-axis coordinate of the control point. 958 * @param { number } x - x-axis coordinate of the end point. 959 * @param { number } y - y-axis coordinate of the end point. 960 * @syscap SystemCapability.ArkUI.ArkUI.Full 961 * @form 962 * @since 9 963 */ 964 /** 965 * Draw quadratic Bezier curve paths 966 * 967 * @param { number } cpx - The x-axis coordinate of the control point. 968 * @param { number } cpy - The y-axis coordinate of the control point. 969 * @param { number } x - x-axis coordinate of the end point. 970 * @param { number } y - y-axis coordinate of the end point. 971 * @syscap SystemCapability.ArkUI.ArkUI.Full 972 * @crossplatform 973 * @form 974 * @since 10 975 */ 976 /** 977 * Draw quadratic Bezier curve paths 978 * 979 * @param { number } cpx - The x-axis coordinate of the control point. 980 * @param { number } cpy - The y-axis coordinate of the control point. 981 * @param { number } x - x-axis coordinate of the end point. 982 * @param { number } y - y-axis coordinate of the end point. 983 * @syscap SystemCapability.ArkUI.ArkUI.Full 984 * @crossplatform 985 * @form 986 * @atomicservice 987 * @since arkts {'1.1':'11','1.2':'20'} 988 * @arkts 1.1&1.2 989 */ 990 quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void; 991 992 /** 993 * Draw Rectangular Paths 994 * 995 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 996 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 997 * @param { number } w - Width of the rectangle. 998 * @param { number } h - Height of the rectangle. 999 * @syscap SystemCapability.ArkUI.ArkUI.Full 1000 * @since 8 1001 */ 1002 /** 1003 * Draw Rectangular Paths 1004 * 1005 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 1006 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 1007 * @param { number } w - Width of the rectangle. 1008 * @param { number } h - Height of the rectangle. 1009 * @syscap SystemCapability.ArkUI.ArkUI.Full 1010 * @form 1011 * @since 9 1012 */ 1013 /** 1014 * Draw Rectangular Paths 1015 * 1016 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 1017 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 1018 * @param { number } w - Width of the rectangle. 1019 * @param { number } h - Height of the rectangle. 1020 * @syscap SystemCapability.ArkUI.ArkUI.Full 1021 * @crossplatform 1022 * @form 1023 * @since 10 1024 */ 1025 /** 1026 * Draw Rectangular Paths 1027 * 1028 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 1029 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 1030 * @param { number } w - Width of the rectangle. 1031 * @param { number } h - Height of the rectangle. 1032 * @syscap SystemCapability.ArkUI.ArkUI.Full 1033 * @crossplatform 1034 * @form 1035 * @atomicservice 1036 * @since arkts {'1.1':'11','1.2':'20'} 1037 * @arkts 1.1&1.2 1038 */ 1039 rect(x: number, y: number, w: number, h: number): void; 1040 1041 /** 1042 * Draw rounded Rectangular Paths 1043 * 1044 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 1045 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 1046 * @param { number } w - Width of the rectangle. 1047 * @param { number } h - Height of the rectangle. 1048 * @param { number | Array<number> } radii - A number or list specifying the radii of the circular arc to be used for the corners of the rectangle. The default value is 0. 1049 * @throws { BusinessError } 103701 - Parameter error. Possible causes: 1050 * <br> 1. The param radii is a list that has zero or more than four elements. 1051 * <br> 2. The param radii contains negative value. 1052 * @syscap SystemCapability.ArkUI.ArkUI.Full 1053 * @crossplatform 1054 * @form 1055 * @atomicservice 1056 * @since 20 1057 */ 1058 roundRect(x: number, y: number, w: number, h: number, radii?: number | Array<number>): void; 1059} 1060 1061/** 1062 * 2D path object for path drawing 1063 * 1064 * @extends CanvasPath 1065 * @syscap SystemCapability.ArkUI.ArkUI.Full 1066 * @since 8 1067 */ 1068/** 1069 * 2D path object for path drawing 1070 * 1071 * @extends CanvasPath 1072 * @syscap SystemCapability.ArkUI.ArkUI.Full 1073 * @form 1074 * @since 9 1075 */ 1076/** 1077 * 2D path object for path drawing 1078 * 1079 * @extends CanvasPath 1080 * @syscap SystemCapability.ArkUI.ArkUI.Full 1081 * @crossplatform 1082 * @form 1083 * @since 10 1084 */ 1085/** 1086 * 2D path object for path drawing 1087 * 1088 * @extends CanvasPath 1089 * @syscap SystemCapability.ArkUI.ArkUI.Full 1090 * @crossplatform 1091 * @form 1092 * @atomicservice 1093 * @since arkts {'1.1':'11','1.2':'20'} 1094 * @arkts 1.1&1.2 1095 */ 1096declare class Path2D extends CanvasPath { 1097 /** 1098 * Adds a path according to the specified path variable. 1099 * 1100 * @param { Path2D } path - Indicates the path object to be added. 1101 * @param { Matrix2D } transform - Transformation matrix of the new trail. The default value is null. 1102 * @syscap SystemCapability.ArkUI.ArkUI.Full 1103 * @since 8 1104 */ 1105 /** 1106 * Adds a path according to the specified path variable. 1107 * 1108 * @param { Path2D } path - Indicates the path object to be added. 1109 * @param { Matrix2D } transform - Transformation matrix of the new trail. The default value is null. 1110 * @syscap SystemCapability.ArkUI.ArkUI.Full 1111 * @form 1112 * @since 9 1113 */ 1114 /** 1115 * Adds a path according to the specified path variable. 1116 * 1117 * @param { Path2D } path - Indicates the path object to be added. 1118 * @param { Matrix2D } transform - Transformation matrix of the new trail. The default value is null. 1119 * @syscap SystemCapability.ArkUI.ArkUI.Full 1120 * @crossplatform 1121 * @form 1122 * @since 10 1123 */ 1124 /** 1125 * Adds a path according to the specified path variable. 1126 * 1127 * @param { Path2D } path - Indicates the path object to be added. 1128 * @param { Matrix2D } transform - Transformation matrix of the new trail. The default value is null. 1129 * @syscap SystemCapability.ArkUI.ArkUI.Full 1130 * @crossplatform 1131 * @form 1132 * @atomicservice 1133 * @since arkts {'1.1':'11','1.2':'20'} 1134 * @arkts 1.1&1.2 1135 */ 1136 addPath(path: Path2D, transform?: Matrix2D): void; 1137 1138 /** 1139 * Create an empty path object. 1140 * 1141 * @syscap SystemCapability.ArkUI.ArkUI.Full 1142 * @since 8 1143 */ 1144 /** 1145 * Create an empty path object. 1146 * 1147 * @syscap SystemCapability.ArkUI.ArkUI.Full 1148 * @form 1149 * @since 9 1150 */ 1151 /** 1152 * Create an empty path object. 1153 * 1154 * @syscap SystemCapability.ArkUI.ArkUI.Full 1155 * @crossplatform 1156 * @form 1157 * @since 10 1158 */ 1159 /** 1160 * Create an empty path object. 1161 * 1162 * @syscap SystemCapability.ArkUI.ArkUI.Full 1163 * @crossplatform 1164 * @form 1165 * @atomicservice 1166 * @since arkts {'1.1':'11','1.2':'20'} 1167 * @arkts 1.1&1.2 1168 */ 1169 constructor(); 1170 1171 /** 1172 * Create an empty path object. 1173 * 1174 * @param { LengthMetricsUnit } unit - the unit mode 1175 * @syscap SystemCapability.ArkUI.ArkUI.Full 1176 * @crossplatform 1177 * @form 1178 * @atomicservice 1179 * @since arkts {'1.1':'12','1.2':'20'} 1180 * @arkts 1.1&1.2 1181 */ 1182 constructor(unit: LengthMetricsUnit); 1183 1184 /** 1185 * Create a copy of a path object 1186 * 1187 * @param { Path2D } path - Path object to be copied 1188 * @syscap SystemCapability.ArkUI.ArkUI.Full 1189 * @since 8 1190 */ 1191 /** 1192 * Create a copy of a path object 1193 * 1194 * @param { Path2D } path - Path object to be copied 1195 * @syscap SystemCapability.ArkUI.ArkUI.Full 1196 * @form 1197 * @since 9 1198 */ 1199 /** 1200 * Create a copy of a path object 1201 * 1202 * @param { Path2D } path - Path object to be copied 1203 * @syscap SystemCapability.ArkUI.ArkUI.Full 1204 * @crossplatform 1205 * @form 1206 * @since 10 1207 */ 1208 /** 1209 * Create a copy of a path object 1210 * 1211 * @param { Path2D } path - Path object to be copied 1212 * @syscap SystemCapability.ArkUI.ArkUI.Full 1213 * @crossplatform 1214 * @form 1215 * @atomicservice 1216 * @since arkts {'1.1':'11','1.2':'20'} 1217 * @arkts 1.1&1.2 1218 */ 1219 constructor(path: Path2D); 1220 1221 /** 1222 * Create a copy of a path object 1223 * 1224 * @param { Path2D } path - Path object to be copied 1225 * @param { LengthMetricsUnit } unit - the unit mode 1226 * @syscap SystemCapability.ArkUI.ArkUI.Full 1227 * @crossplatform 1228 * @form 1229 * @atomicservice 1230 * @since arkts {'1.1':'12','1.2':'20'} 1231 * @arkts 1.1&1.2 1232 */ 1233 constructor(path: Path2D, unit: LengthMetricsUnit); 1234 1235 /** 1236 * Create a new path according to the description. 1237 * 1238 * @param { string } d - Indicates the path string that compiles with the SVG path description specifications. 1239 * @syscap SystemCapability.ArkUI.ArkUI.Full 1240 * @since 8 1241 */ 1242 /** 1243 * Create a new path according to the description. 1244 * 1245 * @param { string } d - Indicates the path string that compiles with the SVG path description specifications. 1246 * @syscap SystemCapability.ArkUI.ArkUI.Full 1247 * @form 1248 * @since 9 1249 */ 1250 /** 1251 * Create a new path according to the description. 1252 * 1253 * @param { string } d - Indicates the path string that compiles with the SVG path description specifications. 1254 * @syscap SystemCapability.ArkUI.ArkUI.Full 1255 * @crossplatform 1256 * @form 1257 * @since 10 1258 */ 1259 /** 1260 * Create a new path according to the description. 1261 * 1262 * @param { string } d - Indicates the path string that compiles with the SVG path description specifications. 1263 * @syscap SystemCapability.ArkUI.ArkUI.Full 1264 * @crossplatform 1265 * @form 1266 * @atomicservice 1267 * @since arkts {'1.1':'11','1.2':'20'} 1268 * @arkts 1.1&1.2 1269 */ 1270 constructor(d: string); 1271 1272 /** 1273 * Create a new path according to the description. 1274 * 1275 * @param { string } description - Indicates the path string that compiles with the SVG path description specifications. 1276 * @param { LengthMetricsUnit } unit - the unit mode 1277 * @syscap SystemCapability.ArkUI.ArkUI.Full 1278 * @crossplatform 1279 * @form 1280 * @atomicservice 1281 * @since arkts {'1.1':'12','1.2':'20'} 1282 * @arkts 1.1&1.2 1283 */ 1284 constructor(description: string, unit: LengthMetricsUnit); 1285} 1286 1287/** 1288 * Describes an opaque object of a template, which is created using the createPattern() method. 1289 * 1290 * @interface CanvasPattern 1291 * @syscap SystemCapability.ArkUI.ArkUI.Full 1292 * @since 8 1293 */ 1294/** 1295 * Describes an opaque object of a template, which is created using the createPattern() method. 1296 * 1297 * @interface CanvasPattern 1298 * @syscap SystemCapability.ArkUI.ArkUI.Full 1299 * @form 1300 * @since 9 1301 */ 1302/** 1303 * Describes an opaque object of a template, which is created using the createPattern() method. 1304 * 1305 * @interface CanvasPattern 1306 * @syscap SystemCapability.ArkUI.ArkUI.Full 1307 * @crossplatform 1308 * @form 1309 * @since 10 1310 */ 1311/** 1312 * Describes an opaque object of a template, which is created using the createPattern() method. 1313 * 1314 * @interface CanvasPattern 1315 * @syscap SystemCapability.ArkUI.ArkUI.Full 1316 * @crossplatform 1317 * @form 1318 * @atomicservice 1319 * @since arkts {'1.1':'11','1.2':'20'} 1320 * @arkts 1.1&1.2 1321 */ 1322declare interface CanvasPattern { 1323 /** 1324 * Adds the matrix transformation effect to the current template. 1325 * 1326 * @param { Matrix2D } transform - transformation matrix. The default value is null. 1327 * @syscap SystemCapability.ArkUI.ArkUI.Full 1328 * @since 8 1329 */ 1330 /** 1331 * Adds the matrix transformation effect to the current template. 1332 * 1333 * @param { Matrix2D } transform - transformation matrix. The default value is null. 1334 * @syscap SystemCapability.ArkUI.ArkUI.Full 1335 * @form 1336 * @since 9 1337 */ 1338 /** 1339 * Adds the matrix transformation effect to the current template. 1340 * 1341 * @param { Matrix2D } transform - transformation matrix. The default value is null. 1342 * @syscap SystemCapability.ArkUI.ArkUI.Full 1343 * @crossplatform 1344 * @form 1345 * @since 10 1346 */ 1347 /** 1348 * Adds the matrix transformation effect to the current template. 1349 * 1350 * @param { Matrix2D } transform - transformation matrix. The default value is null. 1351 * @syscap SystemCapability.ArkUI.ArkUI.Full 1352 * @crossplatform 1353 * @form 1354 * @atomicservice 1355 * @since arkts {'1.1':'11','1.2':'20'} 1356 * @arkts 1.1&1.2 1357 */ 1358 setTransform(transform?: Matrix2D): void; 1359} 1360 1361/** 1362 * Size information of the text 1363 * 1364 * @interface TextMetrics 1365 * @syscap SystemCapability.ArkUI.ArkUI.Full 1366 * @since 8 1367 */ 1368/** 1369 * Size information of the text 1370 * 1371 * @interface TextMetrics 1372 * @syscap SystemCapability.ArkUI.ArkUI.Full 1373 * @form 1374 * @since 9 1375 */ 1376/** 1377 * Size information of the text 1378 * 1379 * @interface TextMetrics 1380 * @syscap SystemCapability.ArkUI.ArkUI.Full 1381 * @crossplatform 1382 * @form 1383 * @since 10 1384 */ 1385/** 1386 * Size information of the text 1387 * 1388 * @interface TextMetrics 1389 * @syscap SystemCapability.ArkUI.ArkUI.Full 1390 * @crossplatform 1391 * @form 1392 * @atomicservice 1393 * @since arkts {'1.1':'11','1.2':'20'} 1394 * @arkts 1.1&1.2 1395 */ 1396declare interface TextMetrics { 1397 /** 1398 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of 1399 * the rectangular boundary of the rendered text. 1400 * 1401 * @type { number } 1402 * @readonly 1403 * @syscap SystemCapability.ArkUI.ArkUI.Full 1404 * @since 8 1405 */ 1406 /** 1407 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of 1408 * the rectangular boundary of the rendered text. 1409 * 1410 * @type { number } 1411 * @readonly 1412 * @syscap SystemCapability.ArkUI.ArkUI.Full 1413 * @form 1414 * @since 9 1415 */ 1416 /** 1417 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of 1418 * the rectangular boundary of the rendered text. 1419 * 1420 * @type { number } 1421 * @readonly 1422 * @syscap SystemCapability.ArkUI.ArkUI.Full 1423 * @crossplatform 1424 * @form 1425 * @since 10 1426 */ 1427 /** 1428 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of 1429 * the rectangular boundary of the rendered text. 1430 * 1431 * @type { number } 1432 * @readonly 1433 * @syscap SystemCapability.ArkUI.ArkUI.Full 1434 * @crossplatform 1435 * @form 1436 * @atomicservice 1437 * @since arkts {'1.1':'11','1.2':'20'} 1438 * @arkts 1.1&1.2 1439 */ 1440 readonly actualBoundingBoxAscent: number; 1441 1442 /** 1443 * Double, the distance from the horizontal line indicated by the textBaseline property to the bottom of 1444 * the rectangular boundary of the rendered text. 1445 * 1446 * @type { number } 1447 * @readonly 1448 * @syscap SystemCapability.ArkUI.ArkUI.Full 1449 * @since 8 1450 */ 1451 /** 1452 * Double, the distance from the horizontal line indicated by the textBaseline property to the bottom of 1453 * the rectangular boundary of the rendered text. 1454 * 1455 * @type { number } 1456 * @readonly 1457 * @syscap SystemCapability.ArkUI.ArkUI.Full 1458 * @form 1459 * @since 9 1460 */ 1461 /** 1462 * Double, the distance from the horizontal line indicated by the textBaseline property to the bottom of 1463 * the rectangular boundary of the rendered text. 1464 * 1465 * @type { number } 1466 * @readonly 1467 * @syscap SystemCapability.ArkUI.ArkUI.Full 1468 * @crossplatform 1469 * @form 1470 * @since 10 1471 */ 1472 /** 1473 * Double, the distance from the horizontal line indicated by the textBaseline property to the bottom of 1474 * the rectangular boundary of the rendered text. 1475 * 1476 * @type { number } 1477 * @readonly 1478 * @syscap SystemCapability.ArkUI.ArkUI.Full 1479 * @crossplatform 1480 * @form 1481 * @atomicservice 1482 * @since arkts {'1.1':'11','1.2':'20'} 1483 * @arkts 1.1&1.2 1484 */ 1485 readonly actualBoundingBoxDescent: number; 1486 1487 /** 1488 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1489 * the left of the text rectangle boundary. 1490 * 1491 * @type { number } 1492 * @readonly 1493 * @syscap SystemCapability.ArkUI.ArkUI.Full 1494 * @since 8 1495 */ 1496 /** 1497 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1498 * the left of the text rectangle boundary. 1499 * 1500 * @type { number } 1501 * @readonly 1502 * @syscap SystemCapability.ArkUI.ArkUI.Full 1503 * @form 1504 * @since 9 1505 */ 1506 /** 1507 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1508 * the left of the text rectangle boundary. 1509 * 1510 * @type { number } 1511 * @readonly 1512 * @syscap SystemCapability.ArkUI.ArkUI.Full 1513 * @crossplatform 1514 * @form 1515 * @since 10 1516 */ 1517 /** 1518 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1519 * the left of the text rectangle boundary. 1520 * 1521 * @type { number } 1522 * @readonly 1523 * @syscap SystemCapability.ArkUI.ArkUI.Full 1524 * @crossplatform 1525 * @form 1526 * @atomicservice 1527 * @since arkts {'1.1':'11','1.2':'20'} 1528 * @arkts 1.1&1.2 1529 */ 1530 readonly actualBoundingBoxLeft: number; 1531 1532 /** 1533 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1534 * the right of the text rectangle boundary. 1535 * 1536 * @type { number } 1537 * @readonly 1538 * @syscap SystemCapability.ArkUI.ArkUI.Full 1539 * @since 8 1540 */ 1541 /** 1542 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1543 * the right of the text rectangle boundary. 1544 * 1545 * @type { number } 1546 * @readonly 1547 * @syscap SystemCapability.ArkUI.ArkUI.Full 1548 * @form 1549 * @since 9 1550 */ 1551 /** 1552 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1553 * the right of the text rectangle boundary. 1554 * 1555 * @type { number } 1556 * @readonly 1557 * @syscap SystemCapability.ArkUI.ArkUI.Full 1558 * @crossplatform 1559 * @form 1560 * @since 10 1561 */ 1562 /** 1563 * Double, parallel to the baseline, distance from the alignment point determined by the textAlign property to 1564 * the right of the text rectangle boundary. 1565 * 1566 * @type { number } 1567 * @readonly 1568 * @syscap SystemCapability.ArkUI.ArkUI.Full 1569 * @crossplatform 1570 * @form 1571 * @atomicservice 1572 * @since arkts {'1.1':'11','1.2':'20'} 1573 * @arkts 1.1&1.2 1574 */ 1575 readonly actualBoundingBoxRight: number; 1576 1577 /** 1578 * Double, the distance from the horizontal line indicated by the textBaseline property to the alphabetic baseline of 1579 * the wireframe. 1580 * 1581 * @type { number } 1582 * @readonly 1583 * @syscap SystemCapability.ArkUI.ArkUI.Full 1584 * @since 8 1585 */ 1586 /** 1587 * Double, the distance from the horizontal line indicated by the textBaseline property to the alphabetic baseline of 1588 * the wireframe. 1589 * 1590 * @type { number } 1591 * @readonly 1592 * @syscap SystemCapability.ArkUI.ArkUI.Full 1593 * @form 1594 * @since 9 1595 */ 1596 /** 1597 * Double, the distance from the horizontal line indicated by the textBaseline property to the alphabetic baseline of 1598 * the wireframe. 1599 * 1600 * @type { number } 1601 * @readonly 1602 * @syscap SystemCapability.ArkUI.ArkUI.Full 1603 * @crossplatform 1604 * @form 1605 * @since 10 1606 */ 1607 /** 1608 * Double, the distance from the horizontal line indicated by the textBaseline property to the alphabetic baseline of 1609 * the wireframe. 1610 * 1611 * @type { number } 1612 * @readonly 1613 * @syscap SystemCapability.ArkUI.ArkUI.Full 1614 * @crossplatform 1615 * @form 1616 * @atomicservice 1617 * @since arkts {'1.1':'11','1.2':'20'} 1618 * @arkts 1.1&1.2 1619 */ 1620 readonly alphabeticBaseline: number; 1621 1622 /** 1623 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of the 1624 * em square in the wireframe. 1625 * 1626 * @type { number } 1627 * @readonly 1628 * @syscap SystemCapability.ArkUI.ArkUI.Full 1629 * @since 8 1630 */ 1631 /** 1632 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of the 1633 * em square in the wireframe. 1634 * 1635 * @type { number } 1636 * @readonly 1637 * @syscap SystemCapability.ArkUI.ArkUI.Full 1638 * @form 1639 * @since 9 1640 */ 1641 /** 1642 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of the 1643 * em square in the wireframe. 1644 * 1645 * @type { number } 1646 * @readonly 1647 * @syscap SystemCapability.ArkUI.ArkUI.Full 1648 * @crossplatform 1649 * @form 1650 * @since 10 1651 */ 1652 /** 1653 * Double, the distance from the horizontal line indicated by the textBaseline property to the top of the 1654 * em square in the wireframe. 1655 * 1656 * @type { number } 1657 * @readonly 1658 * @syscap SystemCapability.ArkUI.ArkUI.Full 1659 * @crossplatform 1660 * @form 1661 * @atomicservice 1662 * @since arkts {'1.1':'11','1.2':'20'} 1663 * @arkts 1.1&1.2 1664 */ 1665 readonly emHeightAscent: number; 1666 1667 /** 1668 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1669 * em box in the wireframe. 1670 * 1671 * @type { number } 1672 * @readonly 1673 * @syscap SystemCapability.ArkUI.ArkUI.Full 1674 * @since 8 1675 */ 1676 /** 1677 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1678 * em box in the wireframe. 1679 * 1680 * @type { number } 1681 * @readonly 1682 * @syscap SystemCapability.ArkUI.ArkUI.Full 1683 * @form 1684 * @since 9 1685 */ 1686 /** 1687 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1688 * em box in the wireframe. 1689 * 1690 * @type { number } 1691 * @readonly 1692 * @syscap SystemCapability.ArkUI.ArkUI.Full 1693 * @crossplatform 1694 * @form 1695 * @since 10 1696 */ 1697 /** 1698 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1699 * em box in the wireframe. 1700 * 1701 * @type { number } 1702 * @readonly 1703 * @syscap SystemCapability.ArkUI.ArkUI.Full 1704 * @crossplatform 1705 * @form 1706 * @atomicservice 1707 * @since arkts {'1.1':'11','1.2':'20'} 1708 * @arkts 1.1&1.2 1709 */ 1710 readonly emHeightDescent: number; 1711 1712 /** 1713 * Double, distance from the horizontal line indicated by the textBaseline property to the top of the 1714 * highest rectangle boundary of all fonts rendering text. 1715 * 1716 * @type { number } 1717 * @readonly 1718 * @syscap SystemCapability.ArkUI.ArkUI.Full 1719 * @since 8 1720 */ 1721 /** 1722 * Double, distance from the horizontal line indicated by the textBaseline property to the top of the 1723 * highest rectangle boundary of all fonts rendering text. 1724 * 1725 * @type { number } 1726 * @readonly 1727 * @syscap SystemCapability.ArkUI.ArkUI.Full 1728 * @form 1729 * @since 9 1730 */ 1731 /** 1732 * Double, distance from the horizontal line indicated by the textBaseline property to the top of the 1733 * highest rectangle boundary of all fonts rendering text. 1734 * 1735 * @type { number } 1736 * @readonly 1737 * @syscap SystemCapability.ArkUI.ArkUI.Full 1738 * @crossplatform 1739 * @form 1740 * @since 10 1741 */ 1742 /** 1743 * Double, distance from the horizontal line indicated by the textBaseline property to the top of the 1744 * highest rectangle boundary of all fonts rendering text. 1745 * 1746 * @type { number } 1747 * @readonly 1748 * @syscap SystemCapability.ArkUI.ArkUI.Full 1749 * @crossplatform 1750 * @form 1751 * @atomicservice 1752 * @since arkts {'1.1':'11','1.2':'20'} 1753 * @arkts 1.1&1.2 1754 */ 1755 readonly fontBoundingBoxAscent: number; 1756 1757 /** 1758 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1759 * rectangular boundary of all fonts rendering text. 1760 * 1761 * @type { number } 1762 * @readonly 1763 * @syscap SystemCapability.ArkUI.ArkUI.Full 1764 * @since 8 1765 */ 1766 /** 1767 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1768 * rectangular boundary of all fonts rendering text. 1769 * 1770 * @type { number } 1771 * @readonly 1772 * @syscap SystemCapability.ArkUI.ArkUI.Full 1773 * @form 1774 * @since 9 1775 */ 1776 /** 1777 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1778 * rectangular boundary of all fonts rendering text. 1779 * 1780 * @type { number } 1781 * @readonly 1782 * @syscap SystemCapability.ArkUI.ArkUI.Full 1783 * @crossplatform 1784 * @form 1785 * @since 10 1786 */ 1787 /** 1788 * Double, distance from the horizontal line indicated by the textBaseline property to the bottom of the 1789 * rectangular boundary of all fonts rendering text. 1790 * 1791 * @type { number } 1792 * @readonly 1793 * @syscap SystemCapability.ArkUI.ArkUI.Full 1794 * @crossplatform 1795 * @form 1796 * @atomicservice 1797 * @since arkts {'1.1':'11','1.2':'20'} 1798 * @arkts 1.1&1.2 1799 */ 1800 readonly fontBoundingBoxDescent: number; 1801 1802 /** 1803 * Double, distance from the horizontal line indicated by the textBaseline property to 1804 * the hanging baseline of the wireframe. 1805 * 1806 * @type { number } 1807 * @readonly 1808 * @syscap SystemCapability.ArkUI.ArkUI.Full 1809 * @since 8 1810 */ 1811 /** 1812 * Double, distance from the horizontal line indicated by the textBaseline property to 1813 * the hanging baseline of the wireframe. 1814 * 1815 * @type { number } 1816 * @readonly 1817 * @syscap SystemCapability.ArkUI.ArkUI.Full 1818 * @form 1819 * @since 9 1820 */ 1821 /** 1822 * Double, distance from the horizontal line indicated by the textBaseline property to 1823 * the hanging baseline of the wireframe. 1824 * 1825 * @type { number } 1826 * @readonly 1827 * @syscap SystemCapability.ArkUI.ArkUI.Full 1828 * @crossplatform 1829 * @form 1830 * @since 10 1831 */ 1832 /** 1833 * Double, distance from the horizontal line indicated by the textBaseline property to 1834 * the hanging baseline of the wireframe. 1835 * 1836 * @type { number } 1837 * @readonly 1838 * @syscap SystemCapability.ArkUI.ArkUI.Full 1839 * @crossplatform 1840 * @form 1841 * @atomicservice 1842 * @since arkts {'1.1':'11','1.2':'20'} 1843 * @arkts 1.1&1.2 1844 */ 1845 readonly hangingBaseline: number; 1846 1847 /** 1848 * Double, distance from the horizontal line indicated by the textBaseline property to 1849 * the ideographic baseline of the wireframe. 1850 * 1851 * @type { number } 1852 * @readonly 1853 * @syscap SystemCapability.ArkUI.ArkUI.Full 1854 * @since 8 1855 */ 1856 /** 1857 * Double, distance from the horizontal line indicated by the textBaseline property to 1858 * the ideographic baseline of the wireframe. 1859 * 1860 * @type { number } 1861 * @readonly 1862 * @syscap SystemCapability.ArkUI.ArkUI.Full 1863 * @form 1864 * @since 9 1865 */ 1866 /** 1867 * Double, distance from the horizontal line indicated by the textBaseline property to 1868 * the ideographic baseline of the wireframe. 1869 * 1870 * @type { number } 1871 * @readonly 1872 * @syscap SystemCapability.ArkUI.ArkUI.Full 1873 * @crossplatform 1874 * @form 1875 * @since 10 1876 */ 1877 /** 1878 * Double, distance from the horizontal line indicated by the textBaseline property to 1879 * the ideographic baseline of the wireframe. 1880 * 1881 * @type { number } 1882 * @readonly 1883 * @syscap SystemCapability.ArkUI.ArkUI.Full 1884 * @crossplatform 1885 * @form 1886 * @atomicservice 1887 * @since arkts {'1.1':'11','1.2':'20'} 1888 * @arkts 1.1&1.2 1889 */ 1890 readonly ideographicBaseline: number; 1891 1892 /** 1893 * Indicates the width of a character string. The value is of the double type. 1894 * 1895 * @type { number } 1896 * @readonly 1897 * @syscap SystemCapability.ArkUI.ArkUI.Full 1898 * @since 8 1899 */ 1900 /** 1901 * Indicates the width of a character string. The value is of the double type. 1902 * 1903 * @type { number } 1904 * @readonly 1905 * @syscap SystemCapability.ArkUI.ArkUI.Full 1906 * @form 1907 * @since 9 1908 */ 1909 /** 1910 * Indicates the width of a character string. The value is of the double type. 1911 * 1912 * @type { number } 1913 * @readonly 1914 * @syscap SystemCapability.ArkUI.ArkUI.Full 1915 * @crossplatform 1916 * @form 1917 * @since 10 1918 */ 1919 /** 1920 * Indicates the width of a character string. The value is of the double type. 1921 * 1922 * @type { number } 1923 * @readonly 1924 * @syscap SystemCapability.ArkUI.ArkUI.Full 1925 * @crossplatform 1926 * @form 1927 * @atomicservice 1928 * @since arkts {'1.1':'11','1.2':'20'} 1929 * @arkts 1.1&1.2 1930 */ 1931 readonly width: number; 1932 1933 /** 1934 * Indicates the height of a character string. The value is of the double type. 1935 * 1936 * @type { number } 1937 * @readonly 1938 * @syscap SystemCapability.ArkUI.ArkUI.Full 1939 * @since 8 1940 */ 1941 /** 1942 * Indicates the height of a character string. The value is of the double type. 1943 * 1944 * @type { number } 1945 * @readonly 1946 * @syscap SystemCapability.ArkUI.ArkUI.Full 1947 * @form 1948 * @since 9 1949 */ 1950 /** 1951 * Indicates the height of a character string. The value is of the double type. 1952 * 1953 * @type { number } 1954 * @readonly 1955 * @syscap SystemCapability.ArkUI.ArkUI.Full 1956 * @crossplatform 1957 * @form 1958 * @since 10 1959 */ 1960 /** 1961 * Indicates the height of a character string. The value is of the double type. 1962 * 1963 * @type { number } 1964 * @readonly 1965 * @syscap SystemCapability.ArkUI.ArkUI.Full 1966 * @crossplatform 1967 * @form 1968 * @atomicservice 1969 * @since arkts {'1.1':'11','1.2':'20'} 1970 * @arkts 1.1&1.2 1971 */ 1972 readonly height: number; 1973} 1974 1975/** 1976 * Bitmap image object that can be drawn onto the current Canvas 1977 * 1978 * @syscap SystemCapability.ArkUI.ArkUI.Full 1979 * @since 8 1980 */ 1981/** 1982 * Bitmap image object that can be drawn onto the current Canvas 1983 * 1984 * @syscap SystemCapability.ArkUI.ArkUI.Full 1985 * @form 1986 * @since 9 1987 */ 1988/** 1989 * Bitmap image object that can be drawn onto the current Canvas 1990 * 1991 * @syscap SystemCapability.ArkUI.ArkUI.Full 1992 * @crossplatform 1993 * @form 1994 * @since 10 1995 */ 1996/** 1997 * Bitmap image object that can be drawn onto the current Canvas 1998 * 1999 * @syscap SystemCapability.ArkUI.ArkUI.Full 2000 * @crossplatform 2001 * @form 2002 * @atomicservice 2003 * @since arkts {'1.1':'11','1.2':'20'} 2004 * @arkts 1.1&1.2 2005 */ 2006declare class ImageBitmap { 2007 /** 2008 * Indicates the height of the CSS pixel unit of ImageData. 2009 * 2010 * @type { number } 2011 * @readonly 2012 * @syscap SystemCapability.ArkUI.ArkUI.Full 2013 * @since 8 2014 */ 2015 /** 2016 * Indicates the height of the CSS pixel unit of ImageData. 2017 * 2018 * @type { number } 2019 * @readonly 2020 * @syscap SystemCapability.ArkUI.ArkUI.Full 2021 * @form 2022 * @since 9 2023 */ 2024 /** 2025 * Indicates the height of the CSS pixel unit of ImageData. 2026 * 2027 * @type { number } 2028 * @readonly 2029 * @syscap SystemCapability.ArkUI.ArkUI.Full 2030 * @crossplatform 2031 * @form 2032 * @since 10 2033 */ 2034 /** 2035 * Indicates the height of the CSS pixel unit of ImageData. 2036 * 2037 * @type { number } 2038 * @readonly 2039 * @syscap SystemCapability.ArkUI.ArkUI.Full 2040 * @crossplatform 2041 * @form 2042 * @atomicservice 2043 * @since 11 2044 */ 2045 readonly height: number; 2046 2047 /** 2048 * Indicates the height of the CSS pixel unit of ImageData. 2049 * 2050 * @return { number } 2051 * @syscap SystemCapability.ArkUI.ArkUI.Full 2052 * @crossplatform 2053 * @form 2054 * @atomicservice 2055 * @since 20 2056 * @arkts 1.2 2057 */ 2058 get height(): number; 2059 2060 /** 2061 * Indicates the width of the CSS pixel unit of ImageData. 2062 * 2063 * @type { number } 2064 * @readonly 2065 * @syscap SystemCapability.ArkUI.ArkUI.Full 2066 * @since 8 2067 */ 2068 /** 2069 * Indicates the width of the CSS pixel unit of ImageData. 2070 * 2071 * @type { number } 2072 * @readonly 2073 * @syscap SystemCapability.ArkUI.ArkUI.Full 2074 * @form 2075 * @since 9 2076 */ 2077 /** 2078 * Indicates the width of the CSS pixel unit of ImageData. 2079 * 2080 * @type { number } 2081 * @readonly 2082 * @syscap SystemCapability.ArkUI.ArkUI.Full 2083 * @crossplatform 2084 * @form 2085 * @since 10 2086 */ 2087 /** 2088 * Indicates the width of the CSS pixel unit of ImageData. 2089 * 2090 * @type { number } 2091 * @readonly 2092 * @syscap SystemCapability.ArkUI.ArkUI.Full 2093 * @crossplatform 2094 * @form 2095 * @atomicservice 2096 * @since 11 2097 */ 2098 readonly width: number; 2099 2100 /** 2101 * Indicates the width of the CSS pixel unit of ImageData. 2102 * 2103 * @return { number } 2104 * @syscap SystemCapability.ArkUI.ArkUI.Full 2105 * @crossplatform 2106 * @form 2107 * @atomicservice 2108 * @since 20 2109 * @arkts 1.2 2110 */ 2111 get width(): number; 2112 2113 /** 2114 * Releases all graphics resources associated with an ImageBitmap. 2115 * 2116 * @syscap SystemCapability.ArkUI.ArkUI.Full 2117 * @since 8 2118 */ 2119 /** 2120 * Releases all graphics resources associated with an ImageBitmap. 2121 * 2122 * @syscap SystemCapability.ArkUI.ArkUI.Full 2123 * @form 2124 * @since 9 2125 */ 2126 /** 2127 * Releases all graphics resources associated with an ImageBitmap. 2128 * 2129 * @syscap SystemCapability.ArkUI.ArkUI.Full 2130 * @crossplatform 2131 * @form 2132 * @since 10 2133 */ 2134 /** 2135 * Releases all graphics resources associated with an ImageBitmap. 2136 * 2137 * @syscap SystemCapability.ArkUI.ArkUI.Full 2138 * @crossplatform 2139 * @form 2140 * @atomicservice 2141 * @since arkts {'1.1':'11','1.2':'20'} 2142 * @arkts 1.1&1.2 2143 */ 2144 close(): void; 2145 2146 /** 2147 * Create an ImageBitmap object based on the transferred image path. 2148 * 2149 * @param { string } src - Path of the image object. 2150 * @syscap SystemCapability.ArkUI.ArkUI.Full 2151 * @since 8 2152 */ 2153 /** 2154 * Create an ImageBitmap object based on the transferred image path. 2155 * 2156 * @param { string } src - Path of the image object. 2157 * @syscap SystemCapability.ArkUI.ArkUI.Full 2158 * @form 2159 * @since 9 2160 */ 2161 /** 2162 * Create an ImageBitmap object based on the transferred image path. 2163 * 2164 * @param { string } src - Path of the image object. 2165 * @syscap SystemCapability.ArkUI.ArkUI.Full 2166 * @crossplatform 2167 * @form 2168 * @since 10 2169 */ 2170 /** 2171 * Create an ImageBitmap object based on the transferred image path. 2172 * 2173 * @param { string } src - Path of the image object. 2174 * @syscap SystemCapability.ArkUI.ArkUI.Full 2175 * @crossplatform 2176 * @form 2177 * @atomicservice 2178 * @since 11 2179 */ 2180 constructor(src: string); 2181 2182 /** 2183 * Create an ImageBitmap object based on the transferred image path. 2184 * 2185 * @param { string } src - Path of the image object. 2186 * @param { LengthMetricsUnit } [unit] - the unit mode 2187 * @syscap SystemCapability.ArkUI.ArkUI.Full 2188 * @crossplatform 2189 * @form 2190 * @atomicservice 2191 * @since 12 2192 */ 2193 constructor(src: string, unit: LengthMetricsUnit); 2194 2195 /** 2196 * Transfer a PixelMap object to construct an ImageBitmap object. 2197 * 2198 * @param { PixelMap } data - PixelMap object 2199 * @syscap SystemCapability.ArkUI.ArkUI.Full 2200 * @since 8 2201 */ 2202 /** 2203 * Transfer a PixelMap object to construct an ImageBitmap object. 2204 * 2205 * @param { PixelMap } data - PixelMap object 2206 * @syscap SystemCapability.ArkUI.ArkUI.Full 2207 * @crossplatform 2208 * @since 10 2209 */ 2210 /** 2211 * Transfer a PixelMap object to construct an ImageBitmap object. 2212 * 2213 * @param { PixelMap } data - PixelMap object 2214 * @syscap SystemCapability.ArkUI.ArkUI.Full 2215 * @crossplatform 2216 * @atomicservice 2217 * @since 11 2218 */ 2219 constructor(data: PixelMap); 2220 2221 /** 2222 * Transfer a PixelMap object to construct an ImageBitmap object. 2223 * 2224 * @param { PixelMap } data - PixelMap object 2225 * @param { LengthMetricsUnit } [unit] - the unit mode 2226 * @syscap SystemCapability.ArkUI.ArkUI.Full 2227 * @crossplatform 2228 * @atomicservice 2229 * @since 12 2230 */ 2231 constructor(data: PixelMap, unit: LengthMetricsUnit); 2232 2233 /** 2234 * Create an ImageBitmap object based on the transferred image path or PixelMap object. 2235 * 2236 * @param { PixelMap | string } src - image path or PixelMap object 2237 * @param { LengthMetricsUnit } [unit] - the unit mode 2238 * @syscap SystemCapability.ArkUI.ArkUI.Full 2239 * @crossplatform 2240 * @atomicservice 2241 * @since 20 2242 * @arkts 1.2 2243 */ 2244 constructor(src: PixelMap | string, unit?: LengthMetricsUnit); 2245} 2246 2247/** 2248 * Image data object 2249 * 2250 * @syscap SystemCapability.ArkUI.ArkUI.Full 2251 * @since 8 2252 */ 2253/** 2254 * Image data object 2255 * 2256 * @syscap SystemCapability.ArkUI.ArkUI.Full 2257 * @form 2258 * @since 9 2259 */ 2260/** 2261 * Image data object 2262 * 2263 * @syscap SystemCapability.ArkUI.ArkUI.Full 2264 * @crossplatform 2265 * @form 2266 * @since 10 2267 */ 2268/** 2269 * Image data object 2270 * 2271 * @syscap SystemCapability.ArkUI.ArkUI.Full 2272 * @crossplatform 2273 * @form 2274 * @atomicservice 2275 * @since arkts {'1.1':'11','1.2':'20'} 2276 * @arkts 1.1&1.2 2277 */ 2278declare class ImageData { 2279 /** 2280 * Array containing image pixel data 2281 * 2282 * @type { Uint8ClampedArray } 2283 * @readonly 2284 * @syscap SystemCapability.ArkUI.ArkUI.Full 2285 * @since 8 2286 */ 2287 /** 2288 * Array containing image pixel data 2289 * 2290 * @type { Uint8ClampedArray } 2291 * @readonly 2292 * @syscap SystemCapability.ArkUI.ArkUI.Full 2293 * @form 2294 * @since 9 2295 */ 2296 /** 2297 * Array containing image pixel data 2298 * 2299 * @type { Uint8ClampedArray } 2300 * @readonly 2301 * @syscap SystemCapability.ArkUI.ArkUI.Full 2302 * @crossplatform 2303 * @form 2304 * @since 10 2305 */ 2306 /** 2307 * Array containing image pixel data 2308 * 2309 * @type { Uint8ClampedArray } 2310 * @readonly 2311 * @syscap SystemCapability.ArkUI.ArkUI.Full 2312 * @crossplatform 2313 * @form 2314 * @atomicservice 2315 * @since 11 2316 */ 2317 readonly data: Uint8ClampedArray; 2318 2319 /** 2320 * Array containing image pixel data 2321 * 2322 * @return { Uint8ClampedArray } 2323 * @syscap SystemCapability.ArkUI.ArkUI.Full 2324 * @crossplatform 2325 * @form 2326 * @atomicservice 2327 * @since 20 2328 * @arkts 1.2 2329 */ 2330 get data(): Uint8ClampedArray; 2331 2332 /** 2333 * Width of the image. 2334 * 2335 * @type { number } 2336 * @readonly 2337 * @syscap SystemCapability.ArkUI.ArkUI.Full 2338 * @since 8 2339 */ 2340 /** 2341 * Width of the image. 2342 * 2343 * @type { number } 2344 * @readonly 2345 * @syscap SystemCapability.ArkUI.ArkUI.Full 2346 * @form 2347 * @since 9 2348 */ 2349 /** 2350 * Width of the image. 2351 * 2352 * @type { number } 2353 * @readonly 2354 * @syscap SystemCapability.ArkUI.ArkUI.Full 2355 * @crossplatform 2356 * @form 2357 * @since 10 2358 */ 2359 /** 2360 * Width of the image. 2361 * 2362 * @type { number } 2363 * @readonly 2364 * @syscap SystemCapability.ArkUI.ArkUI.Full 2365 * @crossplatform 2366 * @form 2367 * @atomicservice 2368 * @since 11 2369 */ 2370 readonly height: number; 2371 2372 /** 2373 * Height of the image. 2374 * 2375 * @return { number } 2376 * @syscap SystemCapability.ArkUI.ArkUI.Full 2377 * @crossplatform 2378 * @form 2379 * @atomicservice 2380 * @since 20 2381 * @arkts 1.2 2382 */ 2383 get height(): number; 2384 2385 /** 2386 * Height of the image. 2387 * 2388 * @type { number } 2389 * @readonly 2390 * @syscap SystemCapability.ArkUI.ArkUI.Full 2391 * @since 8 2392 */ 2393 /** 2394 * Height of the image. 2395 * 2396 * @type { number } 2397 * @readonly 2398 * @syscap SystemCapability.ArkUI.ArkUI.Full 2399 * @form 2400 * @since 9 2401 */ 2402 /** 2403 * Height of the image. 2404 * 2405 * @type { number } 2406 * @readonly 2407 * @syscap SystemCapability.ArkUI.ArkUI.Full 2408 * @crossplatform 2409 * @form 2410 * @since 10 2411 */ 2412 /** 2413 * Height of the image. 2414 * 2415 * @type { number } 2416 * @readonly 2417 * @syscap SystemCapability.ArkUI.ArkUI.Full 2418 * @crossplatform 2419 * @form 2420 * @atomicservice 2421 * @since 11 2422 */ 2423 readonly width: number; 2424 2425 /** 2426 * Width of the image. 2427 * 2428 * @return { number } 2429 * @syscap SystemCapability.ArkUI.ArkUI.Full 2430 * @crossplatform 2431 * @form 2432 * @atomicservice 2433 * @since 20 2434 * @arkts 1.2 2435 */ 2436 get width(): number; 2437 2438 /** 2439 * Create an ImageData object based on the input parameters. 2440 * 2441 * @param { number } width - Width of the image. 2442 * @param { number } height - Height of the image. 2443 * @param { Uint8ClampedArray } data - Data of the image. If this parameter is not specified, the default value is a black rectangular image. 2444 * @syscap SystemCapability.ArkUI.ArkUI.Full 2445 * @since 8 2446 */ 2447 /** 2448 * Create an ImageData object based on the input parameters. 2449 * 2450 * @param { number } width - Width of the image. 2451 * @param { number } height - Height of the image. 2452 * @param { Uint8ClampedArray } data - Data of the image. If this parameter is not specified, the default value is a black rectangular image. 2453 * @syscap SystemCapability.ArkUI.ArkUI.Full 2454 * @form 2455 * @since 9 2456 */ 2457 /** 2458 * Create an ImageData object based on the input parameters. 2459 * 2460 * @param { number } width - Width of the image. 2461 * @param { number } height - Height of the image. 2462 * @param { Uint8ClampedArray } data - Data of the image. If this parameter is not specified, the default value is a black rectangular image. 2463 * @syscap SystemCapability.ArkUI.ArkUI.Full 2464 * @crossplatform 2465 * @form 2466 * @since 10 2467 */ 2468 /** 2469 * Create an ImageData object based on the input parameters. 2470 * 2471 * @param { number } width - Width of the image. 2472 * @param { number } height - Height of the image. 2473 * @param { Uint8ClampedArray } data - Data of the image. If this parameter is not specified, the default value is a black rectangular image. 2474 * @syscap SystemCapability.ArkUI.ArkUI.Full 2475 * @crossplatform 2476 * @form 2477 * @atomicservice 2478 * @since 11 2479 */ 2480 constructor(width: number, height: number, data?: Uint8ClampedArray); 2481 2482 /** 2483 * Create an ImageData object based on the input parameters. 2484 * 2485 * @param { number } width - Width of the image. 2486 * @param { number } height - Height of the image. 2487 * @param { Uint8ClampedArray } data - Data of the image. If this parameter is not specified, the default value is a black rectangular image. 2488 * @param { LengthMetricsUnit } [unit] - the unit mode 2489 * @syscap SystemCapability.ArkUI.ArkUI.Full 2490 * @crossplatform 2491 * @form 2492 * @atomicservice 2493 * @since arkts {'1.1':'12','1.2':'20'} 2494 * @arkts 1.1&1.2 2495 */ 2496 constructor(width: number, height: number, data?: Uint8ClampedArray, unit?: LengthMetricsUnit); 2497} 2498 2499/** 2500 * This object allows you to set properties when creating a rendering context 2501 * 2502 * @syscap SystemCapability.ArkUI.ArkUI.Full 2503 * @since 8 2504 */ 2505/** 2506 * This object allows you to set properties when creating a rendering context 2507 * 2508 * @syscap SystemCapability.ArkUI.ArkUI.Full 2509 * @form 2510 * @since 9 2511 */ 2512/** 2513 * This object allows you to set properties when creating a rendering context 2514 * 2515 * @syscap SystemCapability.ArkUI.ArkUI.Full 2516 * @crossplatform 2517 * @form 2518 * @since 10 2519 */ 2520/** 2521 * This object allows you to set properties when creating a rendering context 2522 * 2523 * @syscap SystemCapability.ArkUI.ArkUI.Full 2524 * @crossplatform 2525 * @form 2526 * @atomicservice 2527 * @since arkts {'1.1':'11','1.2':'20'} 2528 * @arkts 1.1&1.2 2529 */ 2530declare class RenderingContextSettings { 2531 /** 2532 * Indicates whether anti-aliasing is enabled for canvas. The default value is false. 2533 * 2534 * @type { ?boolean } 2535 * @syscap SystemCapability.ArkUI.ArkUI.Full 2536 * @since 8 2537 */ 2538 /** 2539 * Indicates whether anti-aliasing is enabled for canvas. The default value is false. 2540 * 2541 * @type { ?boolean } 2542 * @syscap SystemCapability.ArkUI.ArkUI.Full 2543 * @form 2544 * @since 9 2545 */ 2546 /** 2547 * Indicates whether anti-aliasing is enabled for canvas. The default value is false. 2548 * 2549 * @type { ?boolean } 2550 * @syscap SystemCapability.ArkUI.ArkUI.Full 2551 * @crossplatform 2552 * @form 2553 * @since 10 2554 */ 2555 /** 2556 * Indicates whether anti-aliasing is enabled for canvas. The default value is false. 2557 * 2558 * @type { ?boolean } 2559 * @syscap SystemCapability.ArkUI.ArkUI.Full 2560 * @crossplatform 2561 * @form 2562 * @atomicservice 2563 * @since 11 2564 */ 2565 antialias?: boolean; 2566 2567 /** 2568 * Get the status whether anti-aliasing is enabled for canvas. The default value is false. 2569 * 2570 * @return { boolean | undefined } 2571 * @syscap SystemCapability.ArkUI.ArkUI.Full 2572 * @crossplatform 2573 * @form 2574 * @atomicservice 2575 * @since 20 2576 * @arkts 1.2 2577 */ 2578 get antialias(): boolean | undefined; 2579 2580 /** 2581 * Set the status whether anti-aliasing is enabled for canvas. The default value is false. 2582 * 2583 * @param { boolean | undefined } 2584 * @syscap SystemCapability.ArkUI.ArkUI.Full 2585 * @crossplatform 2586 * @form 2587 * @atomicservice 2588 * @since 20 2589 * @arkts 1.2 2590 */ 2591 set antialias(antialias: boolean | undefined); 2592 2593 /** 2594 * Create an RenderingContextSettings object based on the antialias and alpha. 2595 * 2596 * @param { boolean } antialias - Indicates whether anti-aliasing is enabled for canvas 2597 * @syscap SystemCapability.ArkUI.ArkUI.Full 2598 * @since 8 2599 */ 2600 /** 2601 * Create an RenderingContextSettings object based on the antialias and alpha. 2602 * 2603 * @param { boolean } antialias - Indicates whether anti-aliasing is enabled for canvas 2604 * @syscap SystemCapability.ArkUI.ArkUI.Full 2605 * @form 2606 * @since 9 2607 */ 2608 /** 2609 * Create an RenderingContextSettings object based on the antialias and alpha. 2610 * 2611 * @param { boolean } antialias - Indicates whether anti-aliasing is enabled for canvas 2612 * @syscap SystemCapability.ArkUI.ArkUI.Full 2613 * @crossplatform 2614 * @form 2615 * @since 10 2616 */ 2617 /** 2618 * Create an RenderingContextSettings object based on the antialias and alpha. 2619 * 2620 * @param { boolean } antialias - Indicates whether anti-aliasing is enabled for canvas 2621 * @syscap SystemCapability.ArkUI.ArkUI.Full 2622 * @crossplatform 2623 * @form 2624 * @atomicservice 2625 * @since arkts {'1.1':'11','1.2':'20'} 2626 * @arkts 1.1&1.2 2627 */ 2628 constructor(antialias?: boolean); 2629} 2630 2631/** 2632 * Canvas renderer for drawing shapes, text, images and other objects 2633 * 2634 * @extends CanvasPath 2635 * @syscap SystemCapability.ArkUI.ArkUI.Full 2636 * @since 8 2637 */ 2638/** 2639 * Canvas renderer for drawing shapes, text, images and other objects 2640 * 2641 * @extends CanvasPath 2642 * @syscap SystemCapability.ArkUI.ArkUI.Full 2643 * @form 2644 * @since 9 2645 */ 2646/** 2647 * Canvas renderer for drawing shapes, text, images and other objects 2648 * 2649 * @extends CanvasPath 2650 * @syscap SystemCapability.ArkUI.ArkUI.Full 2651 * @crossplatform 2652 * @form 2653 * @since 10 2654 */ 2655/** 2656 * Canvas renderer for drawing shapes, text, images and other objects 2657 * 2658 * @extends CanvasPath 2659 * @syscap SystemCapability.ArkUI.ArkUI.Full 2660 * @crossplatform 2661 * @form 2662 * @atomicservice 2663 * @since arkts {'1.1':'11','1.2':'20'} 2664 * @arkts 1.1&1.2 2665 */ 2666declare class CanvasRenderer extends CanvasPath { 2667 /** 2668 * Set spacing for letter. 2669 * 2670 * @type { LengthMetrics | string } 2671 * @default 0vp 2672 * @syscap SystemCapability.ArkUI.ArkUI.Full 2673 * @crossplatform 2674 * @atomicservice 2675 * @since 18 2676 */ 2677 letterSpacing: LengthMetrics | string; 2678 2679 /** 2680 * Get spacing for letter. 2681 * 2682 * @return { LengthMetrics | string } 2683 * @syscap SystemCapability.ArkUI.ArkUI.Full 2684 * @crossplatform 2685 * @atomicservice 2686 * @since 20 2687 * @arkts 1.2 2688 */ 2689 get letterSpacing(): LengthMetrics | string; 2690 2691 /** 2692 * Set spacing for letter. 2693 * 2694 * @param { LengthMetrics | string } 2695 * @syscap SystemCapability.ArkUI.ArkUI.Full 2696 * @crossplatform 2697 * @atomicservice 2698 * @since 20 2699 * @arkts 1.2 2700 */ 2701 set letterSpacing(letterSpacing: LengthMetrics | string); 2702 2703 /** 2704 * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2705 * If the value is out of range, the assignment is invalid. 2706 * 2707 * @type { number } 2708 * @default 1.0 2709 * @syscap SystemCapability.ArkUI.ArkUI.Full 2710 * @since 8 2711 */ 2712 /** 2713 * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2714 * If the value is out of range, the assignment is invalid. 2715 * 2716 * @type { number } 2717 * @default 1.0 2718 * @syscap SystemCapability.ArkUI.ArkUI.Full 2719 * @form 2720 * @since 9 2721 */ 2722 /** 2723 * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2724 * If the value is out of range, the assignment is invalid. 2725 * 2726 * @type { number } 2727 * @default 1.0 2728 * @syscap SystemCapability.ArkUI.ArkUI.Full 2729 * @crossplatform 2730 * @form 2731 * @since 10 2732 */ 2733 /** 2734 * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2735 * If the value is out of range, the assignment is invalid. 2736 * 2737 * @type { number } 2738 * @default 1.0 2739 * @syscap SystemCapability.ArkUI.ArkUI.Full 2740 * @crossplatform 2741 * @form 2742 * @atomicservice 2743 * @since 11 2744 */ 2745 globalAlpha: number; 2746 2747 /** 2748 * Get transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2749 * If the value is out of range, the assignment is invalid. 2750 * 2751 * @return { number } 2752 * @syscap SystemCapability.ArkUI.ArkUI.Full 2753 * @crossplatform 2754 * @form 2755 * @atomicservice 2756 * @since 20 2757 * @arkts 1.2 2758 */ 2759 get globalAlpha(): number; 2760 2761 /** 2762 * Set transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). 2763 * If the value is out of range, the assignment is invalid. 2764 * 2765 * @param { number } 2766 * @syscap SystemCapability.ArkUI.ArkUI.Full 2767 * @crossplatform 2768 * @form 2769 * @atomicservice 2770 * @since 20 2771 * @arkts 1.2 2772 */ 2773 set globalAlpha(globalAlpha: number); 2774 2775 /** 2776 * Type of composition operation applied when drawing a new shape. The following types are supported: 2777 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2778 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2779 * Everything else is transparent. 2780 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2781 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2782 * destination-over: Draws a new graphic behind the existing canvas content. 2783 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2784 * Everything else is transparent. 2785 * destination-out: Existing content remains where the new drawing does not overlap. 2786 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2787 * which is drawn behind the canvas content. 2788 * lighter: The color of two overlapping shapes is determined by adding the color values. 2789 * copy: Only new graphics are displayed. 2790 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2791 * 2792 * @type { string } 2793 * @default source-over 2794 * @syscap SystemCapability.ArkUI.ArkUI.Full 2795 * @since 8 2796 */ 2797 /** 2798 * Type of composition operation applied when drawing a new shape. The following types are supported: 2799 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2800 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2801 * Everything else is transparent. 2802 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2803 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2804 * destination-over: Draws a new graphic behind the existing canvas content. 2805 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2806 * Everything else is transparent. 2807 * destination-out: Existing content remains where the new drawing does not overlap. 2808 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2809 * which is drawn behind the canvas content. 2810 * lighter: The color of two overlapping shapes is determined by adding the color values. 2811 * copy: Only new graphics are displayed. 2812 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2813 * 2814 * @type { string } 2815 * @default source-over 2816 * @syscap SystemCapability.ArkUI.ArkUI.Full 2817 * @form 2818 * @since 9 2819 */ 2820 /** 2821 * Type of composition operation applied when drawing a new shape. The following types are supported: 2822 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2823 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2824 * Everything else is transparent. 2825 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2826 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2827 * destination-over: Draws a new graphic behind the existing canvas content. 2828 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2829 * Everything else is transparent. 2830 * destination-out: Existing content remains where the new drawing does not overlap. 2831 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2832 * which is drawn behind the canvas content. 2833 * lighter: The color of two overlapping shapes is determined by adding the color values. 2834 * copy: Only new graphics are displayed. 2835 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2836 * 2837 * @type { string } 2838 * @default source-over 2839 * @syscap SystemCapability.ArkUI.ArkUI.Full 2840 * @crossplatform 2841 * @form 2842 * @since 10 2843 */ 2844 /** 2845 * Type of composition operation applied when drawing a new shape. The following types are supported: 2846 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2847 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2848 * Everything else is transparent. 2849 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2850 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2851 * destination-over: Draws a new graphic behind the existing canvas content. 2852 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2853 * Everything else is transparent. 2854 * destination-out: Existing content remains where the new drawing does not overlap. 2855 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2856 * which is drawn behind the canvas content. 2857 * lighter: The color of two overlapping shapes is determined by adding the color values. 2858 * copy: Only new graphics are displayed. 2859 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2860 * 2861 * @type { string } 2862 * @default source-over 2863 * @syscap SystemCapability.ArkUI.ArkUI.Full 2864 * @crossplatform 2865 * @form 2866 * @atomicservice 2867 * @since 11 2868 */ 2869 globalCompositeOperation: string; 2870 2871 /** 2872 * Get the type of composition operation applied when drawing a new shape. The following types are supported: 2873 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2874 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2875 * Everything else is transparent. 2876 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2877 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2878 * destination-over: Draws a new graphic behind the existing canvas content. 2879 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2880 * Everything else is transparent. 2881 * destination-out: Existing content remains where the new drawing does not overlap. 2882 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2883 * which is drawn behind the canvas content. 2884 * lighter: The color of two overlapping shapes is determined by adding the color values. 2885 * copy: Only new graphics are displayed. 2886 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2887 * 2888 * @return { string } 2889 * @syscap SystemCapability.ArkUI.ArkUI.Full 2890 * @crossplatform 2891 * @form 2892 * @atomicservice 2893 * @since 20 2894 * @arkts 1.2 2895 */ 2896 get globalCompositeOperation(): string; 2897 2898 /** 2899 * Set the type of composition operation applied when drawing a new shape. The following types are supported: 2900 * source-over: (Default) Draws a new drawing on top of an existing canvas context. 2901 * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. 2902 * Everything else is transparent. 2903 * source-out: Draws a new drawing where it does not overlap with the existing canvas content. 2904 * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. 2905 * destination-over: Draws a new graphic behind the existing canvas content. 2906 * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. 2907 * Everything else is transparent. 2908 * destination-out: Existing content remains where the new drawing does not overlap. 2909 * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, 2910 * which is drawn behind the canvas content. 2911 * lighter: The color of two overlapping shapes is determined by adding the color values. 2912 * copy: Only new graphics are displayed. 2913 * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. 2914 * 2915 * @param { string } 2916 * @syscap SystemCapability.ArkUI.ArkUI.Full 2917 * @crossplatform 2918 * @form 2919 * @atomicservice 2920 * @since 20 2921 * @arkts 1.2 2922 */ 2923 set globalCompositeOperation(globalCompositeOperation: string); 2924 2925 /** 2926 * Draw an image on a canvas 2927 * 2928 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2929 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2930 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2931 * @syscap SystemCapability.ArkUI.ArkUI.Full 2932 * @since 8 2933 */ 2934 /** 2935 * Draw an image on a canvas 2936 * 2937 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2938 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2939 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2940 * @syscap SystemCapability.ArkUI.ArkUI.Full 2941 * @form 2942 * @since 9 2943 */ 2944 /** 2945 * Draw an image on a canvas 2946 * 2947 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2948 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2949 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2950 * @syscap SystemCapability.ArkUI.ArkUI.Full 2951 * @crossplatform 2952 * @form 2953 * @since 10 2954 */ 2955 /** 2956 * Draw an image on a canvas 2957 * 2958 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2959 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2960 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2961 * @syscap SystemCapability.ArkUI.ArkUI.Full 2962 * @crossplatform 2963 * @form 2964 * @atomicservice 2965 * @since arkts {'1.1':'11','1.2':'20'} 2966 * @arkts 1.1&1.2 2967 */ 2968 drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number): void; 2969 2970 /** 2971 * Draw an image on a canvas 2972 * 2973 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2974 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2975 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2976 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 2977 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 2978 * @syscap SystemCapability.ArkUI.ArkUI.Full 2979 * @since 8 2980 */ 2981 /** 2982 * Draw an image on a canvas 2983 * 2984 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2985 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2986 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2987 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 2988 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 2989 * @syscap SystemCapability.ArkUI.ArkUI.Full 2990 * @form 2991 * @since 9 2992 */ 2993 /** 2994 * Draw an image on a canvas 2995 * 2996 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 2997 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 2998 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 2999 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3000 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3001 * @syscap SystemCapability.ArkUI.ArkUI.Full 3002 * @crossplatform 3003 * @form 3004 * @since 10 3005 */ 3006 /** 3007 * Draw an image on a canvas 3008 * 3009 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 3010 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 3011 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 3012 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3013 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3014 * @syscap SystemCapability.ArkUI.ArkUI.Full 3015 * @crossplatform 3016 * @form 3017 * @atomicservice 3018 * @since arkts {'1.1':'11','1.2':'20'} 3019 * @arkts 1.1&1.2 3020 */ 3021 drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number, dw: number, dh: number): void; 3022 3023 /** 3024 *Draw an image on a canvas 3025 * 3026 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 3027 * @param { number } sx - x coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3028 * @param { number } sy - y coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3029 * @param { number } sw - Width of the rectangle (cropping) selection box of the image. 3030 * @param { number } sh - Height of the rectangle (cropping) selection box of the image. 3031 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 3032 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 3033 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3034 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3035 * @syscap SystemCapability.ArkUI.ArkUI.Full 3036 * @since 8 3037 */ 3038 /** 3039 *Draw an image on a canvas 3040 * 3041 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 3042 * @param { number } sx - x coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3043 * @param { number } sy - y coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3044 * @param { number } sw - Width of the rectangle (cropping) selection box of the image. 3045 * @param { number } sh - Height of the rectangle (cropping) selection box of the image. 3046 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 3047 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 3048 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3049 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3050 * @syscap SystemCapability.ArkUI.ArkUI.Full 3051 * @form 3052 * @since 9 3053 */ 3054 /** 3055 *Draw an image on a canvas 3056 * 3057 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 3058 * @param { number } sx - x coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3059 * @param { number } sy - y coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3060 * @param { number } sw - Width of the rectangle (cropping) selection box of the image. 3061 * @param { number } sh - Height of the rectangle (cropping) selection box of the image. 3062 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 3063 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 3064 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3065 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3066 * @syscap SystemCapability.ArkUI.ArkUI.Full 3067 * @crossplatform 3068 * @form 3069 * @since 10 3070 */ 3071 /** 3072 *Draw an image on a canvas 3073 * 3074 * @param { ImageBitmap | PixelMap } image - Picture objects drawn to the canvas. 3075 * @param { number } sx - x coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3076 * @param { number } sy - y coordinate of the upper left corner of the rectangle (cropping) selection box of the image. 3077 * @param { number } sw - Width of the rectangle (cropping) selection box of the image. 3078 * @param { number } sh - Height of the rectangle (cropping) selection box of the image. 3079 * @param { number } dx - x-axis coordinate of the upper left corner of the image on the target canvas. 3080 * @param { number } dy - y-axis coordinate of the upper left corner of the image on the target canvas. 3081 * @param { number } dw - Specifies the drawing width of the image on the target canvas. The width of the drawn image will be scaled. 3082 * @param { number } dh - Specifies the drawing height of the image on the target canvas. The height of the drawn image will be scaled. 3083 * @syscap SystemCapability.ArkUI.ArkUI.Full 3084 * @crossplatform 3085 * @form 3086 * @atomicservice 3087 * @since arkts {'1.1':'11','1.2':'20'} 3088 * @arkts 1.1&1.2 3089 */ 3090 drawImage( 3091 image: ImageBitmap | PixelMap, 3092 sx: number, 3093 sy: number, 3094 sw: number, 3095 sh: number, 3096 dx: number, 3097 dy: number, 3098 dw: number, 3099 dh: number, 3100 ): void; 3101 3102 /** 3103 * Clear the sub-path list and start a new path. 3104 * 3105 * @syscap SystemCapability.ArkUI.ArkUI.Full 3106 * @since 8 3107 */ 3108 /** 3109 * Clear the sub-path list and start a new path. 3110 * 3111 * @syscap SystemCapability.ArkUI.ArkUI.Full 3112 * @form 3113 * @since 9 3114 */ 3115 /** 3116 * Clear the sub-path list and start a new path. 3117 * 3118 * @syscap SystemCapability.ArkUI.ArkUI.Full 3119 * @crossplatform 3120 * @form 3121 * @since 10 3122 */ 3123 /** 3124 * Clear the sub-path list and start a new path. 3125 * 3126 * @syscap SystemCapability.ArkUI.ArkUI.Full 3127 * @crossplatform 3128 * @form 3129 * @atomicservice 3130 * @since arkts {'1.1':'11','1.2':'20'} 3131 * @arkts 1.1&1.2 3132 */ 3133 beginPath(): void; 3134 3135 /** 3136 * Sets the currently created path as the current clipping path 3137 * 3138 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3139 * @syscap SystemCapability.ArkUI.ArkUI.Full 3140 * @since 8 3141 */ 3142 /** 3143 * Sets the currently created path as the current clipping path 3144 * 3145 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3146 * @syscap SystemCapability.ArkUI.ArkUI.Full 3147 * @form 3148 * @since 9 3149 */ 3150 /** 3151 * Sets the currently created path as the current clipping path 3152 * 3153 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3154 * @syscap SystemCapability.ArkUI.ArkUI.Full 3155 * @crossplatform 3156 * @form 3157 * @since 10 3158 */ 3159 /** 3160 * Sets the currently created path as the current clipping path 3161 * 3162 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3163 * @syscap SystemCapability.ArkUI.ArkUI.Full 3164 * @crossplatform 3165 * @form 3166 * @atomicservice 3167 * @since arkts {'1.1':'11','1.2':'20'} 3168 * @arkts 1.1&1.2 3169 */ 3170 clip(fillRule?: CanvasFillRule): void; 3171 3172 /** 3173 * Tailoring according to the specified path 3174 * 3175 * @param { Path2D } path - Path to be cut. 3176 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3177 * @syscap SystemCapability.ArkUI.ArkUI.Full 3178 * @since 8 3179 */ 3180 /** 3181 * Tailoring according to the specified path 3182 * 3183 * @param { Path2D } path - Path to be cut. 3184 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3185 * @syscap SystemCapability.ArkUI.ArkUI.Full 3186 * @form 3187 * @since 9 3188 */ 3189 /** 3190 * Tailoring according to the specified path 3191 * 3192 * @param { Path2D } path - Path to be cut. 3193 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3194 * @syscap SystemCapability.ArkUI.ArkUI.Full 3195 * @crossplatform 3196 * @form 3197 * @since 10 3198 */ 3199 /** 3200 * Tailoring according to the specified path 3201 * 3202 * @param { Path2D } path - Path to be cut. 3203 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3204 * @syscap SystemCapability.ArkUI.ArkUI.Full 3205 * @crossplatform 3206 * @form 3207 * @atomicservice 3208 * @since arkts {'1.1':'11','1.2':'20'} 3209 * @arkts 1.1&1.2 3210 */ 3211 clip(path: Path2D, fillRule?: CanvasFillRule): void; 3212 3213 /** 3214 * Fills existing paths according to the current fill style. 3215 * 3216 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3217 * @syscap SystemCapability.ArkUI.ArkUI.Full 3218 * @since 8 3219 */ 3220 /** 3221 * Fills existing paths according to the current fill style. 3222 * 3223 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3224 * @syscap SystemCapability.ArkUI.ArkUI.Full 3225 * @form 3226 * @since 9 3227 */ 3228 /** 3229 * Fills existing paths according to the current fill style. 3230 * 3231 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3232 * @syscap SystemCapability.ArkUI.ArkUI.Full 3233 * @crossplatform 3234 * @form 3235 * @since 10 3236 */ 3237 /** 3238 * Fills existing paths according to the current fill style. 3239 * 3240 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3241 * @syscap SystemCapability.ArkUI.ArkUI.Full 3242 * @crossplatform 3243 * @form 3244 * @atomicservice 3245 * @since arkts {'1.1':'11','1.2':'20'} 3246 * @arkts 1.1&1.2 3247 */ 3248 fill(fillRule?: CanvasFillRule): void; 3249 3250 /** 3251 * Fills the specified path according to the current fill style 3252 * 3253 * @param { Path2D } path - Path to be filled. 3254 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3255 * @syscap SystemCapability.ArkUI.ArkUI.Full 3256 * @since 8 3257 */ 3258 /** 3259 * Fills the specified path according to the current fill style 3260 * 3261 * @param { Path2D } path - Path to be filled. 3262 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3263 * @syscap SystemCapability.ArkUI.ArkUI.Full 3264 * @form 3265 * @since 9 3266 */ 3267 /** 3268 * Fills the specified path according to the current fill style 3269 * 3270 * @param { Path2D } path - Path to be filled. 3271 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3272 * @syscap SystemCapability.ArkUI.ArkUI.Full 3273 * @crossplatform 3274 * @form 3275 * @since 10 3276 */ 3277 /** 3278 * Fills the specified path according to the current fill style 3279 * 3280 * @param { Path2D } path - Path to be filled. 3281 * @param { CanvasFillRule } fillRule - Algorithm rule. For details, see {@link CanvasFillRule}. 3282 * @syscap SystemCapability.ArkUI.ArkUI.Full 3283 * @crossplatform 3284 * @form 3285 * @atomicservice 3286 * @since arkts {'1.1':'11','1.2':'20'} 3287 * @arkts 1.1&1.2 3288 */ 3289 fill(path: Path2D, fillRule?: CanvasFillRule): void; 3290 3291 /** 3292 * Draws an existing path according to the current stroke style. 3293 * 3294 * @syscap SystemCapability.ArkUI.ArkUI.Full 3295 * @since 8 3296 */ 3297 /** 3298 * Draws an existing path according to the current stroke style. 3299 * 3300 * @syscap SystemCapability.ArkUI.ArkUI.Full 3301 * @form 3302 * @since 9 3303 */ 3304 /** 3305 * Draws an existing path according to the current stroke style. 3306 * 3307 * @syscap SystemCapability.ArkUI.ArkUI.Full 3308 * @crossplatform 3309 * @form 3310 * @since 10 3311 */ 3312 /** 3313 * Draws an existing path according to the current stroke style. 3314 * 3315 * @syscap SystemCapability.ArkUI.ArkUI.Full 3316 * @crossplatform 3317 * @form 3318 * @atomicservice 3319 * @since 11 3320 */ 3321 stroke(): void; 3322 3323 /** 3324 * Draws the specified path according to the current stroke style 3325 * 3326 * @param { Path2D } path - Specified stroke path object 3327 * @syscap SystemCapability.ArkUI.ArkUI.Full 3328 * @since 8 3329 */ 3330 /** 3331 * Draws the specified path according to the current stroke style 3332 * 3333 * @param { Path2D } path - Specified stroke path object 3334 * @syscap SystemCapability.ArkUI.ArkUI.Full 3335 * @form 3336 * @since 9 3337 */ 3338 /** 3339 * Draws the specified path according to the current stroke style 3340 * 3341 * @param { Path2D } path - Specified stroke path object 3342 * @syscap SystemCapability.ArkUI.ArkUI.Full 3343 * @crossplatform 3344 * @form 3345 * @since 10 3346 */ 3347 /** 3348 * Draws the specified path according to the current stroke style 3349 * 3350 * @param { Path2D } path - Specified stroke path object 3351 * @syscap SystemCapability.ArkUI.ArkUI.Full 3352 * @crossplatform 3353 * @form 3354 * @atomicservice 3355 * @since 11 3356 */ 3357 stroke(path: Path2D): void; 3358 3359 /** 3360 * Draws the specified path according to the current stroke style 3361 * 3362 * @param { Path2D } [path] - Specified stroke path object 3363 * @syscap SystemCapability.ArkUI.ArkUI.Full 3364 * @crossplatform 3365 * @form 3366 * @atomicservice 3367 * @since 20 3368 * @arkts 1.2 3369 */ 3370 stroke(path?: Path2D): void; 3371 3372 /** 3373 * Attributes that describe the fill color and style. The options are as follows: 3374 * color: Color String 3375 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3376 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3377 * 3378 * @type { string | CanvasGradient | CanvasPattern } 3379 * @default #000000 (black) 3380 * @syscap SystemCapability.ArkUI.ArkUI.Full 3381 * @since 8 3382 */ 3383 /** 3384 * Attributes that describe the fill color and style. The options are as follows: 3385 * color: Color String 3386 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3387 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3388 * 3389 * @type { string | CanvasGradient | CanvasPattern } 3390 * @default #000000 (black) 3391 * @syscap SystemCapability.ArkUI.ArkUI.Full 3392 * @form 3393 * @since 9 3394 */ 3395 /** 3396 * Attributes that describe the fill color and style. The options are as follows: 3397 * 3398 * @type { string | number | CanvasGradient | CanvasPattern } 3399 * string: Color String. 3400 * number: Indicates the color with number. 3401 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3402 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3403 * @default #000000 (black) 3404 * @syscap SystemCapability.ArkUI.ArkUI.Full 3405 * @crossplatform 3406 * @form 3407 * @since 10 3408 */ 3409 /** 3410 * Attributes that describe the fill color and style. The options are as follows: 3411 * 3412 * @type { string | number | CanvasGradient | CanvasPattern } 3413 * string: Color String. 3414 * number: Indicates the color with number. 3415 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3416 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3417 * @default #000000 (black) 3418 * @syscap SystemCapability.ArkUI.ArkUI.Full 3419 * @crossplatform 3420 * @form 3421 * @atomicservice 3422 * @since 11 3423 */ 3424 fillStyle: string | number | CanvasGradient | CanvasPattern; 3425 3426 /** 3427 * Get the attributes specifie the color, gradient, or pattern to use inside shapes. The options are as follows: 3428 * 3429 * @return { string | number | CanvasGradient | CanvasPattern } 3430 * string: Color String. 3431 * number: Indicates the color with number. 3432 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3433 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3434 * @syscap SystemCapability.ArkUI.ArkUI.Full 3435 * @crossplatform 3436 * @form 3437 * @atomicservice 3438 * @since 20 3439 * @arkts 1.2 3440 */ 3441 get fillStyle(): string | number | CanvasGradient | CanvasPattern; 3442 3443 /** 3444 * Set the attributes specifie the color, gradient, or pattern to use inside shapes. The options are as follows: 3445 * 3446 * @param { string | number | CanvasGradient | CanvasPattern } 3447 * string: Color String. 3448 * number: Indicates the color with number. 3449 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3450 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3451 * @syscap SystemCapability.ArkUI.ArkUI.Full 3452 * @crossplatform 3453 * @form 3454 * @atomicservice 3455 * @since 20 3456 * @arkts 1.2 3457 */ 3458 set fillStyle(fillStyle: string | number | CanvasGradient | CanvasPattern); 3459 3460 /** 3461 * Attributes of the stroke color and style. The options are as follows: 3462 * color: Color String 3463 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3464 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3465 * 3466 * @type { string | CanvasGradient | CanvasPattern } 3467 * @default #000000 (black) 3468 * @syscap SystemCapability.ArkUI.ArkUI.Full 3469 * @since 8 3470 */ 3471 /** 3472 * Attributes of the stroke color and style. The options are as follows: 3473 * color: Color String 3474 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3475 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3476 * 3477 * @type { string | CanvasGradient | CanvasPattern } 3478 * @default #000000 (black) 3479 * @syscap SystemCapability.ArkUI.ArkUI.Full 3480 * @form 3481 * @since 9 3482 */ 3483 /** 3484 * Attributes of the stroke color and style. The options are as follows: 3485 * 3486 * @type { string | number | CanvasGradient | CanvasPattern } 3487 * string: Color String. 3488 * number: Indicates the color with number. 3489 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3490 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3491 * @default #000000 (black) 3492 * @syscap SystemCapability.ArkUI.ArkUI.Full 3493 * @crossplatform 3494 * @form 3495 * @since 10 3496 */ 3497 /** 3498 * Attributes of the stroke color and style. The options are as follows: 3499 * 3500 * @type { string | number | CanvasGradient | CanvasPattern } 3501 * string: Color String. 3502 * number: Indicates the color with number. 3503 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3504 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3505 * @default #000000 (black) 3506 * @syscap SystemCapability.ArkUI.ArkUI.Full 3507 * @crossplatform 3508 * @form 3509 * @atomicservice 3510 * @since 11 3511 */ 3512 strokeStyle: string | number | CanvasGradient | CanvasPattern; 3513 3514 /** 3515 * Get the attributes specifie the color, gradient, or pattern to use for the strokes (outlines) around shapes. 3516 * The options are as follows: 3517 * 3518 * @return { string | number | CanvasGradient | CanvasPattern } 3519 * string: Color String. 3520 * number: Indicates the color with number. 3521 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3522 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3523 * @syscap SystemCapability.ArkUI.ArkUI.Full 3524 * @crossplatform 3525 * @form 3526 * @atomicservice 3527 * @since 20 3528 * @arkts 1.2 3529 */ 3530 get strokeStyle(): string | number | CanvasGradient | CanvasPattern; 3531 3532 /** 3533 * Set the attributes specifie the color, gradient, or pattern to use for the strokes (outlines) around shapes. 3534 * The options are as follows: 3535 * 3536 * @param { string | number | CanvasGradient | CanvasPattern } 3537 * string: Color String. 3538 * number: Indicates the color with number. 3539 * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. 3540 * CanvasPattern: Template object. For details, see {@link CanvasPattern}. 3541 * @syscap SystemCapability.ArkUI.ArkUI.Full 3542 * @crossplatform 3543 * @form 3544 * @atomicservice 3545 * @since 20 3546 * @arkts 1.2 3547 */ 3548 set strokeStyle(strokeStyle: string | number | CanvasGradient | CanvasPattern); 3549 3550 /** 3551 * Creates a linear gradient object that is specified along the parameter coordinates 3552 * 3553 * @param { number } x0 - The x-axis coordinate of the start point. 3554 * @param { number } y0 - The y-axis coordinate of the start point. 3555 * @param { number } x1 - x-axis coordinate of the end point. 3556 * @param { number } y1 - y-axis coordinate of the end point. 3557 * @returns { CanvasGradient } 3558 * @syscap SystemCapability.ArkUI.ArkUI.Full 3559 * @since 8 3560 */ 3561 /** 3562 * Creates a linear gradient object that is specified along the parameter coordinates 3563 * 3564 * @param { number } x0 - The x-axis coordinate of the start point. 3565 * @param { number } y0 - The y-axis coordinate of the start point. 3566 * @param { number } x1 - x-axis coordinate of the end point. 3567 * @param { number } y1 - y-axis coordinate of the end point. 3568 * @returns { CanvasGradient } 3569 * @syscap SystemCapability.ArkUI.ArkUI.Full 3570 * @form 3571 * @since 9 3572 */ 3573 /** 3574 * Creates a linear gradient object that is specified along the parameter coordinates 3575 * 3576 * @param { number } x0 - The x-axis coordinate of the start point. 3577 * @param { number } y0 - The y-axis coordinate of the start point. 3578 * @param { number } x1 - x-axis coordinate of the end point. 3579 * @param { number } y1 - y-axis coordinate of the end point. 3580 * @returns { CanvasGradient } 3581 * @syscap SystemCapability.ArkUI.ArkUI.Full 3582 * @crossplatform 3583 * @form 3584 * @since 10 3585 */ 3586 /** 3587 * Creates a linear gradient object that is specified along the parameter coordinates 3588 * 3589 * @param { number } x0 - The x-axis coordinate of the start point. 3590 * @param { number } y0 - The y-axis coordinate of the start point. 3591 * @param { number } x1 - x-axis coordinate of the end point. 3592 * @param { number } y1 - y-axis coordinate of the end point. 3593 * @returns { CanvasGradient } 3594 * @syscap SystemCapability.ArkUI.ArkUI.Full 3595 * @crossplatform 3596 * @form 3597 * @atomicservice 3598 * @since arkts {'1.1':'11','1.2':'20'} 3599 * @arkts 1.1&1.2 3600 */ 3601 createLinearGradient(x0: number, y0: number, x1: number, y1: number): CanvasGradient; 3602 3603 /** 3604 * Creates a template object using the specified image 3605 * 3606 * @param { ImageBitmap } image - Objects as duplicate image sources 3607 * @param { string | null } repetition - Specifies how to repeat images. The following four modes are supported: 3608 * "repeat": Repeated images in both X and Y directions 3609 * "repeat-x": Repeated images in the X-axis direction but not in the Y-axis direction 3610 * "repeat-y": The image is repeated in the Y axis direction, and the image is not repeated in the X axis direction. 3611 * "no-repeat": Non-repeating images in both X and Y directions 3612 * @returns { CanvasPattern | null } 3613 * @syscap SystemCapability.ArkUI.ArkUI.Full 3614 * @since 8 3615 */ 3616 /** 3617 * Creates a template object using the specified image 3618 * 3619 * @param { ImageBitmap } image - Objects as duplicate image sources 3620 * @param { string | null } repetition - Specifies how to repeat images. The following four modes are supported: 3621 * "repeat": Repeated images in both X and Y directions 3622 * "repeat-x": Repeated images in the X-axis direction but not in the Y-axis direction 3623 * "repeat-y": The image is repeated in the Y axis direction, and the image is not repeated in the X axis direction. 3624 * "no-repeat": Non-repeating images in both X and Y directions 3625 * @returns { CanvasPattern | null } 3626 * @syscap SystemCapability.ArkUI.ArkUI.Full 3627 * @form 3628 * @since 9 3629 */ 3630 /** 3631 * Creates a template object using the specified image 3632 * 3633 * @param { ImageBitmap } image - Objects as duplicate image sources 3634 * @param { string | null } repetition - Specifies how to repeat images. The following four modes are supported: 3635 * "repeat": Repeated images in both X and Y directions 3636 * "repeat-x": Repeated images in the X-axis direction but not in the Y-axis direction 3637 * "repeat-y": The image is repeated in the Y axis direction, and the image is not repeated in the X axis direction. 3638 * "no-repeat": Non-repeating images in both X and Y directions 3639 * "clamp": Replicate the edge color if the shader draws outside of its original bounds. 3640 * "mirror": Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam. 3641 * @returns { CanvasPattern | null } 3642 * @syscap SystemCapability.ArkUI.ArkUI.Full 3643 * @crossplatform 3644 * @form 3645 * @since 10 3646 */ 3647 /** 3648 * Creates a template object using the specified image 3649 * 3650 * @param { ImageBitmap } image - Objects as duplicate image sources 3651 * @param { string | null } repetition - Specifies how to repeat images. The following four modes are supported: 3652 * "repeat": Repeated images in both X and Y directions 3653 * "repeat-x": Repeated images in the X-axis direction but not in the Y-axis direction 3654 * "repeat-y": The image is repeated in the Y axis direction, and the image is not repeated in the X axis direction. 3655 * "no-repeat": Non-repeating images in both X and Y directions 3656 * "clamp": Replicate the edge color if the shader draws outside of its original bounds. 3657 * "mirror": Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam. 3658 * @returns { CanvasPattern | null } 3659 * @syscap SystemCapability.ArkUI.ArkUI.Full 3660 * @crossplatform 3661 * @form 3662 * @atomicservice 3663 * @since arkts {'1.1':'11','1.2':'20'} 3664 * @arkts 1.1&1.2 3665 */ 3666 createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | null; 3667 3668 /** 3669 * Creates a radioactive gradient object based on parameters that determine the coordinates of two circles 3670 * 3671 * @param { number } x0 - The x-axis coordinate of the start circle. 3672 * @param { number } y0 - The y-axis coordinate of the start circle. 3673 * @param { number } r0 - Radius of the starting circle. 3674 * @param { number } x1 - The x-axis coordinate of the end circle. 3675 * @param { number } y1 - The y-axis coordinate of the end circle. 3676 * @param { number } r1 - Radius of the end circle. 3677 * @returns { CanvasGradient } 3678 * @syscap SystemCapability.ArkUI.ArkUI.Full 3679 * @since 8 3680 */ 3681 /** 3682 * Creates a radioactive gradient object based on parameters that determine the coordinates of two circles 3683 * 3684 * @param { number } x0 - The x-axis coordinate of the start circle. 3685 * @param { number } y0 - The y-axis coordinate of the start circle. 3686 * @param { number } r0 - Radius of the starting circle. 3687 * @param { number } x1 - The x-axis coordinate of the end circle. 3688 * @param { number } y1 - The y-axis coordinate of the end circle. 3689 * @param { number } r1 - Radius of the end circle. 3690 * @returns { CanvasGradient } 3691 * @syscap SystemCapability.ArkUI.ArkUI.Full 3692 * @form 3693 * @since 9 3694 */ 3695 /** 3696 * Creates a radioactive gradient object based on parameters that determine the coordinates of two circles 3697 * 3698 * @param { number } x0 - The x-axis coordinate of the start circle. 3699 * @param { number } y0 - The y-axis coordinate of the start circle. 3700 * @param { number } r0 - Radius of the starting circle. 3701 * @param { number } x1 - The x-axis coordinate of the end circle. 3702 * @param { number } y1 - The y-axis coordinate of the end circle. 3703 * @param { number } r1 - Radius of the end circle. 3704 * @returns { CanvasGradient } 3705 * @syscap SystemCapability.ArkUI.ArkUI.Full 3706 * @crossplatform 3707 * @form 3708 * @since 10 3709 */ 3710 /** 3711 * Creates a radioactive gradient object based on parameters that determine the coordinates of two circles 3712 * 3713 * @param { number } x0 - The x-axis coordinate of the start circle. 3714 * @param { number } y0 - The y-axis coordinate of the start circle. 3715 * @param { number } r0 - Radius of the starting circle. 3716 * @param { number } x1 - The x-axis coordinate of the end circle. 3717 * @param { number } y1 - The y-axis coordinate of the end circle. 3718 * @param { number } r1 - Radius of the end circle. 3719 * @returns { CanvasGradient } 3720 * @syscap SystemCapability.ArkUI.ArkUI.Full 3721 * @crossplatform 3722 * @form 3723 * @atomicservice 3724 * @since arkts {'1.1':'11','1.2':'20'} 3725 * @arkts 1.1&1.2 3726 */ 3727 createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): CanvasGradient; 3728 3729 /** 3730 * Creates a gradient around a point with given coordinates. 3731 * 3732 * @param { number } startAngle - The angle at which to begin the gradient, in radians. 3733 * Angle measurements start horizontally the right of the center and move around clockwise. 3734 * @param { number } x - The x-axis coordinate of the center of the gradient. 3735 * @param { number } y - The y-axis coordinate of the center of the gradient. 3736 * @returns { CanvasGradient } A CanvasGradient object that draws a conic gradient around the given coordinates. 3737 * @syscap SystemCapability.ArkUI.ArkUI.Full 3738 * @crossplatform 3739 * @since 10 3740 */ 3741 /** 3742 * Creates a gradient around a point with given coordinates. 3743 * 3744 * @param { number } startAngle - The angle at which to begin the gradient, in radians. 3745 * Angle measurements start horizontally the right of the center and move around clockwise. 3746 * @param { number } x - The x-axis coordinate of the center of the gradient. 3747 * @param { number } y - The y-axis coordinate of the center of the gradient. 3748 * @returns { CanvasGradient } A CanvasGradient object that draws a conic gradient around the given coordinates. 3749 * @syscap SystemCapability.ArkUI.ArkUI.Full 3750 * @crossplatform 3751 * @atomicservice 3752 * @since arkts {'1.1':'11','1.2':'20'} 3753 * @arkts 1.1&1.2 3754 */ 3755 createConicGradient( 3756 startAngle: number, 3757 x: number, 3758 y: number 3759 ): CanvasGradient; 3760 3761 /** 3762 * Provides filter effects such as blur and grayscale. You can set the following filter effects: 3763 * blur(<length>): Adds a Gaussian blur effect to the drawing 3764 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3765 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3766 * When the value is 100%, there is no change in the image. 3767 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3768 * When the value is 0%, there is no change in the image. 3769 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3770 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3771 * the image is completely inverted. When the value is 0%, there is no change in the image. 3772 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3773 * When the value is 100%, there is no change in the image. 3774 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3775 * When the value is 100%, there is no change in the image. 3776 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3777 * When the value is 0%, there is no change in the image. 3778 * none: Turn off filter effects 3779 * 3780 * @type { string } 3781 * @default none 3782 * @syscap SystemCapability.ArkUI.ArkUI.Full 3783 * @since 8 3784 */ 3785 /** 3786 * Provides filter effects such as blur and grayscale. You can set the following filter effects: 3787 * blur(<length>): Adds a Gaussian blur effect to the drawing 3788 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3789 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3790 * When the value is 100%, there is no change in the image. 3791 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3792 * When the value is 0%, there is no change in the image. 3793 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3794 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3795 * the image is completely inverted. When the value is 0%, there is no change in the image. 3796 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3797 * When the value is 100%, there is no change in the image. 3798 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3799 * When the value is 100%, there is no change in the image. 3800 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3801 * When the value is 0%, there is no change in the image. 3802 * none: Turn off filter effects 3803 * 3804 * @type { string } 3805 * @default none 3806 * @syscap SystemCapability.ArkUI.ArkUI.Full 3807 * @form 3808 * @since 9 3809 */ 3810 /** 3811 * Provides filter effects such as blur and grayscale. You can set the following filter effects: 3812 * blur(<length>): Adds a Gaussian blur effect to the drawing 3813 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3814 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3815 * When the value is 100%, there is no change in the image. 3816 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3817 * When the value is 0%, there is no change in the image. 3818 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3819 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3820 * the image is completely inverted. When the value is 0%, there is no change in the image. 3821 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3822 * When the value is 100%, there is no change in the image. 3823 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3824 * When the value is 100%, there is no change in the image. 3825 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3826 * When the value is 0%, there is no change in the image. 3827 * none: Turn off filter effects 3828 * 3829 * @type { string } 3830 * @default none 3831 * @syscap SystemCapability.ArkUI.ArkUI.Full 3832 * @crossplatform 3833 * @form 3834 * @since 10 3835 */ 3836 /** 3837 * Provides filter effects such as blur and grayscale. You can set the following filter effects: 3838 * blur(<length>): Adds a Gaussian blur effect to the drawing 3839 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3840 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3841 * When the value is 100%, there is no change in the image. 3842 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3843 * When the value is 0%, there is no change in the image. 3844 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3845 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3846 * the image is completely inverted. When the value is 0%, there is no change in the image. 3847 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3848 * When the value is 100%, there is no change in the image. 3849 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3850 * When the value is 100%, there is no change in the image. 3851 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3852 * When the value is 0%, there is no change in the image. 3853 * none: Turn off filter effects 3854 * 3855 * @type { string } 3856 * @default none 3857 * @syscap SystemCapability.ArkUI.ArkUI.Full 3858 * @crossplatform 3859 * @form 3860 * @atomicservice 3861 * @since 11 3862 */ 3863 filter: string; 3864 3865 /** 3866 * Provides filter effects such as blur and grayscale. You can get the following filter effects: 3867 * blur(<length>): Adds a Gaussian blur effect to the drawing 3868 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3869 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3870 * When the value is 100%, there is no change in the image. 3871 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3872 * When the value is 0%, there is no change in the image. 3873 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3874 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3875 * the image is completely inverted. When the value is 0%, there is no change in the image. 3876 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3877 * When the value is 100%, there is no change in the image. 3878 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3879 * When the value is 100%, there is no change in the image. 3880 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3881 * When the value is 0%, there is no change in the image. 3882 * none: Turn off filter effects 3883 * 3884 * @return { string } 3885 * @syscap SystemCapability.ArkUI.ArkUI.Full 3886 * @crossplatform 3887 * @form 3888 * @atomicservice 3889 * @since 20 3890 * @arkts 1.2 3891 */ 3892 get filter(): string; 3893 3894 /** 3895 * Provides filter effects such as blur and grayscale. You can set the following filter effects: 3896 * blur(<length>): Adds a Gaussian blur effect to the drawing 3897 * brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level. 3898 * contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black. 3899 * When the value is 100%, there is no change in the image. 3900 * grayscale(<percentage>): Converts the image to a gray image. When the value is 100%, the image is completely gray. 3901 * When the value is 0%, there is no change in the image. 3902 * hue-rotate(<degree>): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. 3903 * invert(<percentage>): Inverted image (representing the effect of a photographic negative). When the value is 100%, 3904 * the image is completely inverted. When the value is 0%, there is no change in the image. 3905 * opacity(<percentage>): Transparency of the image. At 0%, the image is completely transparent. 3906 * When the value is 100%, there is no change in the image. 3907 * saturate(<percentage>): Perform saturation processing on the image. At 0%, the image is completely un-saturated. 3908 * When the value is 100%, there is no change in the image. 3909 * sepia(<percentage>): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. 3910 * When the value is 0%, there is no change in the image. 3911 * none: Turn off filter effects 3912 * 3913 * @param { string } 3914 * @syscap SystemCapability.ArkUI.ArkUI.Full 3915 * @crossplatform 3916 * @form 3917 * @atomicservice 3918 * @since 20 3919 * @arkts 1.2 3920 */ 3921 set filter(filter: string); 3922 3923 /** 3924 * Creates a new, empty ImageData object of the specified size 3925 * 3926 * @param { number } sw - Width of the ImageData object. 3927 * @param { number } sh - Height of the ImageData object. 3928 * @returns { ImageData } 3929 * @syscap SystemCapability.ArkUI.ArkUI.Full 3930 * @since 8 3931 */ 3932 /** 3933 * Creates a new, empty ImageData object of the specified size 3934 * 3935 * @param { number } sw - Width of the ImageData object. 3936 * @param { number } sh - Height of the ImageData object. 3937 * @returns { ImageData } 3938 * @syscap SystemCapability.ArkUI.ArkUI.Full 3939 * @form 3940 * @since 9 3941 */ 3942 /** 3943 * Creates a new, empty ImageData object of the specified size 3944 * 3945 * @param { number } sw - Width of the ImageData object. 3946 * @param { number } sh - Height of the ImageData object. 3947 * @returns { ImageData } 3948 * @syscap SystemCapability.ArkUI.ArkUI.Full 3949 * @crossplatform 3950 * @form 3951 * @since 10 3952 */ 3953 /** 3954 * Creates a new, empty ImageData object of the specified size 3955 * 3956 * @param { number } sw - Width of the ImageData object. 3957 * @param { number } sh - Height of the ImageData object. 3958 * @returns { ImageData } 3959 * @syscap SystemCapability.ArkUI.ArkUI.Full 3960 * @crossplatform 3961 * @form 3962 * @atomicservice 3963 * @since arkts {'1.1':'11','1.2':'20'} 3964 * @arkts 1.1&1.2 3965 */ 3966 createImageData(sw: number, sh: number): ImageData; 3967 3968 /** 3969 * From an existing ImageData object, copy an object with the same width and height as the image. 3970 * The image content is not copied. 3971 * 3972 * @param { ImageData } imagedata - ImageData object to be copied. 3973 * @returns { ImageData } 3974 * @syscap SystemCapability.ArkUI.ArkUI.Full 3975 * @since 8 3976 */ 3977 /** 3978 * From an existing ImageData object, copy an object with the same width and height as the image. 3979 * The image content is not copied. 3980 * 3981 * @param { ImageData } imagedata - ImageData object to be copied. 3982 * @returns { ImageData } 3983 * @syscap SystemCapability.ArkUI.ArkUI.Full 3984 * @form 3985 * @since 9 3986 */ 3987 /** 3988 * From an existing ImageData object, copy an object with the same width and height as the image. 3989 * The image content is not copied. 3990 * 3991 * @param { ImageData } imagedata - ImageData object to be copied. 3992 * @returns { ImageData } 3993 * @syscap SystemCapability.ArkUI.ArkUI.Full 3994 * @crossplatform 3995 * @form 3996 * @since 10 3997 */ 3998 /** 3999 * From an existing ImageData object, copy an object with the same width and height as the image. 4000 * The image content is not copied. 4001 * 4002 * @param { ImageData } imagedata - ImageData object to be copied. 4003 * @returns { ImageData } 4004 * @syscap SystemCapability.ArkUI.ArkUI.Full 4005 * @crossplatform 4006 * @form 4007 * @atomicservice 4008 * @since arkts {'1.1':'11','1.2':'20'} 4009 * @arkts 1.1&1.2 4010 */ 4011 createImageData(imagedata: ImageData): ImageData; 4012 4013 /** 4014 * Obtains the pixel data of a specified area on the current canvas. 4015 * 4016 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4017 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4018 * @param { number } sw - The width of the rectangular area of the image data to be extracted. 4019 * @param { number } sh - The height of the rectangular area of the image data to be extracted. 4020 * @returns { ImageData } 4021 * @syscap SystemCapability.ArkUI.ArkUI.Full 4022 * @since 8 4023 */ 4024 /** 4025 * Obtains the pixel data of a specified area on the current canvas. 4026 * 4027 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4028 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4029 * @param { number } sw - The width of the rectangular area of the image data to be extracted. 4030 * @param { number } sh - The height of the rectangular area of the image data to be extracted. 4031 * @returns { ImageData } 4032 * @syscap SystemCapability.ArkUI.ArkUI.Full 4033 * @form 4034 * @since 9 4035 */ 4036 /** 4037 * Obtains the pixel data of a specified area on the current canvas. 4038 * 4039 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4040 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4041 * @param { number } sw - The width of the rectangular area of the image data to be extracted. 4042 * @param { number } sh - The height of the rectangular area of the image data to be extracted. 4043 * @returns { ImageData } 4044 * @syscap SystemCapability.ArkUI.ArkUI.Full 4045 * @crossplatform 4046 * @form 4047 * @since 10 4048 */ 4049 /** 4050 * Obtains the pixel data of a specified area on the current canvas. 4051 * 4052 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4053 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the image data to be extracted. 4054 * @param { number } sw - The width of the rectangular area of the image data to be extracted. 4055 * @param { number } sh - The height of the rectangular area of the image data to be extracted. 4056 * @returns { ImageData } 4057 * @syscap SystemCapability.ArkUI.ArkUI.Full 4058 * @crossplatform 4059 * @form 4060 * @atomicservice 4061 * @since arkts {'1.1':'11','1.2':'20'} 4062 * @arkts 1.1&1.2 4063 */ 4064 getImageData(sx: number, sy: number, sw: number, sh: number): ImageData; 4065 4066 /** 4067 * Obtains the PixelMap of a specified area on the current canvas. 4068 * 4069 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4070 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4071 * @param { number } sw - The width of the rectangular area of the PixelMap to be extracted. 4072 * @param { number } sh - The height of the rectangular area of the PixelMap to be extracted. 4073 * @returns { PixelMap } 4074 * @syscap SystemCapability.ArkUI.ArkUI.Full 4075 * @since 8 4076 */ 4077 /** 4078 * Obtains the PixelMap of a specified area on the current canvas. 4079 * 4080 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4081 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4082 * @param { number } sw - The width of the rectangular area of the PixelMap to be extracted. 4083 * @param { number } sh - The height of the rectangular area of the PixelMap to be extracted. 4084 * @returns { PixelMap } 4085 * @syscap SystemCapability.ArkUI.ArkUI.Full 4086 * @crossplatform 4087 * @since 10 4088 */ 4089 /** 4090 * Obtains the PixelMap of a specified area on the current canvas. 4091 * 4092 * @param { number } sx - x coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4093 * @param { number } sy - y coordinate of the upper left corner of the rectangular area of the PixelMap to be extracted. 4094 * @param { number } sw - The width of the rectangular area of the PixelMap to be extracted. 4095 * @param { number } sh - The height of the rectangular area of the PixelMap to be extracted. 4096 * @returns { PixelMap } 4097 * @syscap SystemCapability.ArkUI.ArkUI.Full 4098 * @crossplatform 4099 * @atomicservice 4100 * @since arkts {'1.1':'11','1.2':'20'} 4101 * @arkts 1.1&1.2 4102 */ 4103 getPixelMap(sx: number, sy: number, sw: number, sh: number): PixelMap; 4104 4105 /** 4106 * Draws the specified ImageData object onto the canvas 4107 * 4108 * @param { ImageData } imagedata - ImageData object to be drawn. 4109 * @param { number } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4110 * @param { number } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4111 * @syscap SystemCapability.ArkUI.ArkUI.Full 4112 * @since 8 4113 */ 4114 /** 4115 * Draws the specified ImageData object onto the canvas 4116 * 4117 * @param { ImageData } imagedata - ImageData object to be drawn. 4118 * @param { number } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4119 * @param { number } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4120 * @syscap SystemCapability.ArkUI.ArkUI.Full 4121 * @form 4122 * @since 9 4123 */ 4124 /** 4125 * Draws the specified ImageData object onto the canvas 4126 * 4127 * @param { ImageData } imagedata - ImageData object to be drawn. 4128 * @param { number | string } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4129 * @param { number | string } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4130 * @syscap SystemCapability.ArkUI.ArkUI.Full 4131 * @crossplatform 4132 * @form 4133 * @since 10 4134 */ 4135 /** 4136 * Draws the specified ImageData object onto the canvas 4137 * 4138 * @param { ImageData } imagedata - ImageData object to be drawn. 4139 * @param { number | string } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4140 * @param { number | string } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4141 * @syscap SystemCapability.ArkUI.ArkUI.Full 4142 * @crossplatform 4143 * @form 4144 * @atomicservice 4145 * @since arkts {'1.1':'11','1.2':'20'} 4146 * @arkts 1.1&1.2 4147 */ 4148 putImageData(imagedata: ImageData, dx: number | string, dy: number | string): void; 4149 4150 /** 4151 * Draws the specified ImageData object onto the canvas 4152 * 4153 * @param { ImageData } imagedata - ImageData object to be drawn. 4154 * @param { number } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4155 * @param { number } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4156 * @param { number } dirtyX - Position of the upper left corner of the rectangular area in the source image data. 4157 * The default is the upper left corner (x coordinate) of the entire image data. 4158 * @param { number } dirtyY - Position of the upper left corner of the rectangular area in the source image data. 4159 * The default is the upper left corner (y coordinate) of the entire image data. 4160 * @param { number } dirtyWidth - Width of the rectangular area in the source image data. 4161 * The default is the width of the image data. 4162 * @param { number } dirtyHeight - Height of the rectangular area in the source image data. 4163 * The default is the height of the image data. 4164 * @syscap SystemCapability.ArkUI.ArkUI.Full 4165 * @since 8 4166 */ 4167 /** 4168 * Draws the specified ImageData object onto the canvas 4169 * 4170 * @param { ImageData } imagedata - ImageData object to be drawn. 4171 * @param { number } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4172 * @param { number } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4173 * @param { number } dirtyX - Position of the upper left corner of the rectangular area in the source image data. 4174 * The default is the upper left corner (x coordinate) of the entire image data. 4175 * @param { number } dirtyY - Position of the upper left corner of the rectangular area in the source image data. 4176 * The default is the upper left corner (y coordinate) of the entire image data. 4177 * @param { number } dirtyWidth - Width of the rectangular area in the source image data. 4178 * The default is the width of the image data. 4179 * @param { number } dirtyHeight - Height of the rectangular area in the source image data. 4180 * The default is the height of the image data. 4181 * @syscap SystemCapability.ArkUI.ArkUI.Full 4182 * @form 4183 * @since 9 4184 */ 4185 /** 4186 * Draws the specified ImageData object onto the canvas 4187 * 4188 * @param { ImageData } imagedata - ImageData object to be drawn. 4189 * @param { number | string } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4190 * @param { number | string } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4191 * @param { number | string } dirtyX - Position of the upper left corner of the rectangular area in the source image data. 4192 * The default is the upper left corner (x coordinate) of the entire image data. 4193 * @param { number | string } dirtyY - Position of the upper left corner of the rectangular area in the source image data. 4194 * The default is the upper left corner (y coordinate) of the entire image data. 4195 * @param { number | string } dirtyWidth - Width of the rectangular area in the source image data. 4196 * The default is the width of the image data. 4197 * @param { number | string } dirtyHeight - Height of the rectangular area in the source image data. 4198 * The default is the height of the image data. 4199 * @syscap SystemCapability.ArkUI.ArkUI.Full 4200 * @crossplatform 4201 * @form 4202 * @since 10 4203 */ 4204 /** 4205 * Draws the specified ImageData object onto the canvas 4206 * 4207 * @param { ImageData } imagedata - ImageData object to be drawn. 4208 * @param { number | string } dx - Position offset of the source image data in the target canvas (the offset in the x-axis direction). 4209 * @param { number | string } dy - Position offset of the source image data in the target canvas (the offset in the y-axis direction). 4210 * @param { number | string } dirtyX - Position of the upper left corner of the rectangular area in the source image data. 4211 * The default is the upper left corner (x coordinate) of the entire image data. 4212 * @param { number | string } dirtyY - Position of the upper left corner of the rectangular area in the source image data. 4213 * The default is the upper left corner (y coordinate) of the entire image data. 4214 * @param { number | string } dirtyWidth - Width of the rectangular area in the source image data. 4215 * The default is the width of the image data. 4216 * @param { number | string } dirtyHeight - Height of the rectangular area in the source image data. 4217 * The default is the height of the image data. 4218 * @syscap SystemCapability.ArkUI.ArkUI.Full 4219 * @crossplatform 4220 * @form 4221 * @atomicservice 4222 * @since arkts {'1.1':'11','1.2':'20'} 4223 * @arkts 1.1&1.2 4224 */ 4225 putImageData( 4226 imagedata: ImageData, 4227 dx: number | string, 4228 dy: number | string, 4229 dirtyX: number | string, 4230 dirtyY: number | string, 4231 dirtyWidth: number | string, 4232 dirtyHeight: number | string 4233 ): void; 4234 4235 /** 4236 * Specifies whether to smooth the image. The value true indicates that the image is smooth. 4237 * The value false indicates that the image is not smooth. 4238 * 4239 * @type { boolean } 4240 * @default true 4241 * @syscap SystemCapability.ArkUI.ArkUI.Full 4242 * @since 8 4243 */ 4244 /** 4245 * Specifies whether to smooth the image. The value true indicates that the image is smooth. 4246 * The value false indicates that the image is not smooth. 4247 * 4248 * @type { boolean } 4249 * @default true 4250 * @syscap SystemCapability.ArkUI.ArkUI.Full 4251 * @form 4252 * @since 9 4253 */ 4254 /** 4255 * Specifies whether to smooth the image. The value true indicates that the image is smooth. 4256 * The value false indicates that the image is not smooth. 4257 * 4258 * @type { boolean } 4259 * @default true 4260 * @syscap SystemCapability.ArkUI.ArkUI.Full 4261 * @crossplatform 4262 * @form 4263 * @since 10 4264 */ 4265 /** 4266 * Specifies whether to smooth the image. The value true indicates that the image is smooth. 4267 * The value false indicates that the image is not smooth. 4268 * 4269 * @type { boolean } 4270 * @default true 4271 * @syscap SystemCapability.ArkUI.ArkUI.Full 4272 * @crossplatform 4273 * @form 4274 * @atomicservice 4275 * @since 11 4276 */ 4277 imageSmoothingEnabled: boolean; 4278 4279 /** 4280 * Get the status whether to smooth the image. The value true indicates that the image is smooth. 4281 * The value false indicates that the image is not smooth. 4282 * 4283 * @return { boolean } 4284 * @syscap SystemCapability.ArkUI.ArkUI.Full 4285 * @crossplatform 4286 * @form 4287 * @atomicservice 4288 * @since 20 4289 * @arkts 1.2 4290 */ 4291 get imageSmoothingEnabled(): boolean; 4292 4293 /** 4294 * Set the status whether to smooth the image. The value true indicates that the image is smooth. 4295 * The value false indicates that the image is not smooth. 4296 * 4297 * @param { boolean } 4298 * @syscap SystemCapability.ArkUI.ArkUI.Full 4299 * @crossplatform 4300 * @form 4301 * @atomicservice 4302 * @since 20 4303 * @arkts 1.2 4304 */ 4305 set imageSmoothingEnabled(imageSmoothingEnabled: boolean); 4306 4307 /** 4308 * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4309 * 4310 * @type { ImageSmoothingQuality } 4311 * @default low 4312 * @syscap SystemCapability.ArkUI.ArkUI.Full 4313 * @since 8 4314 */ 4315 /** 4316 * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4317 * 4318 * @type { ImageSmoothingQuality } 4319 * @default low 4320 * @syscap SystemCapability.ArkUI.ArkUI.Full 4321 * @form 4322 * @since 9 4323 */ 4324 /** 4325 * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4326 * 4327 * @type { ImageSmoothingQuality } 4328 * @default low 4329 * @syscap SystemCapability.ArkUI.ArkUI.Full 4330 * @crossplatform 4331 * @form 4332 * @since 10 4333 */ 4334 /** 4335 * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4336 * 4337 * @type { ImageSmoothingQuality } 4338 * @default low 4339 * @syscap SystemCapability.ArkUI.ArkUI.Full 4340 * @crossplatform 4341 * @form 4342 * @atomicservice 4343 * @since 11 4344 */ 4345 imageSmoothingQuality: ImageSmoothingQuality; 4346 4347 /** 4348 * Get the smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4349 * 4350 * @return { ImageSmoothingQuality } 4351 * @syscap SystemCapability.ArkUI.ArkUI.Full 4352 * @crossplatform 4353 * @form 4354 * @atomicservice 4355 * @since 20 4356 * @arkts 1.2 4357 */ 4358 get imageSmoothingQuality(): ImageSmoothingQuality; 4359 4360 /** 4361 * Set the smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. 4362 * 4363 * @param { ImageSmoothingQuality } 4364 * @syscap SystemCapability.ArkUI.ArkUI.Full 4365 * @crossplatform 4366 * @form 4367 * @atomicservice 4368 * @since 20 4369 * @arkts 1.2 4370 */ 4371 set imageSmoothingQuality(imageSmoothingQuality: ImageSmoothingQuality); 4372 4373 /** 4374 * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4375 * 4376 * @type { CanvasLineCap } 4377 * @default butt 4378 * @syscap SystemCapability.ArkUI.ArkUI.Full 4379 * @since 8 4380 */ 4381 /** 4382 * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4383 * 4384 * @type { CanvasLineCap } 4385 * @default butt 4386 * @syscap SystemCapability.ArkUI.ArkUI.Full 4387 * @form 4388 * @since 9 4389 */ 4390 /** 4391 * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4392 * 4393 * @type { CanvasLineCap } 4394 * @default butt 4395 * @syscap SystemCapability.ArkUI.ArkUI.Full 4396 * @crossplatform 4397 * @form 4398 * @since 10 4399 */ 4400 /** 4401 * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4402 * 4403 * @type { CanvasLineCap } 4404 * @default butt 4405 * @syscap SystemCapability.ArkUI.ArkUI.Full 4406 * @crossplatform 4407 * @form 4408 * @atomicservice 4409 * @since 11 4410 */ 4411 lineCap: CanvasLineCap; 4412 4413 /** 4414 * Get the line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4415 * 4416 * @return { CanvasLineCap } 4417 * @syscap SystemCapability.ArkUI.ArkUI.Full 4418 * @crossplatform 4419 * @form 4420 * @atomicservice 4421 * @since 20 4422 * @arkts 1.2 4423 */ 4424 get lineCap(): CanvasLineCap; 4425 4426 /** 4427 * Set the line segment endpoint attribute. For details, see {@link CanvasLineCap}. 4428 * 4429 * @param { CanvasLineCap } 4430 * @syscap SystemCapability.ArkUI.ArkUI.Full 4431 * @crossplatform 4432 * @form 4433 * @atomicservice 4434 * @since 20 4435 * @arkts 1.2 4436 */ 4437 set lineCap(lineCap: CanvasLineCap); 4438 4439 /** 4440 * Dotted line offset attribute. 4441 * 4442 * @type { number } 4443 * @default 0.0 4444 * @syscap SystemCapability.ArkUI.ArkUI.Full 4445 * @since 8 4446 */ 4447 /** 4448 * Dotted line offset attribute. 4449 * 4450 * @type { number } 4451 * @default 0.0 4452 * @syscap SystemCapability.ArkUI.ArkUI.Full 4453 * @form 4454 * @since 9 4455 */ 4456 /** 4457 * Dotted line offset attribute. 4458 * 4459 * @type { number } 4460 * @default 0.0 4461 * @syscap SystemCapability.ArkUI.ArkUI.Full 4462 * @crossplatform 4463 * @form 4464 * @since 10 4465 */ 4466 /** 4467 * Dotted line offset attribute. 4468 * 4469 * @type { number } 4470 * @default 0.0 4471 * @syscap SystemCapability.ArkUI.ArkUI.Full 4472 * @crossplatform 4473 * @form 4474 * @atomicservice 4475 * @since 11 4476 */ 4477 lineDashOffset: number; 4478 4479 /** 4480 * Get the dotted line offset attribute. 4481 * 4482 * @return { number } 4483 * @syscap SystemCapability.ArkUI.ArkUI.Full 4484 * @crossplatform 4485 * @form 4486 * @atomicservice 4487 * @since 20 4488 * @arkts 1.2 4489 */ 4490 get lineDashOffset(): number; 4491 4492 /** 4493 * Set the dotted line offset attribute. 4494 * 4495 * @param { number } 4496 * @syscap SystemCapability.ArkUI.ArkUI.Full 4497 * @crossplatform 4498 * @form 4499 * @atomicservice 4500 * @since 20 4501 * @arkts 1.2 4502 */ 4503 set lineDashOffset(lineDashOffset: number); 4504 4505 /** 4506 * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4507 * 4508 * @type { CanvasLineJoin } 4509 * @default miter 4510 * @syscap SystemCapability.ArkUI.ArkUI.Full 4511 * @since 8 4512 */ 4513 /** 4514 * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4515 * 4516 * @type { CanvasLineJoin } 4517 * @default miter 4518 * @syscap SystemCapability.ArkUI.ArkUI.Full 4519 * @form 4520 * @since 9 4521 */ 4522 /** 4523 * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4524 * 4525 * @type { CanvasLineJoin } 4526 * @default miter 4527 * @syscap SystemCapability.ArkUI.ArkUI.Full 4528 * @crossplatform 4529 * @form 4530 * @since 10 4531 */ 4532 /** 4533 * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4534 * 4535 * @type { CanvasLineJoin } 4536 * @default miter 4537 * @syscap SystemCapability.ArkUI.ArkUI.Full 4538 * @crossplatform 4539 * @form 4540 * @atomicservice 4541 * @since 11 4542 */ 4543 lineJoin: CanvasLineJoin; 4544 4545 /** 4546 * Get the line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4547 * 4548 * @return { CanvasLineJoin } 4549 * @syscap SystemCapability.ArkUI.ArkUI.Full 4550 * @crossplatform 4551 * @form 4552 * @atomicservice 4553 * @since 20 4554 * @arkts 1.2 4555 */ 4556 get lineJoin(): CanvasLineJoin; 4557 4558 /** 4559 * Set the line segment connection point attribute. For details, see {@link CanvasLineJoin}. 4560 * 4561 * @param { CanvasLineJoin } 4562 * @syscap SystemCapability.ArkUI.ArkUI.Full 4563 * @crossplatform 4564 * @form 4565 * @atomicservice 4566 * @since 20 4567 * @arkts 1.2 4568 */ 4569 set lineJoin(lineJoin: CanvasLineJoin); 4570 4571 /** 4572 * Line thickness attribute. The value cannot be 0 or a negative number. 4573 * 4574 * @type { number } 4575 * @default 1(px) 4576 * @syscap SystemCapability.ArkUI.ArkUI.Full 4577 * @since 8 4578 */ 4579 /** 4580 * Line thickness attribute. The value cannot be 0 or a negative number. 4581 * 4582 * @type { number } 4583 * @default 1(px) 4584 * @syscap SystemCapability.ArkUI.ArkUI.Full 4585 * @form 4586 * @since 9 4587 */ 4588 /** 4589 * Line thickness attribute. The value cannot be 0 or a negative number. 4590 * 4591 * @type { number } 4592 * @default 1(px) 4593 * @syscap SystemCapability.ArkUI.ArkUI.Full 4594 * @crossplatform 4595 * @form 4596 * @since 10 4597 */ 4598 /** 4599 * Line thickness attribute. The value cannot be 0 or a negative number. 4600 * 4601 * @type { number } 4602 * @default 1(px) 4603 * @syscap SystemCapability.ArkUI.ArkUI.Full 4604 * @crossplatform 4605 * @form 4606 * @atomicservice 4607 * @since 11 4608 */ 4609 lineWidth: number; 4610 4611 /** 4612 * Get the line thickness attribute. The value cannot be 0 or a negative number. 4613 * 4614 * @return { number } 4615 * @syscap SystemCapability.ArkUI.ArkUI.Full 4616 * @crossplatform 4617 * @form 4618 * @atomicservice 4619 * @since 20 4620 * @arkts 1.2 4621 */ 4622 get lineWidth(): number; 4623 4624 /** 4625 * Set the line thickness attribute. The value cannot be 0 or a negative number. 4626 * 4627 * @param { number } 4628 * @syscap SystemCapability.ArkUI.ArkUI.Full 4629 * @crossplatform 4630 * @form 4631 * @atomicservice 4632 * @since 20 4633 * @arkts 1.2 4634 */ 4635 set lineWidth(lineWidth: number); 4636 4637 /** 4638 * The value of this parameter cannot be 0 or a negative number. 4639 * 4640 * @type { number } 4641 * @default 10(px) 4642 * @syscap SystemCapability.ArkUI.ArkUI.Full 4643 * @since 8 4644 */ 4645 /** 4646 * The value of this parameter cannot be 0 or a negative number. 4647 * 4648 * @type { number } 4649 * @default 10(px) 4650 * @syscap SystemCapability.ArkUI.ArkUI.Full 4651 * @form 4652 * @since 9 4653 */ 4654 /** 4655 * The value of this parameter cannot be 0 or a negative number. 4656 * 4657 * @type { number } 4658 * @default 10(px) 4659 * @syscap SystemCapability.ArkUI.ArkUI.Full 4660 * @crossplatform 4661 * @form 4662 * @since 10 4663 */ 4664 /** 4665 * The value of this parameter cannot be 0 or a negative number. 4666 * 4667 * @type { number } 4668 * @default 10(px) 4669 * @syscap SystemCapability.ArkUI.ArkUI.Full 4670 * @crossplatform 4671 * @form 4672 * @atomicservice 4673 * @since 11 4674 */ 4675 miterLimit: number; 4676 4677 /** 4678 * Get the value of this parameter cannot be 0 or a negative number. 4679 * 4680 * @return { number } 4681 * @syscap SystemCapability.ArkUI.ArkUI.Full 4682 * @crossplatform 4683 * @form 4684 * @atomicservice 4685 * @since 20 4686 * @arkts 1.2 4687 */ 4688 get miterLimit(): number; 4689 4690 /** 4691 * Set the value of this parameter cannot be 0 or a negative number. 4692 * 4693 * @param { number } 4694 * @syscap SystemCapability.ArkUI.ArkUI.Full 4695 * @crossplatform 4696 * @form 4697 * @atomicservice 4698 * @since 20 4699 * @arkts 1.2 4700 */ 4701 set miterLimit(miterLimit: number); 4702 4703 /** 4704 * Gets the current segment style. 4705 * 4706 * @returns { number[] } 4707 * @syscap SystemCapability.ArkUI.ArkUI.Full 4708 * @since 8 4709 */ 4710 /** 4711 * Gets the current segment style. 4712 * 4713 * @returns { number[] } 4714 * @syscap SystemCapability.ArkUI.ArkUI.Full 4715 * @form 4716 * @since 9 4717 */ 4718 /** 4719 * Gets the current segment style. 4720 * 4721 * @returns { number[] } 4722 * @syscap SystemCapability.ArkUI.ArkUI.Full 4723 * @crossplatform 4724 * @form 4725 * @since 10 4726 */ 4727 /** 4728 * Gets the current segment style. 4729 * 4730 * @returns { number[] } 4731 * @syscap SystemCapability.ArkUI.ArkUI.Full 4732 * @crossplatform 4733 * @form 4734 * @atomicservice 4735 * @since arkts {'1.1':'11','1.2':'20'} 4736 * @arkts 1.1&1.2 4737 */ 4738 getLineDash(): number[]; 4739 4740 /** 4741 * Sets the dashed line mode for line drawing. 4742 * 4743 * @param { number[] } segments - A set of numbers that describe the length of alternating drawn lines segments and 4744 * spacing (coordinate space units). 4745 * @syscap SystemCapability.ArkUI.ArkUI.Full 4746 * @since 8 4747 */ 4748 /** 4749 * Sets the dashed line mode for line drawing. 4750 * 4751 * @param { number[] } segments - A set of numbers that describe the length of alternating drawn lines segments and 4752 * spacing (coordinate space units). 4753 * @syscap SystemCapability.ArkUI.ArkUI.Full 4754 * @form 4755 * @since 9 4756 */ 4757 /** 4758 * Sets the dashed line mode for line drawing. 4759 * 4760 * @param { number[] } segments - A set of numbers that describe the length of alternating drawn lines segments and 4761 * spacing (coordinate space units). 4762 * @syscap SystemCapability.ArkUI.ArkUI.Full 4763 * @crossplatform 4764 * @form 4765 * @since 10 4766 */ 4767 /** 4768 * Sets the dashed line mode for line drawing. 4769 * 4770 * @param { number[] } segments - A set of numbers that describe the length of alternating drawn lines segments and 4771 * spacing (coordinate space units). 4772 * @syscap SystemCapability.ArkUI.ArkUI.Full 4773 * @crossplatform 4774 * @form 4775 * @atomicservice 4776 * @since arkts {'1.1':'11','1.2':'20'} 4777 * @arkts 1.1&1.2 4778 */ 4779 setLineDash(segments: number[]): void; 4780 4781 /** 4782 * Clears the drawing content of a rectangular area. 4783 * 4784 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4785 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4786 * @param { number } w - Width of the rectangle. 4787 * @param { number } h - Height of the rectangle. 4788 * @syscap SystemCapability.ArkUI.ArkUI.Full 4789 * @since 8 4790 */ 4791 /** 4792 * Clears the drawing content of a rectangular area. 4793 * 4794 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4795 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4796 * @param { number } w - Width of the rectangle. 4797 * @param { number } h - Height of the rectangle. 4798 * @syscap SystemCapability.ArkUI.ArkUI.Full 4799 * @form 4800 * @since 9 4801 */ 4802 /** 4803 * Clears the drawing content of a rectangular area. 4804 * 4805 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4806 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4807 * @param { number } w - Width of the rectangle. 4808 * @param { number } h - Height of the rectangle. 4809 * @syscap SystemCapability.ArkUI.ArkUI.Full 4810 * @crossplatform 4811 * @form 4812 * @since 10 4813 */ 4814 /** 4815 * Clears the drawing content of a rectangular area. 4816 * 4817 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4818 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4819 * @param { number } w - Width of the rectangle. 4820 * @param { number } h - Height of the rectangle. 4821 * @syscap SystemCapability.ArkUI.ArkUI.Full 4822 * @crossplatform 4823 * @form 4824 * @atomicservice 4825 * @since arkts {'1.1':'11','1.2':'20'} 4826 * @arkts 1.1&1.2 4827 */ 4828 clearRect(x: number, y: number, w: number, h: number): void; 4829 4830 /** 4831 * Fills a specified rectangular area 4832 * 4833 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4834 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4835 * @param { number } w - Width of the rectangle. 4836 * @param { number } h - Height of the rectangle. 4837 * @syscap SystemCapability.ArkUI.ArkUI.Full 4838 * @since 8 4839 */ 4840 /** 4841 * Fills a specified rectangular area 4842 * 4843 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4844 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4845 * @param { number } w - Width of the rectangle. 4846 * @param { number } h - Height of the rectangle. 4847 * @syscap SystemCapability.ArkUI.ArkUI.Full 4848 * @form 4849 * @since 9 4850 */ 4851 /** 4852 * Fills a specified rectangular area 4853 * 4854 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4855 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4856 * @param { number } w - Width of the rectangle. 4857 * @param { number } h - Height of the rectangle. 4858 * @syscap SystemCapability.ArkUI.ArkUI.Full 4859 * @crossplatform 4860 * @form 4861 * @since 10 4862 */ 4863 /** 4864 * Fills a specified rectangular area 4865 * 4866 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4867 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4868 * @param { number } w - Width of the rectangle. 4869 * @param { number } h - Height of the rectangle. 4870 * @syscap SystemCapability.ArkUI.ArkUI.Full 4871 * @crossplatform 4872 * @form 4873 * @atomicservice 4874 * @since arkts {'1.1':'11','1.2':'20'} 4875 * @arkts 1.1&1.2 4876 */ 4877 fillRect(x: number, y: number, w: number, h: number): void; 4878 4879 /** 4880 * Stroke Specify Rectangular Area 4881 * 4882 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4883 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4884 * @param { number } w - Width of the rectangle. 4885 * @param { number } h - Height of the rectangle. 4886 * @syscap SystemCapability.ArkUI.ArkUI.Full 4887 * @since 8 4888 */ 4889 /** 4890 * Stroke Specify Rectangular Area 4891 * 4892 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4893 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4894 * @param { number } w - Width of the rectangle. 4895 * @param { number } h - Height of the rectangle. 4896 * @syscap SystemCapability.ArkUI.ArkUI.Full 4897 * @form 4898 * @since 9 4899 */ 4900 /** 4901 * Stroke Specify Rectangular Area 4902 * 4903 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4904 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4905 * @param { number } w - Width of the rectangle. 4906 * @param { number } h - Height of the rectangle. 4907 * @syscap SystemCapability.ArkUI.ArkUI.Full 4908 * @crossplatform 4909 * @form 4910 * @since 10 4911 */ 4912 /** 4913 * Stroke Specify Rectangular Area 4914 * 4915 * @param { number } x - The x-axis coordinate of the start point of the rectangle. 4916 * @param { number } y - The y-axis coordinate of the start point of the rectangle. 4917 * @param { number } w - Width of the rectangle. 4918 * @param { number } h - Height of the rectangle. 4919 * @syscap SystemCapability.ArkUI.ArkUI.Full 4920 * @crossplatform 4921 * @form 4922 * @atomicservice 4923 * @since arkts {'1.1':'11','1.2':'20'} 4924 * @arkts 1.1&1.2 4925 */ 4926 strokeRect(x: number, y: number, w: number, h: number): void; 4927 4928 /** 4929 * Shadow blur radius. The value cannot be a negative number. 4930 * 4931 * @type { number } 4932 * @default 0 4933 * @syscap SystemCapability.ArkUI.ArkUI.Full 4934 * @since 8 4935 */ 4936 /** 4937 * Shadow blur radius. The value cannot be a negative number. 4938 * 4939 * @type { number } 4940 * @default 0 4941 * @syscap SystemCapability.ArkUI.ArkUI.Full 4942 * @form 4943 * @since 9 4944 */ 4945 /** 4946 * Shadow blur radius. The value cannot be a negative number. 4947 * 4948 * @type { number } 4949 * @default 0 4950 * @syscap SystemCapability.ArkUI.ArkUI.Full 4951 * @crossplatform 4952 * @form 4953 * @since 10 4954 */ 4955 /** 4956 * Shadow blur radius. The value cannot be a negative number. 4957 * 4958 * @type { number } 4959 * @default 0 4960 * @syscap SystemCapability.ArkUI.ArkUI.Full 4961 * @crossplatform 4962 * @form 4963 * @atomicservice 4964 * @since 11 4965 */ 4966 shadowBlur: number; 4967 4968 /** 4969 * Get the shadow blur radius. The value cannot be a negative number. 4970 * 4971 * @return { number } 4972 * @syscap SystemCapability.ArkUI.ArkUI.Full 4973 * @crossplatform 4974 * @form 4975 * @atomicservice 4976 * @since 20 4977 * @arkts 1.2 4978 */ 4979 get shadowBlur(): number; 4980 4981 /** 4982 * Set the shadow blur radius. The value cannot be a negative number. 4983 * 4984 * @param { number } 4985 * @syscap SystemCapability.ArkUI.ArkUI.Full 4986 * @crossplatform 4987 * @form 4988 * @atomicservice 4989 * @since 20 4990 * @arkts 1.2 4991 */ 4992 set shadowBlur(shadowBlur: number); 4993 4994 /** 4995 * Shadow color. 4996 * 4997 * @type { string } 4998 * @default transparent black 4999 * @syscap SystemCapability.ArkUI.ArkUI.Full 5000 * @since 8 5001 */ 5002 /** 5003 * Shadow color. 5004 * 5005 * @type { string } 5006 * @default transparent black 5007 * @syscap SystemCapability.ArkUI.ArkUI.Full 5008 * @form 5009 * @since 9 5010 */ 5011 /** 5012 * Shadow color. 5013 * 5014 * @type { string } 5015 * @default transparent black 5016 * @syscap SystemCapability.ArkUI.ArkUI.Full 5017 * @crossplatform 5018 * @form 5019 * @since 10 5020 */ 5021 /** 5022 * Shadow color. 5023 * 5024 * @type { string } 5025 * @default transparent black 5026 * @syscap SystemCapability.ArkUI.ArkUI.Full 5027 * @crossplatform 5028 * @form 5029 * @atomicservice 5030 * @since 11 5031 */ 5032 shadowColor: string; 5033 5034 /** 5035 * Get the shadow color. 5036 * 5037 * @return { string } 5038 * @syscap SystemCapability.ArkUI.ArkUI.Full 5039 * @crossplatform 5040 * @form 5041 * @atomicservice 5042 * @since 20 5043 * @arkts 1.2 5044 */ 5045 get shadowColor(): string; 5046 5047 /** 5048 * Set the shadow color. 5049 * 5050 * @param { string } 5051 * @syscap SystemCapability.ArkUI.ArkUI.Full 5052 * @crossplatform 5053 * @form 5054 * @atomicservice 5055 * @since 20 5056 * @arkts 1.2 5057 */ 5058 set shadowColor(shadowColor: string); 5059 5060 /** 5061 * Horizontal offset distance of the shadow. 5062 * 5063 * @type { number } 5064 * @default 0 5065 * @syscap SystemCapability.ArkUI.ArkUI.Full 5066 * @since 8 5067 */ 5068 /** 5069 * Horizontal offset distance of the shadow. 5070 * 5071 * @type { number } 5072 * @default 0 5073 * @syscap SystemCapability.ArkUI.ArkUI.Full 5074 * @form 5075 * @since 9 5076 */ 5077 /** 5078 * Horizontal offset distance of the shadow. 5079 * 5080 * @type { number } 5081 * @default 0 5082 * @syscap SystemCapability.ArkUI.ArkUI.Full 5083 * @crossplatform 5084 * @form 5085 * @since 10 5086 */ 5087 /** 5088 * Horizontal offset distance of the shadow. 5089 * 5090 * @type { number } 5091 * @default 0 5092 * @syscap SystemCapability.ArkUI.ArkUI.Full 5093 * @crossplatform 5094 * @form 5095 * @atomicservice 5096 * @since 11 5097 */ 5098 shadowOffsetX: number; 5099 5100 /** 5101 * Get the horizontal offset distance of the shadow. 5102 * 5103 * @return { number } 5104 * @syscap SystemCapability.ArkUI.ArkUI.Full 5105 * @crossplatform 5106 * @form 5107 * @atomicservice 5108 * @since 20 5109 * @arkts 1.2 5110 */ 5111 get shadowOffsetX(): number; 5112 5113 /** 5114 * Set the horizontal offset distance of the shadow. 5115 * 5116 * @param { number } 5117 * @syscap SystemCapability.ArkUI.ArkUI.Full 5118 * @crossplatform 5119 * @form 5120 * @atomicservice 5121 * @since 20 5122 * @arkts 1.2 5123 */ 5124 set shadowOffsetX(shadowOffsetX: number); 5125 5126 /** 5127 * Vertical offset distance of the shadow. 5128 * 5129 * @type { number } 5130 * @default 0 5131 * @syscap SystemCapability.ArkUI.ArkUI.Full 5132 * @since 8 5133 */ 5134 /** 5135 * Vertical offset distance of the shadow. 5136 * 5137 * @type { number } 5138 * @default 0 5139 * @syscap SystemCapability.ArkUI.ArkUI.Full 5140 * @form 5141 * @since 9 5142 */ 5143 /** 5144 * Vertical offset distance of the shadow. 5145 * 5146 * @type { number } 5147 * @default 0 5148 * @syscap SystemCapability.ArkUI.ArkUI.Full 5149 * @crossplatform 5150 * @form 5151 * @since 10 5152 */ 5153 /** 5154 * Vertical offset distance of the shadow. 5155 * 5156 * @type { number } 5157 * @default 0 5158 * @syscap SystemCapability.ArkUI.ArkUI.Full 5159 * @crossplatform 5160 * @form 5161 * @atomicservice 5162 * @since 11 5163 */ 5164 shadowOffsetY: number; 5165 5166 /** 5167 * Get the vertical offset distance of the shadow. 5168 * 5169 * @return { number } 5170 * @syscap SystemCapability.ArkUI.ArkUI.Full 5171 * @crossplatform 5172 * @form 5173 * @atomicservice 5174 * @since 20 5175 * @arkts 1.2 5176 */ 5177 get shadowOffsetY(): number; 5178 5179 /** 5180 * Set the vertical offset distance of the shadow. 5181 * 5182 * @param { number } 5183 * @syscap SystemCapability.ArkUI.ArkUI.Full 5184 * @crossplatform 5185 * @form 5186 * @atomicservice 5187 * @since 20 5188 * @arkts 1.2 5189 */ 5190 set shadowOffsetY(shadowOffsetY: number); 5191 5192 /** 5193 * Top of the stack pop-up state in the drawing state stack 5194 * 5195 * @syscap SystemCapability.ArkUI.ArkUI.Full 5196 * @since 8 5197 */ 5198 /** 5199 * Top of the stack pop-up state in the drawing state stack 5200 * 5201 * @syscap SystemCapability.ArkUI.ArkUI.Full 5202 * @form 5203 * @since 9 5204 */ 5205 /** 5206 * Top of the stack pop-up state in the drawing state stack 5207 * 5208 * @syscap SystemCapability.ArkUI.ArkUI.Full 5209 * @crossplatform 5210 * @form 5211 * @since 10 5212 */ 5213 /** 5214 * Top of the stack pop-up state in the drawing state stack 5215 * 5216 * @syscap SystemCapability.ArkUI.ArkUI.Full 5217 * @crossplatform 5218 * @form 5219 * @atomicservice 5220 * @since arkts {'1.1':'11','1.2':'20'} 5221 * @arkts 1.1&1.2 5222 */ 5223 restore(): void; 5224 5225 /** 5226 * Saves the current drawing state to the drawing state stack 5227 * 5228 * @syscap SystemCapability.ArkUI.ArkUI.Full 5229 * @since 8 5230 */ 5231 /** 5232 * Saves the current drawing state to the drawing state stack 5233 * 5234 * @syscap SystemCapability.ArkUI.ArkUI.Full 5235 * @form 5236 * @since 9 5237 */ 5238 /** 5239 * Saves the current drawing state to the drawing state stack 5240 * 5241 * @syscap SystemCapability.ArkUI.ArkUI.Full 5242 * @crossplatform 5243 * @form 5244 * @since 10 5245 */ 5246 /** 5247 * Saves the current drawing state to the drawing state stack 5248 * 5249 * @syscap SystemCapability.ArkUI.ArkUI.Full 5250 * @crossplatform 5251 * @form 5252 * @atomicservice 5253 * @since arkts {'1.1':'11','1.2':'20'} 5254 * @arkts 1.1&1.2 5255 */ 5256 save(): void; 5257 5258 /** 5259 * Fills the specified text at the specified location 5260 * 5261 * @param { string } text - Text string to be drawn. 5262 * @param { number } x - The x-axis coordinate of the start point of the text. 5263 * @param { number } y - The y-axis coordinate of the start point of the text. 5264 * @param { number } maxWidth - Maximum width of the drawing. 5265 * @syscap SystemCapability.ArkUI.ArkUI.Full 5266 * @since 8 5267 */ 5268 /** 5269 * Fills the specified text at the specified location 5270 * 5271 * @param { string } text - Text string to be drawn. 5272 * @param { number } x - The x-axis coordinate of the start point of the text. 5273 * @param { number } y - The y-axis coordinate of the start point of the text. 5274 * @param { number } maxWidth - Maximum width of the drawing. 5275 * @syscap SystemCapability.ArkUI.ArkUI.Full 5276 * @form 5277 * @since 9 5278 */ 5279 /** 5280 * Fills the specified text at the specified location 5281 * 5282 * @param { string } text - Text string to be drawn. 5283 * @param { number } x - The x-axis coordinate of the start point of the text. 5284 * @param { number } y - The y-axis coordinate of the start point of the text. 5285 * @param { number } maxWidth - Maximum width of the drawing. 5286 * @syscap SystemCapability.ArkUI.ArkUI.Full 5287 * @crossplatform 5288 * @form 5289 * @since 10 5290 */ 5291 /** 5292 * Fills the specified text at the specified location 5293 * 5294 * @param { string } text - Text string to be drawn. 5295 * @param { number } x - The x-axis coordinate of the start point of the text. 5296 * @param { number } y - The y-axis coordinate of the start point of the text. 5297 * @param { number } maxWidth - Maximum width of the drawing. 5298 * @syscap SystemCapability.ArkUI.ArkUI.Full 5299 * @crossplatform 5300 * @form 5301 * @atomicservice 5302 * @since arkts {'1.1':'11','1.2':'20'} 5303 * @arkts 1.1&1.2 5304 */ 5305 fillText(text: string, x: number, y: number, maxWidth?: number): void; 5306 5307 /** 5308 * Measure the size of a specified text. For details about the return value, see {@link TextMetrics}. 5309 * 5310 * @param { string } text - Text string to be measured. 5311 * @returns { TextMetrics } 5312 * @syscap SystemCapability.ArkUI.ArkUI.Full 5313 * @since 8 5314 */ 5315 /** 5316 * Measure the size of a specified text. For details about the return value, see {@link TextMetrics}. 5317 * 5318 * @param { string } text - Text string to be measured. 5319 * @returns { TextMetrics } 5320 * @syscap SystemCapability.ArkUI.ArkUI.Full 5321 * @form 5322 * @since 9 5323 */ 5324 /** 5325 * Measure the size of a specified text. For details about the return value, see {@link TextMetrics}. 5326 * 5327 * @param { string } text - Text string to be measured. 5328 * @returns { TextMetrics } 5329 * @syscap SystemCapability.ArkUI.ArkUI.Full 5330 * @crossplatform 5331 * @form 5332 * @since 10 5333 */ 5334 /** 5335 * Measure the size of a specified text. For details about the return value, see {@link TextMetrics}. 5336 * 5337 * @param { string } text - Text string to be measured. 5338 * @returns { TextMetrics } 5339 * @syscap SystemCapability.ArkUI.ArkUI.Full 5340 * @crossplatform 5341 * @form 5342 * @atomicservice 5343 * @since arkts {'1.1':'11','1.2':'20'} 5344 * @arkts 1.1&1.2 5345 */ 5346 measureText(text: string): TextMetrics; 5347 5348 /** 5349 * Stroke specified text at specified position 5350 * 5351 * @param { string } text - Text string to be stroked. 5352 * @param { number } x - The x-axis coordinate of the start point of the text. 5353 * @param { number } y - The y-axis-axis coordinate of the start point of the text. 5354 * @param { number } maxWidth - Maximum width of the stroke. 5355 * @syscap SystemCapability.ArkUI.ArkUI.Full 5356 * @since 8 5357 */ 5358 /** 5359 * Stroke specified text at specified position 5360 * 5361 * @param { string } text - Text string to be stroked. 5362 * @param { number } x - The x-axis coordinate of the start point of the text. 5363 * @param { number } y - The y-axis-axis coordinate of the start point of the text. 5364 * @param { number } maxWidth - Maximum width of the stroke. 5365 * @syscap SystemCapability.ArkUI.ArkUI.Full 5366 * @form 5367 * @since 9 5368 */ 5369 /** 5370 * Stroke specified text at specified position 5371 * 5372 * @param { string } text - Text string to be stroked. 5373 * @param { number } x - The x-axis coordinate of the start point of the text. 5374 * @param { number } y - The y-axis-axis coordinate of the start point of the text. 5375 * @param { number } maxWidth - Maximum width of the stroke. 5376 * @syscap SystemCapability.ArkUI.ArkUI.Full 5377 * @crossplatform 5378 * @form 5379 * @since 10 5380 */ 5381 /** 5382 * Stroke specified text at specified position 5383 * 5384 * @param { string } text - Text string to be stroked. 5385 * @param { number } x - The x-axis coordinate of the start point of the text. 5386 * @param { number } y - The y-axis-axis coordinate of the start point of the text. 5387 * @param { number } maxWidth - Maximum width of the stroke. 5388 * @syscap SystemCapability.ArkUI.ArkUI.Full 5389 * @crossplatform 5390 * @form 5391 * @atomicservice 5392 * @since arkts {'1.1':'11','1.2':'20'} 5393 * @arkts 1.1&1.2 5394 */ 5395 strokeText(text: string, x: number, y: number, maxWidth?: number): void; 5396 5397 /** 5398 * Text drawing direction. For details, see {@link CanvasDirection}. 5399 * 5400 * @type { CanvasDirection } 5401 * @default inherit 5402 * @syscap SystemCapability.ArkUI.ArkUI.Full 5403 * @since 8 5404 */ 5405 /** 5406 * Text drawing direction. For details, see {@link CanvasDirection}. 5407 * 5408 * @type { CanvasDirection } 5409 * @default inherit 5410 * @syscap SystemCapability.ArkUI.ArkUI.Full 5411 * @form 5412 * @since 9 5413 */ 5414 /** 5415 * Text drawing direction. For details, see {@link CanvasDirection}. 5416 * 5417 * @type { CanvasDirection } 5418 * @default inherit 5419 * @syscap SystemCapability.ArkUI.ArkUI.Full 5420 * @crossplatform 5421 * @form 5422 * @since 10 5423 */ 5424 /** 5425 * Text drawing direction. For details, see {@link CanvasDirection}. 5426 * 5427 * @type { CanvasDirection } 5428 * @default inherit 5429 * @syscap SystemCapability.ArkUI.ArkUI.Full 5430 * @crossplatform 5431 * @form 5432 * @atomicservice 5433 * @since 11 5434 */ 5435 direction: CanvasDirection; 5436 5437 /** 5438 * Get the text drawing direction. For details, see {@link CanvasDirection}. 5439 * 5440 * @return { CanvasDirection } 5441 * @syscap SystemCapability.ArkUI.ArkUI.Full 5442 * @crossplatform 5443 * @form 5444 * @atomicservice 5445 * @since 20 5446 * @arkts 1.2 5447 */ 5448 get direction(): CanvasDirection; 5449 5450 /** 5451 * Set the text drawing direction. For details, see {@link CanvasDirection}. 5452 * 5453 * @param { CanvasDirection } 5454 * @syscap SystemCapability.ArkUI.ArkUI.Full 5455 * @crossplatform 5456 * @form 5457 * @atomicservice 5458 * @since 20 5459 * @arkts 1.2 5460 */ 5461 set direction(direction: CanvasDirection); 5462 5463 /** 5464 * Font style. 5465 * 5466 * @type { string } 5467 * @default normal normal 14px sans-serif 5468 * @syscap SystemCapability.ArkUI.ArkUI.Full 5469 * @since 8 5470 */ 5471 /** 5472 * Font style. 5473 * 5474 * @type { string } 5475 * @default normal normal 14px sans-serif 5476 * @syscap SystemCapability.ArkUI.ArkUI.Full 5477 * @form 5478 * @since 9 5479 */ 5480 /** 5481 * Font style. 5482 * 5483 * @type { string } 5484 * @default normal normal 14px sans-serif 5485 * @syscap SystemCapability.ArkUI.ArkUI.Full 5486 * @crossplatform 5487 * @form 5488 * @since 10 5489 */ 5490 /** 5491 * Font style. 5492 * 5493 * @type { string } 5494 * @default normal normal 14px sans-serif 5495 * @syscap SystemCapability.ArkUI.ArkUI.Full 5496 * @crossplatform 5497 * @form 5498 * @atomicservice 5499 * @since 11 5500 */ 5501 font: string; 5502 5503 /** 5504 * Get the font style. 5505 * 5506 * @return { string } 5507 * @syscap SystemCapability.ArkUI.ArkUI.Full 5508 * @crossplatform 5509 * @form 5510 * @atomicservice 5511 * @since 20 5512 * @arkts 1.2 5513 */ 5514 get font(): string; 5515 5516 /** 5517 * Set the font style. 5518 * 5519 * @param { string } 5520 * @syscap SystemCapability.ArkUI.ArkUI.Full 5521 * @crossplatform 5522 * @form 5523 * @atomicservice 5524 * @since 20 5525 * @arkts 1.2 5526 */ 5527 set font(font: string); 5528 5529 /** 5530 * Text alignment mode. For details, see {@link CanvasTextAlign}. 5531 * 5532 * @type { CanvasTextAlign } 5533 * @default left 5534 * @syscap SystemCapability.ArkUI.ArkUI.Full 5535 * @since 8 5536 */ 5537 /** 5538 * Text alignment mode. For details, see {@link CanvasTextAlign}. 5539 * 5540 * @type { CanvasTextAlign } 5541 * @default left 5542 * @syscap SystemCapability.ArkUI.ArkUI.Full 5543 * @form 5544 * @since 9 5545 */ 5546 /** 5547 * Text alignment mode. For details, see {@link CanvasTextAlign}. 5548 * 5549 * @type { CanvasTextAlign } 5550 * @default left 5551 * @syscap SystemCapability.ArkUI.ArkUI.Full 5552 * @crossplatform 5553 * @form 5554 * @since 10 5555 */ 5556 /** 5557 * Text alignment mode. For details, see {@link CanvasTextAlign}. 5558 * 5559 * @type { CanvasTextAlign } 5560 * @default left 5561 * @syscap SystemCapability.ArkUI.ArkUI.Full 5562 * @crossplatform 5563 * @form 5564 * @atomicservice 5565 * @since 11 5566 */ 5567 textAlign: CanvasTextAlign; 5568 5569 /** 5570 * Get the text alignment mode. For details, see {@link CanvasTextAlign}. 5571 * 5572 * @return { CanvasTextAlign } 5573 * @syscap SystemCapability.ArkUI.ArkUI.Full 5574 * @crossplatform 5575 * @form 5576 * @atomicservice 5577 * @since 20 5578 * @arkts 1.2 5579 */ 5580 get textAlign(): CanvasTextAlign; 5581 5582 /** 5583 * Set the text alignment mode. For details, see {@link CanvasTextAlign}. 5584 * 5585 * @param { CanvasTextAlign } 5586 * @syscap SystemCapability.ArkUI.ArkUI.Full 5587 * @crossplatform 5588 * @form 5589 * @atomicservice 5590 * @since 20 5591 * @arkts 1.2 5592 */ 5593 set textAlign(textAlign: CanvasTextAlign); 5594 5595 /** 5596 * Text baseline. For details, see {@link CanvasTextBaseline}. 5597 * 5598 * @type { CanvasTextBaseline } 5599 * @default alphabetic 5600 * @syscap SystemCapability.ArkUI.ArkUI.Full 5601 * @since 8 5602 */ 5603 /** 5604 * Text baseline. For details, see {@link CanvasTextBaseline}. 5605 * 5606 * @type { CanvasTextBaseline } 5607 * @default alphabetic 5608 * @syscap SystemCapability.ArkUI.ArkUI.Full 5609 * @form 5610 * @since 9 5611 */ 5612 /** 5613 * Text baseline. For details, see {@link CanvasTextBaseline}. 5614 * 5615 * @type { CanvasTextBaseline } 5616 * @default alphabetic 5617 * @syscap SystemCapability.ArkUI.ArkUI.Full 5618 * @crossplatform 5619 * @form 5620 * @since 10 5621 */ 5622 /** 5623 * Text baseline. For details, see {@link CanvasTextBaseline}. 5624 * 5625 * @type { CanvasTextBaseline } 5626 * @default alphabetic 5627 * @syscap SystemCapability.ArkUI.ArkUI.Full 5628 * @crossplatform 5629 * @form 5630 * @atomicservice 5631 * @since 11 5632 */ 5633 textBaseline: CanvasTextBaseline; 5634 5635 /** 5636 * Get the text baseline. For details, see {@link CanvasTextBaseline}. 5637 * 5638 * @return { CanvasTextBaseline } 5639 * @syscap SystemCapability.ArkUI.ArkUI.Full 5640 * @crossplatform 5641 * @form 5642 * @atomicservice 5643 * @since 20 5644 * @arkts 1.2 5645 */ 5646 get textBaseline(): CanvasTextBaseline; 5647 5648 /** 5649 * Set the text baseline. For details, see {@link CanvasTextBaseline}. 5650 * 5651 * @param { CanvasTextBaseline } 5652 * @syscap SystemCapability.ArkUI.ArkUI.Full 5653 * @crossplatform 5654 * @form 5655 * @atomicservice 5656 * @since 20 5657 * @arkts 1.2 5658 */ 5659 set textBaseline(textBaseline: CanvasTextBaseline); 5660 5661 /** 5662 * Obtains the currently applied transformation matrix. 5663 * 5664 * @returns { Matrix2D } 5665 * @syscap SystemCapability.ArkUI.ArkUI.Full 5666 * @since 8 5667 */ 5668 /** 5669 * Obtains the currently applied transformation matrix. 5670 * 5671 * @returns { Matrix2D } 5672 * @syscap SystemCapability.ArkUI.ArkUI.Full 5673 * @form 5674 * @since 9 5675 */ 5676 /** 5677 * Obtains the currently applied transformation matrix. 5678 * 5679 * @returns { Matrix2D } 5680 * @syscap SystemCapability.ArkUI.ArkUI.Full 5681 * @crossplatform 5682 * @form 5683 * @since 10 5684 */ 5685 /** 5686 * Obtains the currently applied transformation matrix. 5687 * 5688 * @returns { Matrix2D } 5689 * @syscap SystemCapability.ArkUI.ArkUI.Full 5690 * @crossplatform 5691 * @form 5692 * @atomicservice 5693 * @since arkts {'1.1':'11','1.2':'20'} 5694 * @arkts 1.1&1.2 5695 */ 5696 getTransform(): Matrix2D; 5697 5698 /** 5699 * Resets the current transformation matrix using the identity matrix 5700 * 5701 * @syscap SystemCapability.ArkUI.ArkUI.Full 5702 * @since 8 5703 */ 5704 /** 5705 * Resets the current transformation matrix using the identity matrix 5706 * 5707 * @syscap SystemCapability.ArkUI.ArkUI.Full 5708 * @form 5709 * @since 9 5710 */ 5711 /** 5712 * Resets the current transformation matrix using the identity matrix 5713 * 5714 * @syscap SystemCapability.ArkUI.ArkUI.Full 5715 * @crossplatform 5716 * @form 5717 * @since 10 5718 */ 5719 /** 5720 * Resets the current transformation matrix using the identity matrix 5721 * 5722 * @syscap SystemCapability.ArkUI.ArkUI.Full 5723 * @crossplatform 5724 * @form 5725 * @atomicservice 5726 * @since arkts {'1.1':'11','1.2':'20'} 5727 * @arkts 1.1&1.2 5728 */ 5729 resetTransform(): void; 5730 5731 /** 5732 * Adds the effect of a rotation 5733 * 5734 * @param { number } angle - The radian of clockwise rotation, which can be converted to an angle value using the formula: 5735 * degree * Math.PI / 180 5736 * @syscap SystemCapability.ArkUI.ArkUI.Full 5737 * @since 8 5738 */ 5739 /** 5740 * Adds the effect of a rotation 5741 * 5742 * @param { number } angle - The radian of clockwise rotation, which can be converted to an angle value using the formula: 5743 * degree * Math.PI / 180 5744 * @syscap SystemCapability.ArkUI.ArkUI.Full 5745 * @form 5746 * @since 9 5747 */ 5748 /** 5749 * Adds the effect of a rotation 5750 * 5751 * @param { number } angle - The radian of clockwise rotation, which can be converted to an angle value using the formula: 5752 * degree * Math.PI / 180 5753 * @syscap SystemCapability.ArkUI.ArkUI.Full 5754 * @crossplatform 5755 * @form 5756 * @since 10 5757 */ 5758 /** 5759 * Adds the effect of a rotation 5760 * 5761 * @param { number } angle - The radian of clockwise rotation, which can be converted to an angle value using the formula: 5762 * degree * Math.PI / 180 5763 * @syscap SystemCapability.ArkUI.ArkUI.Full 5764 * @crossplatform 5765 * @form 5766 * @atomicservice 5767 * @since arkts {'1.1':'11','1.2':'20'} 5768 * @arkts 1.1&1.2 5769 */ 5770 rotate(angle: number): void; 5771 5772 /** 5773 * Increases the scaling effect of the X and Y axes. 5774 * 5775 * @param { number } x - Horizontal scaling factor 5776 * @param { number } y - Vertical scaling factor 5777 * @syscap SystemCapability.ArkUI.ArkUI.Full 5778 * @since 8 5779 */ 5780 /** 5781 * Increases the scaling effect of the X and Y axes. 5782 * 5783 * @param { number } x - Horizontal scaling factor 5784 * @param { number } y - Vertical scaling factor 5785 * @syscap SystemCapability.ArkUI.ArkUI.Full 5786 * @form 5787 * @since 9 5788 */ 5789 /** 5790 * Increases the scaling effect of the X and Y axes. 5791 * 5792 * @param { number } x - Horizontal scaling factor 5793 * @param { number } y - Vertical scaling factor 5794 * @syscap SystemCapability.ArkUI.ArkUI.Full 5795 * @crossplatform 5796 * @form 5797 * @since 10 5798 */ 5799 /** 5800 * Increases the scaling effect of the X and Y axes. 5801 * 5802 * @param { number } x - Horizontal scaling factor 5803 * @param { number } y - Vertical scaling factor 5804 * @syscap SystemCapability.ArkUI.ArkUI.Full 5805 * @crossplatform 5806 * @form 5807 * @atomicservice 5808 * @since arkts {'1.1':'11','1.2':'20'} 5809 * @arkts 1.1&1.2 5810 */ 5811 scale(x: number, y: number): void; 5812 5813 /** 5814 * Adds 2D transformation effects, including rotation, translation, and scaling. 5815 * The current transformation matrix will not be overwritten. Multiple transformations will be superimposed. 5816 * 5817 * @param { number } a - Horizontal Zoom 5818 * @param { number } b - Vertical Tilt 5819 * @param { number } c - Horizontal Tilt 5820 * @param { number } d - Vertical Zoom 5821 * @param { number } e - Horizontal movement 5822 * @param { number } f - Vertical movement 5823 * @syscap SystemCapability.ArkUI.ArkUI.Full 5824 * @since 8 5825 */ 5826 /** 5827 * Adds 2D transformation effects, including rotation, translation, and scaling. 5828 * The current transformation matrix will not be overwritten. Multiple transformations will be superimposed. 5829 * 5830 * @param { number } a - Horizontal Zoom 5831 * @param { number } b - Vertical Tilt 5832 * @param { number } c - Horizontal Tilt 5833 * @param { number } d - Vertical Zoom 5834 * @param { number } e - Horizontal movement 5835 * @param { number } f - Vertical movement 5836 * @syscap SystemCapability.ArkUI.ArkUI.Full 5837 * @form 5838 * @since 9 5839 */ 5840 /** 5841 * Adds 2D transformation effects, including rotation, translation, and scaling. 5842 * The current transformation matrix will not be overwritten. Multiple transformations will be superimposed. 5843 * 5844 * @param { number } a - Horizontal Zoom 5845 * @param { number } b - Vertical Tilt 5846 * @param { number } c - Horizontal Tilt 5847 * @param { number } d - Vertical Zoom 5848 * @param { number } e - Horizontal movement 5849 * @param { number } f - Vertical movement 5850 * @syscap SystemCapability.ArkUI.ArkUI.Full 5851 * @crossplatform 5852 * @form 5853 * @since 10 5854 */ 5855 /** 5856 * Adds 2D transformation effects, including rotation, translation, and scaling. 5857 * The current transformation matrix will not be overwritten. Multiple transformations will be superimposed. 5858 * 5859 * @param { number } a - Horizontal Zoom 5860 * @param { number } b - Vertical Tilt 5861 * @param { number } c - Horizontal Tilt 5862 * @param { number } d - Vertical Zoom 5863 * @param { number } e - Horizontal movement 5864 * @param { number } f - Vertical movement 5865 * @syscap SystemCapability.ArkUI.ArkUI.Full 5866 * @crossplatform 5867 * @form 5868 * @atomicservice 5869 * @since arkts {'1.1':'11','1.2':'20'} 5870 * @arkts 1.1&1.2 5871 */ 5872 setTransform(a: number, b: number, c: number, d: number, e: number, f: number): void; 5873 5874 /** 5875 * The 2D transformation effect is added. The current transformation matrix is not overwritten and 5876 * the transformations are superimposed for multiple times. 5877 * 5878 * @param { Matrix2D } transform - 2D transformation matrix. For details, see {@link Matrix2D}. 5879 * @syscap SystemCapability.ArkUI.ArkUI.Full 5880 * @since 8 5881 */ 5882 /** 5883 * The 2D transformation effect is added. The current transformation matrix is not overwritten and 5884 * the transformations are superimposed for multiple times. 5885 * 5886 * @param { Matrix2D } transform - 2D transformation matrix. For details, see {@link Matrix2D}. 5887 * @syscap SystemCapability.ArkUI.ArkUI.Full 5888 * @form 5889 * @since 9 5890 */ 5891 /** 5892 * The 2D transformation effect is added. The current transformation matrix is not overwritten and 5893 * the transformations are superimposed for multiple times. 5894 * 5895 * @param { Matrix2D } transform - 2D transformation matrix. For details, see {@link Matrix2D}. 5896 * @syscap SystemCapability.ArkUI.ArkUI.Full 5897 * @crossplatform 5898 * @form 5899 * @since 10 5900 */ 5901 /** 5902 * The 2D transformation effect is added. The current transformation matrix is not overwritten and 5903 * the transformations are superimposed for multiple times. 5904 * 5905 * @param { Matrix2D } transform - 2D transformation matrix. For details, see {@link Matrix2D}. 5906 * @syscap SystemCapability.ArkUI.ArkUI.Full 5907 * @crossplatform 5908 * @form 5909 * @atomicservice 5910 * @since arkts {'1.1':'11','1.2':'20'} 5911 * @arkts 1.1&1.2 5912 */ 5913 setTransform(transform?: Matrix2D): void; 5914 5915 /** 5916 * Adds the 2D transformation effect, including rotation, translation, and scaling, 5917 * and overwrites the current transformation matrix. 5918 * 5919 * @param { number } a - Horizontal Zoom 5920 * @param { number } b - Vertical Tilt 5921 * @param { number } c - Horizontal Tilt 5922 * @param { number } d - Vertical Zoom 5923 * @param { number } e - Horizontal movement 5924 * @param { number } f - Vertical movement 5925 * @syscap SystemCapability.ArkUI.ArkUI.Full 5926 * @since 8 5927 */ 5928 /** 5929 * Adds the 2D transformation effect, including rotation, translation, and scaling, 5930 * and overwrites the current transformation matrix. 5931 * 5932 * @param { number } a - Horizontal Zoom 5933 * @param { number } b - Vertical Tilt 5934 * @param { number } c - Horizontal Tilt 5935 * @param { number } d - Vertical Zoom 5936 * @param { number } e - Horizontal movement 5937 * @param { number } f - Vertical movement 5938 * @syscap SystemCapability.ArkUI.ArkUI.Full 5939 * @form 5940 * @since 9 5941 */ 5942 /** 5943 * Adds the 2D transformation effect, including rotation, translation, and scaling, 5944 * and overwrites the current transformation matrix. 5945 * 5946 * @param { number } a - Horizontal Zoom 5947 * @param { number } b - Vertical Tilt 5948 * @param { number } c - Horizontal Tilt 5949 * @param { number } d - Vertical Zoom 5950 * @param { number } e - Horizontal movement 5951 * @param { number } f - Vertical movement 5952 * @syscap SystemCapability.ArkUI.ArkUI.Full 5953 * @crossplatform 5954 * @form 5955 * @since 10 5956 */ 5957 /** 5958 * Adds the 2D transformation effect, including rotation, translation, and scaling, 5959 * and overwrites the current transformation matrix. 5960 * 5961 * @param { number } a - Horizontal Zoom 5962 * @param { number } b - Vertical Tilt 5963 * @param { number } c - Horizontal Tilt 5964 * @param { number } d - Vertical Zoom 5965 * @param { number } e - Horizontal movement 5966 * @param { number } f - Vertical movement 5967 * @syscap SystemCapability.ArkUI.ArkUI.Full 5968 * @crossplatform 5969 * @form 5970 * @atomicservice 5971 * @since arkts {'1.1':'11','1.2':'20'} 5972 * @arkts 1.1&1.2 5973 */ 5974 transform(a: number, b: number, c: number, d: number, e: number, f: number): void; 5975 5976 /** 5977 * Increases the translation effect of the X and Y axes 5978 * 5979 * @param { number } x - Horizontal movement distance 5980 * @param { number } y - Vertical travel distance 5981 * @syscap SystemCapability.ArkUI.ArkUI.Full 5982 * @since 8 5983 */ 5984 /** 5985 * Increases the translation effect of the X and Y axes 5986 * 5987 * @param { number } x - Horizontal movement distance 5988 * @param { number } y - Vertical travel distance 5989 * @syscap SystemCapability.ArkUI.ArkUI.Full 5990 * @form 5991 * @since 9 5992 */ 5993 /** 5994 * Increases the translation effect of the X and Y axes 5995 * 5996 * @param { number } x - Horizontal movement distance 5997 * @param { number } y - Vertical travel distance 5998 * @syscap SystemCapability.ArkUI.ArkUI.Full 5999 * @crossplatform 6000 * @form 6001 * @since 10 6002 */ 6003 /** 6004 * Increases the translation effect of the X and Y axes 6005 * 6006 * @param { number } x - Horizontal movement distance 6007 * @param { number } y - Vertical travel distance 6008 * @syscap SystemCapability.ArkUI.ArkUI.Full 6009 * @crossplatform 6010 * @form 6011 * @atomicservice 6012 * @since arkts {'1.1':'11','1.2':'20'} 6013 * @arkts 1.1&1.2 6014 */ 6015 translate(x: number, y: number): void; 6016 6017 /** 6018 * Set a PixelMap to the current context. The drawing content is synchronized to the PixelMap. 6019 * 6020 * @param { PixelMap } value - PixelMap object 6021 * @syscap SystemCapability.ArkUI.ArkUI.Full 6022 * @since 8 6023 */ 6024 /** 6025 * Set a PixelMap to the current context. The drawing content is synchronized to the PixelMap. 6026 * 6027 * @param { PixelMap } value - PixelMap object 6028 * @syscap SystemCapability.ArkUI.ArkUI.Full 6029 * @crossplatform 6030 * @since 10 6031 */ 6032 /** 6033 * Set a PixelMap to the current context. The drawing content is synchronized to the PixelMap. 6034 * 6035 * @param { PixelMap } value - PixelMap object 6036 * @syscap SystemCapability.ArkUI.ArkUI.Full 6037 * @crossplatform 6038 * @atomicservice 6039 * @since arkts {'1.1':'11','1.2':'20'} 6040 * @arkts 1.1&1.2 6041 */ 6042 setPixelMap(value?: PixelMap): void; 6043 6044 /** 6045 * transfer ImageBitmap to content. 6046 * 6047 * @param { ImageBitmap } bitmap 6048 * @syscap SystemCapability.ArkUI.ArkUI.Full 6049 * @since 8 6050 */ 6051 /** 6052 * transfer ImageBitmap to content. 6053 * 6054 * @param { ImageBitmap } bitmap 6055 * @syscap SystemCapability.ArkUI.ArkUI.Full 6056 * @form 6057 * @since 9 6058 */ 6059 /** 6060 * transfer ImageBitmap to content. 6061 * 6062 * @param { ImageBitmap } bitmap 6063 * @syscap SystemCapability.ArkUI.ArkUI.Full 6064 * @crossplatform 6065 * @form 6066 * @since 10 6067 */ 6068 /** 6069 * transfer ImageBitmap to content. 6070 * 6071 * @param { ImageBitmap } bitmap 6072 * @syscap SystemCapability.ArkUI.ArkUI.Full 6073 * @crossplatform 6074 * @form 6075 * @atomicservice 6076 * @since arkts {'1.1':'11','1.2':'20'} 6077 * @arkts 1.1&1.2 6078 */ 6079 transferFromImageBitmap(bitmap: ImageBitmap): void; 6080 6081 /** 6082 * Allocate a layer for subsequent drawing. 6083 * 6084 * @syscap SystemCapability.ArkUI.ArkUI.Full 6085 * @crossplatform 6086 * @atomicservice 6087 * @since arkts {'1.1':'12','1.2':'20'} 6088 * @arkts 1.1&1.2 6089 */ 6090 saveLayer(): void; 6091 6092 /** 6093 * Remove changes to transform and clip since saveLayer was last called and draw the layer on canvas. 6094 * 6095 * @syscap SystemCapability.ArkUI.ArkUI.Full 6096 * @crossplatform 6097 * @atomicservice 6098 * @since arkts {'1.1':'12','1.2':'20'} 6099 * @arkts 1.1&1.2 6100 */ 6101 restoreLayer(): void; 6102 6103 /** 6104 * Clear the backing buffer, drawing state stack, any defined paths, and styles. 6105 * 6106 * @syscap SystemCapability.ArkUI.ArkUI.Full 6107 * @crossplatform 6108 * @atomicservice 6109 * @since arkts {'1.1':'12','1.2':'20'} 6110 * @arkts 1.1&1.2 6111 */ 6112 reset(): void; 6113} 6114 6115/** 6116 * Draw context object for the Canvas component. 6117 * 6118 * @extends CanvasRenderer 6119 * @syscap SystemCapability.ArkUI.ArkUI.Full 6120 * @since 8 6121 */ 6122/** 6123 * Draw context object for the Canvas component. 6124 * 6125 * @extends CanvasRenderer 6126 * @syscap SystemCapability.ArkUI.ArkUI.Full 6127 * @form 6128 * @since 9 6129 */ 6130/** 6131 * Draw context object for the Canvas component. 6132 * 6133 * @extends CanvasRenderer 6134 * @syscap SystemCapability.ArkUI.ArkUI.Full 6135 * @crossplatform 6136 * @form 6137 * @since 10 6138 */ 6139/** 6140 * Draw context object for the Canvas component. 6141 * 6142 * @extends CanvasRenderer 6143 * @syscap SystemCapability.ArkUI.ArkUI.Full 6144 * @crossplatform 6145 * @form 6146 * @atomicservice 6147 * @since arkts {'1.1':'11','1.2':'20'} 6148 * @arkts 1.1&1.2 6149 */ 6150declare class CanvasRenderingContext2D extends CanvasRenderer { 6151 /** 6152 * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. 6153 * 6154 * @type { number } 6155 * @readonly 6156 * @syscap SystemCapability.ArkUI.ArkUI.Full 6157 * @since 8 6158 */ 6159 /** 6160 * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. 6161 * 6162 * @type { number } 6163 * @readonly 6164 * @syscap SystemCapability.ArkUI.ArkUI.Full 6165 * @form 6166 * @since 9 6167 */ 6168 /** 6169 * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. 6170 * 6171 * @type { number } 6172 * @readonly 6173 * @syscap SystemCapability.ArkUI.ArkUI.Full 6174 * @crossplatform 6175 * @form 6176 * @since 10 6177 */ 6178 /** 6179 * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. 6180 * 6181 * @type { number } 6182 * @readonly 6183 * @syscap SystemCapability.ArkUI.ArkUI.Full 6184 * @crossplatform 6185 * @form 6186 * @atomicservice 6187 * @since 11 6188 */ 6189 readonly height: number; 6190 6191 /** 6192 * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. 6193 * 6194 * @return { number } 6195 * @readonly 6196 * @syscap SystemCapability.ArkUI.ArkUI.Full 6197 * @crossplatform 6198 * @form 6199 * @atomicservice 6200 * @since 20 6201 * @arkts 1.2 6202 */ 6203 get height(): number; 6204 6205 /** 6206 * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. 6207 * 6208 * @type { number } 6209 * @readonly 6210 * @syscap SystemCapability.ArkUI.ArkUI.Full 6211 * @since 8 6212 */ 6213 /** 6214 * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. 6215 * 6216 * @type { number } 6217 * @readonly 6218 * @syscap SystemCapability.ArkUI.ArkUI.Full 6219 * @form 6220 * @since 9 6221 */ 6222 /** 6223 * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. 6224 * 6225 * @type { number } 6226 * @readonly 6227 * @syscap SystemCapability.ArkUI.ArkUI.Full 6228 * @crossplatform 6229 * @form 6230 * @since 10 6231 */ 6232 /** 6233 * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. 6234 * 6235 * @type { number } 6236 * @readonly 6237 * @syscap SystemCapability.ArkUI.ArkUI.Full 6238 * @crossplatform 6239 * @form 6240 * @atomicservice 6241 * @since 11 6242 */ 6243 readonly width: number; 6244 6245 /** 6246 * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. 6247 * 6248 * @return { number } 6249 * @readonly 6250 * @syscap SystemCapability.ArkUI.ArkUI.Full 6251 * @crossplatform 6252 * @form 6253 * @atomicservice 6254 * @since 20 6255 * @arkts 1.2 6256 */ 6257 get width(): number; 6258 6259 /** 6260 * Frame node of the canvas. The default value is null. 6261 * 6262 * @type { FrameNode } 6263 * @readonly 6264 * @syscap SystemCapability.ArkUI.ArkUI.Full 6265 * @crossplatform 6266 * @atomicservice 6267 * @since 13 6268 */ 6269 readonly canvas: FrameNode; 6270 6271 /** 6272 * Frame node of the canvas. The default value is null. 6273 * 6274 * @return { FrameNode } 6275 * @syscap SystemCapability.ArkUI.ArkUI.Full 6276 * @crossplatform 6277 * @atomicservice 6278 * @since 20 6279 * @arkts 1.2 6280 */ 6281 get canvas(): FrameNode; 6282 6283 /** 6284 * Generate a character string in the data url format. 6285 * 6286 * @param { string } type - Image format. The default value is image/png. 6287 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6288 * If the value is out of the range, the default value 0.92 is used. 6289 * @returns { string } 6290 * @syscap SystemCapability.ArkUI.ArkUI.Full 6291 * @since 8 6292 */ 6293 /** 6294 * Generate a character string in the data url format. 6295 * 6296 * @param { string } type - Image format. The default value is image/png. 6297 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6298 * If the value is out of the range, the default value 0.92 is used. 6299 * @returns { string } 6300 * @syscap SystemCapability.ArkUI.ArkUI.Full 6301 * @form 6302 * @since 9 6303 */ 6304 /** 6305 * Generate a character string in the data url format. 6306 * 6307 * @param { string } type - Image format. The default value is image/png. 6308 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6309 * If the value is out of the range, the default value 0.92 is used. 6310 * @returns { string } 6311 * @syscap SystemCapability.ArkUI.ArkUI.Full 6312 * @crossplatform 6313 * @form 6314 * @since 10 6315 */ 6316 /** 6317 * Generate a character string in the data url format. 6318 * 6319 * @param { string } type - Image format. The default value is image/png. 6320 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6321 * If the value is out of the range, the default value 0.92 is used. 6322 * @returns { string } 6323 * @syscap SystemCapability.ArkUI.ArkUI.Full 6324 * @crossplatform 6325 * @form 6326 * @atomicservice 6327 * @since 11 6328 */ 6329 toDataURL(type?: string, quality?: any): string; 6330 6331 /** 6332 * Generate a character string in the data url format. 6333 * 6334 * @param { string } [type] - Image format. The default value is image/png. 6335 * @param { number } [quality] - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6336 * If the value is out of the range, the default value 0.92 is used. 6337 * @returns { string } 6338 * @syscap SystemCapability.ArkUI.ArkUI.Full 6339 * @crossplatform 6340 * @form 6341 * @atomicservice 6342 * @since 20 6343 * @arkts 1.2 6344 */ 6345 toDataURL(type?: string, quality?: number): string; 6346 6347 /** 6348 * Start image analyzer. 6349 * 6350 * @param { ImageAnalyzerConfig } config - Image analyzer config. 6351 * @returns { Promise<void> } The promise returned by the function. 6352 * @throws { BusinessError } 110001 - Image analysis feature is not supported. 6353 * @throws { BusinessError } 110002 - Image analysis is currently being executed. 6354 * @throws { BusinessError } 110003 - Image analysis is stopped. 6355 * @syscap SystemCapability.ArkUI.ArkUI.Full 6356 * @atomicservice 6357 * @since arkts {'1.1':'12','1.2':'20'} 6358 * @arkts 1.1&1.2 6359 */ 6360 startImageAnalyzer(config: ImageAnalyzerConfig): Promise<void>; 6361 6362 /** 6363 * Stop image analyzer. 6364 * @syscap SystemCapability.ArkUI.ArkUI.Full 6365 * @atomicservice 6366 * @since arkts {'1.1':'12','1.2':'20'} 6367 * @arkts 1.1&1.2 6368 */ 6369 stopImageAnalyzer(): void; 6370 6371 /** 6372 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6373 * 6374 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6375 * @syscap SystemCapability.ArkUI.ArkUI.Full 6376 * @since 8 6377 */ 6378 /** 6379 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6380 * 6381 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6382 * @syscap SystemCapability.ArkUI.ArkUI.Full 6383 * @form 6384 * @since 9 6385 */ 6386 /** 6387 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6388 * 6389 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6390 * @syscap SystemCapability.ArkUI.ArkUI.Full 6391 * @crossplatform 6392 * @form 6393 * @since 10 6394 */ 6395 /** 6396 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6397 * 6398 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6399 * @syscap SystemCapability.ArkUI.ArkUI.Full 6400 * @crossplatform 6401 * @form 6402 * @atomicservice 6403 * @since 11 6404 */ 6405 constructor(settings?: RenderingContextSettings); 6406 6407 /** 6408 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6409 * 6410 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6411 * @param { LengthMetricsUnit } [unit] - the unit mode 6412 * @syscap SystemCapability.ArkUI.ArkUI.Full 6413 * @crossplatform 6414 * @form 6415 * @atomicservice 6416 * @since arkts {'1.1':'12','1.2':'20'} 6417 * @arkts 1.1&1.2 6418 */ 6419 constructor(settings?: RenderingContextSettings, unit?: LengthMetricsUnit); 6420 6421 /** 6422 * Register the listener that watches if the canvasrenderingcontext2d attached to the Canvas frameNode. 6423 * 6424 * @param { 'onAttach' } type Indicates the type of event. 6425 * @param { Callback<void> } callback Indicates the listener. 6426 * @throws { BusinessError } 401 - Input parameter error. Possible causes: 6427 * 1. Mandatory parameters are left unspecified; 6428 * 2. Incorrect parameter types; 6429 * 3. Parameter verification failed. 6430 * @syscap SystemCapability.ArkUI.ArkUI.Full 6431 * @crossplatform 6432 * @atomicservice 6433 * @since arkts {'1.1':'13','1.2':'20'} 6434 * @arkts 1.1&1.2 6435 */ 6436 on(type: 'onAttach', callback: Callback<void>): void; 6437 6438 /** 6439 * Unregister the listener that watches if the canvasrenderingcontext2d attached to the Canvas frameNode. 6440 * 6441 * @param { 'onAttach' } type Indicates the type of event. 6442 * @param { Callback<void> } callback Indicates the listener. 6443 * @throws { BusinessError } 401 - Input parameter error. Possible causes: 6444 * 1. Mandatory parameters are left unspecified; 6445 * 2. Incorrect parameter types; 6446 * 3. Parameter verification failed. 6447 * @syscap SystemCapability.ArkUI.ArkUI.Full 6448 * @crossplatform 6449 * @atomicservice 6450 * @since arkts {'1.1':'13','1.2':'20'} 6451 * @arkts 1.1&1.2 6452 */ 6453 off(type: 'onAttach', callback?: Callback<void>): void; 6454 6455 /** 6456 * Register the listener that watches if the canvasrenderingcontext2d detached from the Canvas frameNode. 6457 * 6458 * @param { 'onDetach' } type Indicates the type of event. 6459 * @param { Callback<void> } callback Indicates the listener. 6460 * @throws { BusinessError } 401 - Input parameter error. Possible causes: 6461 * 1. Mandatory parameters are left unspecified; 6462 * 2. Incorrect parameter types; 6463 * 3. Parameter verification failed. 6464 * @syscap SystemCapability.ArkUI.ArkUI.Full 6465 * @crossplatform 6466 * @atomicservice 6467 * @since arkts {'1.1':'13','1.2':'20'} 6468 * @arkts 1.1&1.2 6469 */ 6470 on(type: 'onDetach', callback: Callback<void>): void; 6471 6472 /** 6473 * Unregister the listener that watches if the canvasrenderingcontext2d detached from the Canvas frameNode. 6474 * 6475 * @param { 'onDetach' } type Indicates the type of event. 6476 * @param { Callback<void> } callback Indicates the listener. 6477 * @throws { BusinessError } 401 - Input parameter error. Possible causes: 6478 * 1. Mandatory parameters are left unspecified; 6479 * 2. Incorrect parameter types; 6480 * 3. Parameter verification failed. 6481 * @syscap SystemCapability.ArkUI.ArkUI.Full 6482 * @crossplatform 6483 * @atomicservice 6484 * @since arkts {'1.1':'13','1.2':'20'} 6485 * @arkts 1.1&1.2 6486 */ 6487 off(type: 'onDetach', callback?: Callback<void>): void; 6488} 6489 6490/** 6491 * Draw context object for the OffscreenCanvas component. 6492 * 6493 * @extends CanvasRenderer 6494 * @syscap SystemCapability.ArkUI.ArkUI.Full 6495 * @since 8 6496 */ 6497/** 6498 * Draw context object for the OffscreenCanvas component. 6499 * 6500 * @extends CanvasRenderer 6501 * @syscap SystemCapability.ArkUI.ArkUI.Full 6502 * @form 6503 * @since 9 6504 */ 6505/** 6506 * Draw context object for the OffscreenCanvas component. 6507 * 6508 * @extends CanvasRenderer 6509 * @syscap SystemCapability.ArkUI.ArkUI.Full 6510 * @crossplatform 6511 * @form 6512 * @since 10 6513 */ 6514/** 6515 * Draw context object for the OffscreenCanvas component. 6516 * 6517 * @extends CanvasRenderer 6518 * @syscap SystemCapability.ArkUI.ArkUI.Full 6519 * @crossplatform 6520 * @form 6521 * @atomicservice 6522 * @since arkts {'1.1':'11','1.2':'20'} 6523 * @arkts 1.1&1.2 6524 */ 6525declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { 6526 /** 6527 * Generate a character string in the data url format. 6528 * 6529 * @param { string } type - Image format. The default value is image/png. 6530 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6531 * If the value is out of the range, the default value 0.92 is used. 6532 * @returns { string } 6533 * @syscap SystemCapability.ArkUI.ArkUI.Full 6534 * @since 8 6535 */ 6536 /** 6537 * Generate a character string in the data url format. 6538 * 6539 * @param { string } type - Image format. The default value is image/png. 6540 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6541 * If the value is out of the range, the default value 0.92 is used. 6542 * @returns { string } 6543 * @syscap SystemCapability.ArkUI.ArkUI.Full 6544 * @form 6545 * @since 9 6546 */ 6547 /** 6548 * Generate a character string in the data url format. 6549 * 6550 * @param { string } type - Image format. The default value is image/png. 6551 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6552 * If the value is out of the range, the default value 0.92 is used. 6553 * @returns { string } 6554 * @syscap SystemCapability.ArkUI.ArkUI.Full 6555 * @crossplatform 6556 * @form 6557 * @since 10 6558 */ 6559 /** 6560 * Generate a character string in the data url format. 6561 * 6562 * @param { string } type - Image format. The default value is image/png. 6563 * @param { any } quality - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6564 * If the value is out of the range, the default value 0.92 is used. 6565 * @returns { string } 6566 * @syscap SystemCapability.ArkUI.ArkUI.Full 6567 * @crossplatform 6568 * @form 6569 * @atomicservice 6570 * @since 11 6571 */ 6572 toDataURL(type?: string, quality?: any): string; 6573 6574 /** 6575 * Generate a character string in the data url format. 6576 * 6577 * @param { string } [type] - Image format. The default value is image/png. 6578 * @param { number } [quality] - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. 6579 * If the value is out of the range, the default value 0.92 is used. 6580 * @returns { string } 6581 * @syscap SystemCapability.ArkUI.ArkUI.Full 6582 * @crossplatform 6583 * @form 6584 * @atomicservice 6585 * @since 20 6586 * @arkts 1.2 6587 */ 6588 toDataURL(type?: string, quality?: number): string; 6589 6590 /** 6591 * transfer the content to ImageBitmap 6592 * 6593 * @returns { ImageBitmap } 6594 * @syscap SystemCapability.ArkUI.ArkUI.Full 6595 * @since 8 6596 */ 6597 /** 6598 * transfer the content to ImageBitmap 6599 * 6600 * @returns { ImageBitmap } 6601 * @syscap SystemCapability.ArkUI.ArkUI.Full 6602 * @form 6603 * @since 9 6604 */ 6605 /** 6606 * transfer the content to ImageBitmap 6607 * 6608 * @returns { ImageBitmap } 6609 * @syscap SystemCapability.ArkUI.ArkUI.Full 6610 * @crossplatform 6611 * @form 6612 * @since 10 6613 */ 6614 /** 6615 * transfer the content to ImageBitmap 6616 * 6617 * @returns { ImageBitmap } 6618 * @syscap SystemCapability.ArkUI.ArkUI.Full 6619 * @crossplatform 6620 * @form 6621 * @atomicservice 6622 * @since arkts {'1.1':'11','1.2':'20'} 6623 * @arkts 1.1&1.2 6624 */ 6625 transferToImageBitmap(): ImageBitmap; 6626 6627 /** 6628 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6629 * 6630 * @param { number } width - the width of the OffscreenCanvas 6631 * @param { number } height - the height of the OffscreenCanvas 6632 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6633 * @syscap SystemCapability.ArkUI.ArkUI.Full 6634 * @since 8 6635 */ 6636 /** 6637 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6638 * 6639 * @param { number } width - the width of the OffscreenCanvas 6640 * @param { number } height - the height of the OffscreenCanvas 6641 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6642 * @syscap SystemCapability.ArkUI.ArkUI.Full 6643 * @form 6644 * @since 9 6645 */ 6646 /** 6647 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6648 * 6649 * @param { number } width - the width of the OffscreenCanvas 6650 * @param { number } height - the height of the OffscreenCanvas 6651 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6652 * @syscap SystemCapability.ArkUI.ArkUI.Full 6653 * @crossplatform 6654 * @form 6655 * @since 10 6656 */ 6657 /** 6658 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6659 * 6660 * @param { number } width - the width of the OffscreenCanvas 6661 * @param { number } height - the height of the OffscreenCanvas 6662 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6663 * @syscap SystemCapability.ArkUI.ArkUI.Full 6664 * @crossplatform 6665 * @form 6666 * @atomicservice 6667 * @since 11 6668 */ 6669 constructor(width: number, height: number, settings?: RenderingContextSettings); 6670 6671 /** 6672 * Constructor of the canvas drawing context object, which is used to create a drawing context object. 6673 * 6674 * @param { number } width - the width of the OffscreenCanvas 6675 * @param { number } height - the height of the OffscreenCanvas 6676 * @param { RenderingContextSettings } settings - Drawing attribute. For details, see {@link RenderingContextSettings}. 6677 * @param { LengthMetricsUnit } [unit] - the unit mode 6678 * @syscap SystemCapability.ArkUI.ArkUI.Full 6679 * @crossplatform 6680 * @form 6681 * @atomicservice 6682 * @since arkts {'1.1':'12','1.2':'20'} 6683 * @arkts 1.1&1.2 6684 */ 6685 constructor(width: number, height: number, settings?: RenderingContextSettings, unit?: LengthMetricsUnit); 6686} 6687 6688/** 6689 * Draw an object off the screen. The drawing content is not directly displayed on the screen. 6690 * 6691 * @extends CanvasRenderer 6692 * @syscap SystemCapability.ArkUI.ArkUI.Full 6693 * @since 8 6694 */ 6695/** 6696 * Draw an object off the screen. The drawing content is not directly displayed on the screen. 6697 * 6698 * @extends CanvasRenderer 6699 * @syscap SystemCapability.ArkUI.ArkUI.Full 6700 * @form 6701 * @since 9 6702 */ 6703/** 6704 * Draw an object off the screen. The drawing content is not directly displayed on the screen. 6705 * 6706 * @extends CanvasRenderer 6707 * @syscap SystemCapability.ArkUI.ArkUI.Full 6708 * @crossplatform 6709 * @form 6710 * @since 10 6711 */ 6712/** 6713 * Draw an object off the screen. The drawing content is not directly displayed on the screen. 6714 * 6715 * @syscap SystemCapability.ArkUI.ArkUI.Full 6716 * @crossplatform 6717 * @form 6718 * @atomicservice 6719 * @since arkts {'1.1':'11','1.2':'20'} 6720 * @arkts 1.1&1.2 6721 */ 6722declare class OffscreenCanvas { 6723 /** 6724 * Height of the off-screen canvas. 6725 * 6726 * @type { number } 6727 * @syscap SystemCapability.ArkUI.ArkUI.Full 6728 * @since 8 6729 */ 6730 /** 6731 * Height of the off-screen canvas. 6732 * 6733 * @type { number } 6734 * @syscap SystemCapability.ArkUI.ArkUI.Full 6735 * @form 6736 * @since 9 6737 */ 6738 /** 6739 * Height of the off-screen canvas. 6740 * 6741 * @type { number } 6742 * @syscap SystemCapability.ArkUI.ArkUI.Full 6743 * @crossplatform 6744 * @form 6745 * @since 10 6746 */ 6747 /** 6748 * Height of the off-screen canvas. 6749 * 6750 * @type { number } 6751 * @syscap SystemCapability.ArkUI.ArkUI.Full 6752 * @crossplatform 6753 * @form 6754 * @atomicservice 6755 * @since 11 6756 */ 6757 height: number; 6758 6759 /** 6760 * Get the height of the off-screen canvas. 6761 * 6762 * @return { number } 6763 * @syscap SystemCapability.ArkUI.ArkUI.Full 6764 * @crossplatform 6765 * @form 6766 * @atomicservice 6767 * @since 20 6768 * @arkts 1.2 6769 */ 6770 get height(): number; 6771 6772 /** 6773 * Set the height of the off-screen canvas. 6774 * 6775 * @param { number } 6776 * @syscap SystemCapability.ArkUI.ArkUI.Full 6777 * @crossplatform 6778 * @form 6779 * @atomicservice 6780 * @since 20 6781 * @arkts 1.2 6782 */ 6783 set height(height: number); 6784 6785 /** 6786 * Width of the off-screen canvas. 6787 * 6788 * @type { number } 6789 * @syscap SystemCapability.ArkUI.ArkUI.Full 6790 * @since 8 6791 */ 6792 /** 6793 * Width of the off-screen canvas. 6794 * 6795 * @type { number } 6796 * @syscap SystemCapability.ArkUI.ArkUI.Full 6797 * @form 6798 * @since 9 6799 */ 6800 /** 6801 * Width of the off-screen canvas. 6802 * 6803 * @type { number } 6804 * @syscap SystemCapability.ArkUI.ArkUI.Full 6805 * @crossplatform 6806 * @form 6807 * @since 10 6808 */ 6809 /** 6810 * Width of the off-screen canvas. 6811 * 6812 * @type { number } 6813 * @syscap SystemCapability.ArkUI.ArkUI.Full 6814 * @crossplatform 6815 * @form 6816 * @atomicservice 6817 * @since 11 6818 */ 6819 width: number; 6820 6821 /** 6822 * Get the width of the off-screen canvas. 6823 * 6824 * @return { number } 6825 * @syscap SystemCapability.ArkUI.ArkUI.Full 6826 * @crossplatform 6827 * @form 6828 * @atomicservice 6829 * @since 20 6830 * @arkts 1.2 6831 */ 6832 get width(): number; 6833 6834 /** 6835 * Set the width of the off-screen canvas. 6836 * 6837 * @param { number } 6838 * @syscap SystemCapability.ArkUI.ArkUI.Full 6839 * @crossplatform 6840 * @form 6841 * @atomicservice 6842 * @since 20 6843 * @arkts 1.2 6844 */ 6845 set width(width: number); 6846 6847 /** 6848 * Exports rendered content as an ImageBitmap object 6849 * 6850 * @returns { ImageBitmap } 6851 * @syscap SystemCapability.ArkUI.ArkUI.Full 6852 * @since 8 6853 */ 6854 /** 6855 * Exports rendered content as an ImageBitmap object 6856 * 6857 * @returns { ImageBitmap } 6858 * @syscap SystemCapability.ArkUI.ArkUI.Full 6859 * @form 6860 * @since 9 6861 */ 6862 /** 6863 * Exports rendered content as an ImageBitmap object 6864 * 6865 * @returns { ImageBitmap } 6866 * @syscap SystemCapability.ArkUI.ArkUI.Full 6867 * @crossplatform 6868 * @form 6869 * @since 10 6870 */ 6871 /** 6872 * Exports rendered content as an ImageBitmap object 6873 * 6874 * @returns { ImageBitmap } 6875 * @syscap SystemCapability.ArkUI.ArkUI.Full 6876 * @crossplatform 6877 * @form 6878 * @atomicservice 6879 * @since arkts {'1.1':'11','1.2':'20'} 6880 * @arkts 1.1&1.2 6881 */ 6882 transferToImageBitmap(): ImageBitmap; 6883 6884 /** 6885 * Creates the context from the current OffscreenCanvas. 6886 * 6887 * @param { "2d" } contextType - The context type, only "2d" be supported now. 6888 * "2d": Creates a {@link OffscreenCanvasRenderingContext2D} object representing a two-dimensional rendering context. 6889 * @param { RenderingContextSettings } options - Drawing attribute. For details, see {@link RenderingContextSettings}. 6890 * @returns { OffscreenCanvasRenderingContext2D } The rendering context of offscreen canvas, see {@link OffscreenCanvasRenderingContext2D}. 6891 * @syscap SystemCapability.ArkUI.ArkUI.Full 6892 * @crossplatform 6893 * @since 10 6894 */ 6895 /** 6896 * Creates the context from the current OffscreenCanvas. 6897 * 6898 * @param { "2d" } contextType - The context type, only "2d" be supported now. 6899 * "2d": Creates a {@link OffscreenCanvasRenderingContext2D} object representing a two-dimensional rendering context. 6900 * @param { RenderingContextSettings } options - Drawing attribute. For details, see {@link RenderingContextSettings}. 6901 * @returns { OffscreenCanvasRenderingContext2D } The rendering context of offscreen canvas, see {@link OffscreenCanvasRenderingContext2D}. 6902 * @syscap SystemCapability.ArkUI.ArkUI.Full 6903 * @crossplatform 6904 * @atomicservice 6905 * @since arkts {'1.1':'11','1.2':'20'} 6906 * @arkts 1.1&1.2 6907 */ 6908 getContext(contextType: "2d", options?: RenderingContextSettings): OffscreenCanvasRenderingContext2D; 6909 6910 /** 6911 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6912 * 6913 * @param { number } width - Width of the off-screen canvas. 6914 * @param { number } height - Height of the off-screen canvas. 6915 * @syscap SystemCapability.ArkUI.ArkUI.Full 6916 * @since 8 6917 */ 6918 /** 6919 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6920 * 6921 * @param { number } width - Width of the off-screen canvas. 6922 * @param { number } height - Height of the off-screen canvas. 6923 * @syscap SystemCapability.ArkUI.ArkUI.Full 6924 * @form 6925 * @since 9 6926 */ 6927 /** 6928 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6929 * 6930 * @param { number } width - Width of the off-screen canvas. 6931 * @param { number } height - Height of the off-screen canvas. 6932 * @syscap SystemCapability.ArkUI.ArkUI.Full 6933 * @crossplatform 6934 * @form 6935 * @since 10 6936 */ 6937 /** 6938 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6939 * 6940 * @param { number } width - Width of the off-screen canvas. 6941 * @param { number } height - Height of the off-screen canvas. 6942 * @syscap SystemCapability.ArkUI.ArkUI.Full 6943 * @crossplatform 6944 * @form 6945 * @atomicservice 6946 * @since 11 6947 */ 6948 constructor(width: number, height: number); 6949 6950 /** 6951 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6952 * 6953 * @param { number } width - Width of the off-screen canvas. 6954 * @param { number } height - Height of the off-screen canvas. 6955 * @param { LengthMetricsUnit } unit - the unit mode 6956 * @syscap SystemCapability.ArkUI.ArkUI.Full 6957 * @crossplatform 6958 * @form 6959 * @atomicservice 6960 * @since 12 6961 */ 6962 constructor(width: number, height: number, unit: LengthMetricsUnit); 6963 6964 /** 6965 * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. 6966 * 6967 * @param { number } width - Width of the off-screen canvas. 6968 * @param { number } height - Height of the off-screen canvas. 6969 * @param { LengthMetricsUnit } [unit] - the unit mode 6970 * @syscap SystemCapability.ArkUI.ArkUI.Full 6971 * @crossplatform 6972 * @form 6973 * @atomicservice 6974 * @since 20 6975 * @arkts 1.2 6976 */ 6977 constructor(width: number, height: number, unit?: LengthMetricsUnit); 6978} 6979 6980/** 6981 * Size info. 6982 * 6983 * @interface Size 6984 * @syscap SystemCapability.ArkUI.ArkUI.Full 6985 * @crossplatform 6986 * @atomicservice 6987 * @since 12 6988 */ 6989declare interface Size { 6990 /** 6991 * Defines the width property. 6992 * 6993 * @type { number } 6994 * @syscap SystemCapability.ArkUI.ArkUI.Full 6995 * @crossplatform 6996 * @atomicservice 6997 * @since 12 6998 */ 6999 width: number; 7000 7001 /** 7002 * Defines the height property. 7003 * 7004 * @type { number } 7005 * @syscap SystemCapability.ArkUI.ArkUI.Full 7006 * @crossplatform 7007 * @atomicservice 7008 * @since 12 7009 */ 7010 height: number; 7011} 7012 7013/** 7014 * Defines DrawingRenderingContext. 7015 * 7016 * @syscap SystemCapability.ArkUI.ArkUI.Full 7017 * @crossplatform 7018 * @atomicservice 7019 * @since arkts {'1.1':'12','1.2':'20'} 7020 * @arkts 1.1&1.2 7021 */ 7022declare class DrawingRenderingContext { 7023 7024 /** 7025 * Get size of the DrawingRenderingContext. 7026 * 7027 * @returns { Size } The size of the DrawingRenderingContext. 7028 * @syscap SystemCapability.ArkUI.ArkUI.Full 7029 * @crossplatform 7030 * @atomicservice 7031 * @since arkts {'1.1':'12','1.2':'20'} 7032 * @arkts 1.1&1.2 7033 */ 7034 get size(): Size; 7035 7036 /** 7037 * Get canvas of the DrawingRenderingContext. 7038 * 7039 * @returns { DrawingCanvas } The canvas of the DrawingRenderingContext. 7040 * @syscap SystemCapability.ArkUI.ArkUI.Full 7041 * @crossplatform 7042 * @atomicservice 7043 * @since 12 7044 */ 7045 get canvas(): DrawingCanvas; 7046 7047 /** 7048 * Invalidate the component, which will cause a re-render of the component. 7049 * 7050 * @syscap SystemCapability.ArkUI.ArkUI.Full 7051 * @crossplatform 7052 * @atomicservice 7053 * @since arkts {'1.1':'12','1.2':'20'} 7054 * @arkts 1.1&1.2 7055 */ 7056 invalidate(): void; 7057 7058 /** 7059 * Create DrawingRenderingContext with setting LengthMetricsUnit. 7060 * 7061 * @param { LengthMetricsUnit } [unit] - the unit mode 7062 * @syscap SystemCapability.ArkUI.ArkUI.Full 7063 * @crossplatform 7064 * @atomicservice 7065 * @since arkts {'1.1':'12','1.2':'20'} 7066 * @arkts 1.1&1.2 7067 */ 7068 constructor(unit?: LengthMetricsUnit); 7069} 7070 7071/** 7072 *TextTimer component, which provides the text timer capability. 7073 * 7074 * @interface CanvasInterface 7075 * @syscap SystemCapability.ArkUI.ArkUI.Full 7076 * @since 8 7077 */ 7078/** 7079 *TextTimer component, which provides the text timer capability. 7080 * 7081 * @interface CanvasInterface 7082 * @syscap SystemCapability.ArkUI.ArkUI.Full 7083 * @form 7084 * @since 9 7085 */ 7086/** 7087 *TextTimer component, which provides the text timer capability. 7088 * 7089 * @interface CanvasInterface 7090 * @syscap SystemCapability.ArkUI.ArkUI.Full 7091 * @crossplatform 7092 * @form 7093 * @since 10 7094 */ 7095/** 7096 *TextTimer component, which provides the text timer capability. 7097 * 7098 * @interface CanvasInterface 7099 * @syscap SystemCapability.ArkUI.ArkUI.Full 7100 * @crossplatform 7101 * @form 7102 * @atomicservice 7103 * @since arkts {'1.1':'11','1.2':'20'} 7104 * @arkts 1.1&1.2 7105 */ 7106interface CanvasInterface { 7107 /** 7108 * Construct a canvas component. 7109 * 7110 * @param { CanvasRenderingContext2D } context - Canvas context object. For details, see {@link CanvasRenderingContext2D}. 7111 * @returns { CanvasAttribute } 7112 * @syscap SystemCapability.ArkUI.ArkUI.Full 7113 * @since 8 7114 */ 7115 /** 7116 * Construct a canvas component. 7117 * 7118 * @param { CanvasRenderingContext2D } context - Canvas context object. For details, see {@link CanvasRenderingContext2D}. 7119 * @returns { CanvasAttribute } 7120 * @syscap SystemCapability.ArkUI.ArkUI.Full 7121 * @form 7122 * @since 9 7123 */ 7124 /** 7125 * Construct a canvas component. 7126 * 7127 * @param { CanvasRenderingContext2D } context - Canvas context object. For details, see {@link CanvasRenderingContext2D}. 7128 * @returns { CanvasAttribute } 7129 * @syscap SystemCapability.ArkUI.ArkUI.Full 7130 * @crossplatform 7131 * @form 7132 * @since 10 7133 */ 7134 /** 7135 * Construct a canvas component. 7136 * 7137 * @param { CanvasRenderingContext2D } context - Canvas context object. For details, see {@link CanvasRenderingContext2D}. 7138 * @returns { CanvasAttribute } 7139 * @syscap SystemCapability.ArkUI.ArkUI.Full 7140 * @crossplatform 7141 * @form 7142 * @atomicservice 7143 * @since 11 7144 */ 7145 /** 7146 * Construct a canvas component. 7147 * 7148 * @param { CanvasRenderingContext2D | DrawingRenderingContext } context - Canvas context object. 7149 * @returns { CanvasAttribute } 7150 * @syscap SystemCapability.ArkUI.ArkUI.Full 7151 * @crossplatform 7152 * @form 7153 * @atomicservice 7154 * @since arkts {'1.1':'12','1.2':'20'} 7155 * @arkts 1.1&1.2 7156 */ 7157 (context?: CanvasRenderingContext2D | DrawingRenderingContext): CanvasAttribute; 7158 7159 /** 7160 * Construct a canvas component. 7161 * 7162 * @param { CanvasRenderingContext2D | DrawingRenderingContext } context - Canvas context object. 7163 * @param { ImageAIOptions } imageAIOptions 7164 * @returns { CanvasAttribute } 7165 * @syscap SystemCapability.ArkUI.ArkUI.Full 7166 * @atomicservice 7167 * @since arkts {'1.1':'12','1.2':'20'} 7168 * @arkts 1.1&1.2 7169 */ 7170 (context: CanvasRenderingContext2D | DrawingRenderingContext, imageAIOptions: ImageAIOptions): CanvasAttribute; 7171} 7172 7173/** 7174 * Provides attribute for Canvas. 7175 * 7176 * @extends CommonMethod<CanvasAttribute> 7177 * @syscap SystemCapability.ArkUI.ArkUI.Full 7178 * @since 8 7179 */ 7180/** 7181 * Provides attribute for Canvas. 7182 * 7183 * @extends CommonMethod<CanvasAttribute> 7184 * @syscap SystemCapability.ArkUI.ArkUI.Full 7185 * @form 7186 * @since 9 7187 */ 7188/** 7189 * Provides attribute for Canvas. 7190 * 7191 * @extends CommonMethod<CanvasAttribute> 7192 * @syscap SystemCapability.ArkUI.ArkUI.Full 7193 * @crossplatform 7194 * @form 7195 * @since 10 7196 */ 7197/** 7198 * Provides attribute for Canvas. 7199 * 7200 * @extends CommonMethod<CanvasAttribute> 7201 * @syscap SystemCapability.ArkUI.ArkUI.Full 7202 * @crossplatform 7203 * @form 7204 * @atomicservice 7205 * @since arkts {'1.1':'11','1.2':'20'} 7206 * @arkts 1.1&1.2 7207 */ 7208declare class CanvasAttribute extends CommonMethod<CanvasAttribute> { 7209 /** 7210 * Event notification after the canvas component is constructed. You can draw the canvas at this time. 7211 * 7212 * @param { function } event 7213 * @returns { CanvasAttribute } 7214 * @syscap SystemCapability.ArkUI.ArkUI.Full 7215 * @since 8 7216 */ 7217 /** 7218 * Event notification after the canvas component is constructed. You can draw the canvas at this time. 7219 * 7220 * @param { function } event 7221 * @returns { CanvasAttribute } 7222 * @syscap SystemCapability.ArkUI.ArkUI.Full 7223 * @form 7224 * @since 9 7225 */ 7226 /** 7227 * Event notification after the canvas component is constructed. You can draw the canvas at this time. 7228 * 7229 * @param { function } event 7230 * @returns { CanvasAttribute } 7231 * @syscap SystemCapability.ArkUI.ArkUI.Full 7232 * @crossplatform 7233 * @form 7234 * @since 10 7235 */ 7236 /** 7237 * Event notification after the canvas component is constructed. You can draw the canvas at this time. 7238 * 7239 * @param { function } event 7240 * @returns { CanvasAttribute } 7241 * @syscap SystemCapability.ArkUI.ArkUI.Full 7242 * @crossplatform 7243 * @form 7244 * @atomicservice 7245 * @since 11 7246 */ 7247 /** 7248 * Event notification after the canvas component is constructed. You can draw the canvas at this time. 7249 * 7250 * @param { VoidCallback } event 7251 * @returns { CanvasAttribute } 7252 * @syscap SystemCapability.ArkUI.ArkUI.Full 7253 * @crossplatform 7254 * @form 7255 * @atomicservice 7256 * @since arkts {'1.1':'18','1.2':'20'} 7257 * @arkts 1.1&1.2 7258 */ 7259 onReady(event: VoidCallback): CanvasAttribute; 7260 7261 /** 7262 * Enable image analyzer for Canvas. 7263 * 7264 * @param { boolean } enable - If enable image analyzer for Canvas. The default value is false. 7265 * @returns { CanvasAttribute } 7266 * @syscap SystemCapability.ArkUI.ArkUI.Full 7267 * @atomicservice 7268 * @since arkts {'1.1':'12','1.2':'20'} 7269 * @arkts 1.1&1.2 7270 */ 7271 enableAnalyzer(enable: boolean): CanvasAttribute; 7272} 7273 7274/** 7275 * Defines Canvas Component. 7276 * 7277 * @syscap SystemCapability.ArkUI.ArkUI.Full 7278 * @since 8 7279 */ 7280/** 7281 * Defines Canvas Component. 7282 * 7283 * @syscap SystemCapability.ArkUI.ArkUI.Full 7284 * @form 7285 * @since 9 7286 */ 7287/** 7288 * Defines Canvas Component. 7289 * 7290 * @syscap SystemCapability.ArkUI.ArkUI.Full 7291 * @crossplatform 7292 * @form 7293 * @since 10 7294 */ 7295/** 7296 * Defines Canvas Component. 7297 * 7298 * @syscap SystemCapability.ArkUI.ArkUI.Full 7299 * @crossplatform 7300 * @form 7301 * @atomicservice 7302 * @since 11 7303 */ 7304declare const Canvas: CanvasInterface; 7305 7306/** 7307 * Defines Canvas Component instance. 7308 * 7309 * @syscap SystemCapability.ArkUI.ArkUI.Full 7310 * @since 8 7311 */ 7312/** 7313 * Defines Canvas Component instance. 7314 * 7315 * @syscap SystemCapability.ArkUI.ArkUI.Full 7316 * @form 7317 * @since 9 7318 */ 7319/** 7320 * Defines Canvas Component instance. 7321 * 7322 * @syscap SystemCapability.ArkUI.ArkUI.Full 7323 * @crossplatform 7324 * @form 7325 * @since 10 7326 */ 7327/** 7328 * Defines Canvas Component instance. 7329 * 7330 * @syscap SystemCapability.ArkUI.ArkUI.Full 7331 * @crossplatform 7332 * @form 7333 * @atomicservice 7334 * @since 11 7335 */ 7336declare const CanvasInstance: CanvasAttribute; 7337