diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md index 377741ed300883efc9a0cdd62daf864e0ecac9e0..ce992708d1f3f25163b0d5637cd649b323f347b1 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md @@ -35,35 +35,37 @@ } } ``` - + - 示意图（关闭抗锯齿） + ![zh-cn_image_0000001214837333](figures/zh-cn_image_0000001214837333.png) - 示意图（开启抗锯齿） + ![zh-cn_image_0000001127125162](figures/zh-cn_image_0000001127125162.png) ## 属性 -| 名称 | 类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| [fillStyle](#fillstyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | 指定绘制的填充色。
- 类型为<color>时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 createLinearGradient()方法创建。
- 类型为CanvasPattern时，使用 createPattern()方法创建。 | -| [lineWidth](#linewidth) | number | - | 设置绘制线条的宽度。 | -| [strokeStyle](#strokestyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | 设置描边的颜色。
- 类型为<color>时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 createLinearGradient()方法创建。
- 类型为CanvasPattern时，使用 createPattern()方法创建。 | -| [lineCap](#linecap) | string | butt | 指定线端点的样式，可选值为：
- butt：线端点以方形结束。
- round：线端点以圆形结束。
- square：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。 | -| [lineJoin](#linejoin) | string | miter | 指定线段间相交的交点样式，可选值为：
- round：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- bevel：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- miter：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。 | -| [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。 | -| [font](#font) | string | "normal normal 14px sans-serif" | 设置文本绘制中的字体样式。
语法：ctx.font="font-style font-weight font-size font-family"5+
- font-style(可选)，用于指定字体样式，支持如下几种样式：normal, italic。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：normal, bold, bolder, lighter, 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：sans-serif, serif, monospace。 | -| [textAlign](#textalign) | string | left | 设置文本绘制中的文本对齐方式，可选值为：
- left：文本左对齐。
- right：文本右对齐。
- center：文本居中对齐。
- start：文本对齐界线开始的地方。
- end：文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ltr布局模式下start和left一致，rtl布局模式下start和right一致·。 | -| [textBaseline](#textbaseline) | string | alphabetic | 设置文本绘制中的水平对齐方式，可选值为：
- alphabetic：文本基线是标准的字母基线。
- top：文本基线在文本块的顶部。
- hanging：文本基线是悬挂基线。
- middle：文本基线在文本块的中间。
- ideographic：文字基线是表意字基线；如果字符本身超出了alphabetic 基线，那么ideographic基线位置在字符本身的底部。
- bottom：文本基线在文本块的底部。 与 ideographic 基线的区别在于 ideographic 基线不需要考虑下行字母。 | -| [globalAlpha](#globalalpha) | number | - | 设置透明度，0.0为完全透明，1.0为完全不透明。 | -| [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量，精度为float。 | -| [globalCompositeOperation](#globalcompositeoperation) | string | source-over | 设置合成操作的方式。类型字段可选值有source-over，source-atop，source-in，source-out，destination-over，destination-atop，destination-in，destination-out，lighter，copy，xor。具体请参考[表 类型字段说明](#globalcompositeoperation)。 | -| [shadowBlur](#shadowblur) | number | 0.0 | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。 | -| [shadowColor](#shadowcolor) | <color> | - | 设置绘制阴影时的阴影颜色。 | -| [shadowOffsetX](#shadowoffsetx) | number | - | 设置绘制阴影时和原有对象的水平偏移值。 | -| [shadowOffsetY](#shadowoffsety) | number | - | 设置绘制阴影时和原有对象的垂直偏移值。 | -| [imageSmoothingEnabled](#imagesmoothingenabled6)6+ | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | +| 名称 | 类型 | 默认值 | 描述 | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| [fillStyle](#fillstyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | 指定绘制的填充色。
- 类型为<color>时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 createLinearGradient()方法创建。
- 类型为CanvasPattern时，使用 createPattern()方法创建。 | +| [lineWidth](#linewidth) | number | - | 设置绘制线条的宽度。 | +| [strokeStyle](#strokestyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | 设置描边的颜色。
- 类型为<color>时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 createLinearGradient()方法创建。
- 类型为CanvasPattern时，使用 createPattern()方法创建。 | +| [lineCap](#linecap) | string | butt | 指定线端点的样式，可选值为：
- butt：线端点以方形结束。
- round：线端点以圆形结束。
- square：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。 | +| [lineJoin](#linejoin) | string | miter | 指定线段间相交的交点样式，可选值为：
- round：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- bevel：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- miter：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。 | +| [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。 | +| [font](#font) | string | "normal normal 14px sans-serif" | 设置文本绘制中的字体样式。
语法：ctx.font="font-style font-weight font-size font-family"5+
- font-style(可选)，用于指定字体样式，支持如下几种样式：normal, italic。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：normal, bold, bolder, lighter, 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：sans-serif, serif, monospace。 | +| [textAlign](#textalign) | string | left | 设置文本绘制中的文本对齐方式，可选值为：
- left：文本左对齐。
- right：文本右对齐。
- center：文本居中对齐。
- start：文本对齐界线开始的地方。
- end：文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ltr布局模式下start和left一致，rtl布局模式下start和right一致·。 | +| [textBaseline](#textbaseline) | string | alphabetic | 设置文本绘制中的水平对齐方式，可选值为：
- alphabetic：文本基线是标准的字母基线。
- top：文本基线在文本块的顶部。
- hanging：文本基线是悬挂基线。
- middle：文本基线在文本块的中间。
- ideographic：文字基线是表意字基线；如果字符本身超出了alphabetic 基线，那么ideographic基线位置在字符本身的底部。
- bottom：文本基线在文本块的底部。 与 ideographic 基线的区别在于 ideographic 基线不需要考虑下行字母。 | +| [globalAlpha](#globalalpha) | number | - | 设置透明度，0.0为完全透明，1.0为完全不透明。 | +| [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量，精度为float。 | +| [globalCompositeOperation](#globalcompositeoperation) | string | source-over | 设置合成操作的方式。类型字段可选值有source-over，source-atop，source-in，source-out，destination-over，destination-atop，destination-in，destination-out，lighter，copy，xor。具体请参考[表 类型字段说明](#globalcompositeoperation)。 | +| [shadowBlur](#shadowblur) | number | 0.0 | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。 | +| [shadowColor](#shadowcolor) | <color> | - | 设置绘制阴影时的阴影颜色。 | +| [shadowOffsetX](#shadowoffsetx) | number | - | 设置绘制阴影时和原有对象的水平偏移值。 | +| [shadowOffsetY](#shadowoffsety) | number | - | 设置绘制阴影时和原有对象的垂直偏移值。 | +| [imageSmoothingEnabled](#imagesmoothingenabled6)6+ | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | ### fillStyle @@ -379,19 +381,19 @@ export default { ### globalCompositeOperation - 类型字段说明 - | 值 | 描述 | - | -------- | -------- | - | source-over | 在现有绘制内容上显示新绘制内容，属于默认值。 | - | source-atop | 在现有绘制内容顶部显示新绘制内容。 | - | source-in | 在现有绘制内容中显示新绘制内容。 | - | source-out | 在现有绘制内容之外显示新绘制内容。 | - | destination-over | 在新绘制内容上方显示现有绘制内容。 | - | destination-atop | 在新绘制内容顶部显示现有绘制内容。 | - | destination-in | 在新绘制内容中显示现有绘制内容。 | - | destination-out | 在新绘制内容外显示现有绘制内容。 | - | lighter | 显示新绘制内容和现有绘制内容。 | - | copy | 显示新绘制内容而忽略现有绘制内容。 | - | xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | + | 值 | 描述 | + | ---------------- | ------------------------ | + | source-over | 在现有绘制内容上显示新绘制内容，属于默认值。 | + | source-atop | 在现有绘制内容顶部显示新绘制内容。 | + | source-in | 在现有绘制内容中显示新绘制内容。 | + | source-out | 在现有绘制内容之外显示新绘制内容。 | + | destination-over | 在新绘制内容上方显示现有绘制内容。 | + | destination-atop | 在新绘制内容顶部显示现有绘制内容。 | + | destination-in | 在新绘制内容中显示现有绘制内容。 | + | destination-out | 在新绘制内容外显示现有绘制内容。 | + | lighter | 显示新绘制内容和现有绘制内容。 | + | copy | 显示新绘制内容而忽略现有绘制内容。 | + | xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | - 示例 ``` @@ -568,12 +570,12 @@ fillRect(x: number, y: number, width:number, height: number): void 填充一个矩形。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定矩形左上角点的x坐标。 | - | y | number | 指定矩形左上角点的y坐标。 | - | width | number | 指定矩形的宽度。 | - | height | number | 指定矩形的高度。 | + | 参数 | 类型 | 描述 | + | ------ | ------ | ------------- | + | x | number | 指定矩形左上角点的x坐标。 | + | y | number | 指定矩形左上角点的y坐标。 | + | width | number | 指定矩形的宽度。 | + | height | number | 指定矩形的高度。 | - 示例 ``` @@ -603,12 +605,12 @@ clearRect(x: number, y: number, width:number, height: number): void 删除指定区域内的绘制内容。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定矩形上的左上角x坐标。 | - | y | number | 指定矩形上的左上角y坐标。 | - | width | number | 指定矩形的宽度。 | - | height | number | 指定矩形的高度。 | + | 参数 | 类型 | 描述 | + | ------ | ------ | ------------- | + | x | number | 指定矩形上的左上角x坐标。 | + | y | number | 指定矩形上的左上角y坐标。 | + | width | number | 指定矩形的宽度。 | + | height | number | 指定矩形的高度。 | - 示例 ``` @@ -641,12 +643,12 @@ strokeRect(x: number, y: number, width:number, height: number): void 绘制具有边框的矩形，矩形内部不填充。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定矩形的左上角x坐标。 | - | y | number | 指定矩形的左上角y坐标。 | - | width | number | 指定矩形的宽度。 | - | height | number | 指定矩形的高度。 | + | 参数 | 类型 | 描述 | + | ------ | ------ | ------------ | + | x | number | 指定矩形的左上角x坐标。 | + | y | number | 指定矩形的左上角y坐标。 | + | width | number | 指定矩形的宽度。 | + | height | number | 指定矩形的高度。 | - 示例 ``` @@ -677,11 +679,11 @@ fillText(text: string, x: number, y: number): void 绘制填充类文本。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | text | string | 需要绘制的文本内容。 | - | x | number | 需要绘制的文本的左下角x坐标。 | - | y | number | 需要绘制的文本的左下角y坐标。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | --------------- | + | text | string | 需要绘制的文本内容。 | + | x | number | 需要绘制的文本的左下角x坐标。 | + | y | number | 需要绘制的文本的左下角y坐标。 | - 示例 ``` @@ -712,11 +714,11 @@ strokeText(text: string, x: number, y: number): void 绘制描边类文本。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | text | string | 需要绘制的文本内容。 | - | x | number | 需要绘制的文本的左下角x坐标。 | - | y | number | 需要绘制的文本的左下角y坐标。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | --------------- | + | text | string | 需要绘制的文本内容。 | + | x | number | 需要绘制的文本的左下角x坐标。 | + | y | number | 需要绘制的文本的左下角y坐标。 | - 示例 ``` @@ -747,13 +749,13 @@ measureText(text: string): TextMetrics 该方法返回一个文本测算的对象，通过该对象可以获取指定文本的宽度值。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | + | 参数 | 类型 | 描述 | + | ---- | ------ | ---------- | | text | string | 需要进行测量的文本。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ----------- | -------------------------------------- | | TextMetrics | 包含指定字体的宽度，该宽度可以通过TextMetrics.width来获取。 | - 示例 @@ -850,10 +852,10 @@ moveTo(x: number, y: number): void 路径从当前点移动到指定点。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定位置的x坐标。 | - | y | number | 指定位置的y坐标。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | --------- | + | x | number | 指定位置的x坐标。 | + | y | number | 指定位置的y坐标。 | - 示例 ``` @@ -886,10 +888,10 @@ lineTo(x: number, y: number): void 从当前点到指定点进行路径连接。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定位置的x坐标。 | - | y | number | 指定位置的y坐标。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | --------- | + | x | number | 指定位置的x坐标。 | + | y | number | 指定位置的y坐标。 | - 示例 ``` @@ -954,14 +956,14 @@ createPattern(image: Image, repetition: string): Object 通过指定图像和重复方式创建图片填充的模板。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | image | Image | 图源对象，具体参考[Image对象](../arkui-js/js-components-canvas-image.md)。 | + | 参数 | 类型 | 描述 | + | ---------- | ------ | ---------------------------------------- | + | image | Image | 图源对象，具体参考[Image对象](../arkui-js/js-components-canvas-image.md)。 | | repetition | string | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ------ | ----------------- | | Object | 指定图像填充的Pattern对象。 | - 示例 @@ -996,14 +998,14 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | + | 参数 | 类型 | 描述 | + | ---- | ------ | -------------- | | cp1x | number | 第一个贝塞尔参数的x坐标值。 | | cp1y | number | 第一个贝塞尔参数的y坐标值。 | | cp2x | number | 第二个贝塞尔参数的x坐标值。 | | cp2y | number | 第二个贝塞尔参数的y坐标值。 | - | x | number | 路径结束时的x坐标值。 | - | y | number | 路径结束时的y坐标值。 | + | x | number | 路径结束时的x坐标值。 | + | y | number | 路径结束时的y坐标值。 | - 示例 ``` @@ -1036,12 +1038,12 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void 创建二次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | cpx | number | 贝塞尔参数的x坐标值。 | - | cpy | number | 贝塞尔参数的y坐标值。 | - | x | number | 路径结束时的x坐标值。 | - | y | number | 路径结束时的y坐标值。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | ----------- | + | cpx | number | 贝塞尔参数的x坐标值。 | + | cpy | number | 贝塞尔参数的y坐标值。 | + | x | number | 路径结束时的x坐标值。 | + | y | number | 路径结束时的y坐标值。 | - 示例 ``` @@ -1074,13 +1076,13 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 弧线圆心的x坐标值。 | - | y | number | 弧线圆心的y坐标值。 | - | radius | number | 弧线的圆半径。 | - | startAngle | number | 弧线的起始弧度。 | - | endAngle | number | 弧线的终止弧度。 | + | 参数 | 类型 | 描述 | + | ------------- | ------- | ---------- | + | x | number | 弧线圆心的x坐标值。 | + | y | number | 弧线圆心的y坐标值。 | + | radius | number | 弧线的圆半径。 | + | startAngle | number | 弧线的起始弧度。 | + | endAngle | number | 弧线的终止弧度。 | | anticlockwise | boolean | 是否逆时针绘制圆弧。 | - 示例 @@ -1113,13 +1115,13 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x1 | number | 圆弧经过的第一个点的x坐标值。 | - | y1 | number | 圆弧经过的第一个点的y坐标值。 | - | x2 | number | 圆弧经过的第二个点的x坐标值。 | - | y2 | number | 圆弧经过的第二个点的y坐标值。 | - | radius | number | 圆弧的圆半径值。 | + | 参数 | 类型 | 描述 | + | ------ | ------ | --------------- | + | x1 | number | 圆弧经过的第一个点的x坐标值。 | + | y1 | number | 圆弧经过的第一个点的y坐标值。 | + | x2 | number | 圆弧经过的第二个点的x坐标值。 | + | y2 | number | 圆弧经过的第二个点的y坐标值。 | + | radius | number | 圆弧的圆半径值。 | - 示例 ``` @@ -1151,15 +1153,15 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 椭圆圆心的x轴坐标。 | - | y | number | 椭圆圆心的y轴坐标。 | - | radiusX | number | 椭圆x轴的半径长度。 | - | radiusY | number | 椭圆y轴的半径长度。 | - | rotation | number | 椭圆的旋转角度，单位为弧度。 | - | startAngle | number | 椭圆绘制的起始点角度，以弧度表示。 | - | endAngle | number | 椭圆绘制的结束点角度，以弧度表示。 | + | 参数 | 类型 | 描述 | + | ------------- | ------ | ------------------------------------ | + | x | number | 椭圆圆心的x轴坐标。 | + | y | number | 椭圆圆心的y轴坐标。 | + | radiusX | number | 椭圆x轴的半径长度。 | + | radiusY | number | 椭圆y轴的半径长度。 | + | rotation | number | 椭圆的旋转角度，单位为弧度。 | + | startAngle | number | 椭圆绘制的起始点角度，以弧度表示。 | + | endAngle | number | 椭圆绘制的结束点角度，以弧度表示。 | | anticlockwise | number | 是否以逆时针方向绘制椭圆，0为顺时针，1为逆时针。(可选参数，默认为0) | - 示例 @@ -1192,12 +1194,12 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 指定矩形的左上角x坐标值。 | - | y | number | 指定矩形的左上角y坐标值。 | - | width | number | 指定矩形的宽度。 | - | height | number | 指定矩形的高度。 | + | 参数 | 类型 | 描述 | + | ------ | ------ | ------------- | + | x | number | 指定矩形的左上角x坐标值。 | + | y | number | 指定矩形的左上角y坐标值。 | + | width | number | 指定矩形的宽度。 | + | height | number | 指定矩形的高度。 | - 示例 ``` @@ -1288,8 +1290,8 @@ rotate(rotate: number): void 针对当前坐标轴进行顺时针旋转。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | + | 参数 | 类型 | 描述 | + | ------ | ------ | ---------------------------------------- | | rotate | number | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | - 示例 @@ -1321,10 +1323,10 @@ scale(x: number, y: number): void 设置canvas画布的缩放变换属性，后续的绘制操作将按照缩放比例进行缩放。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 设置水平方向的缩放值。 | - | y | number | 设置垂直方向的缩放值。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | ----------- | + | x | number | 设置水平方向的缩放值。 | + | y | number | 设置垂直方向的缩放值。 | - 示例 ``` @@ -1357,18 +1359,18 @@ transform方法对应一个变换矩阵，想对一个图形进行变化的时 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 变换后的坐标计算方式（x和y为变换前坐标，x'和y'为变换后坐标）： -> +> > - x' = scaleX \* x + skewY \* y + translateX -> +> > - y' = skewX \* x + scaleY \* y + translateY - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | scaleX | number | 指定水平缩放值。 | - | skewX | number | 指定水平倾斜值。 | - | skewY | number | 指定垂直倾斜值。 | - | scaleY | number | 指定垂直缩放值。 | + | 参数 | 类型 | 描述 | + | ---------- | ------ | -------- | + | scaleX | number | 指定水平缩放值。 | + | skewX | number | 指定水平倾斜值。 | + | skewY | number | 指定垂直倾斜值。 | + | scaleY | number | 指定垂直缩放值。 | | translateX | number | 指定水平移动值。 | | translateY | number | 指定垂直移动值。 | @@ -1407,12 +1409,12 @@ setTransform(scaleX: number, skewX: number, skewY: number, scale: number, transl setTransfrom方法使用的参数和transform()方法相同，但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | scaleX | number | 指定水平缩放值。 | - | skewX | number | 指定水平倾斜值。 | - | skewY | number | 指定垂直倾斜值。 | - | scaleY | number | 指定垂直缩放值。 | + | 参数 | 类型 | 描述 | + | ---------- | ------ | -------- | + | scaleX | number | 指定水平缩放值。 | + | skewX | number | 指定水平倾斜值。 | + | skewY | number | 指定垂直倾斜值。 | + | scaleY | number | 指定垂直缩放值。 | | translateX | number | 指定水平移动值。 | | translateY | number | 指定垂直移动值。 | @@ -1448,10 +1450,10 @@ translate(x: number, y: number): void 移动当前坐标系的原点。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x | number | 设置水平平移量。 | - | y | number | 设置竖直平移量。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | -------- | + | x | number | 设置水平平移量。 | + | y | number | 设置竖直平移量。 | - 示例 ``` @@ -1483,9 +1485,9 @@ createPath2D(path: Path2D, cmds: string): Path2D 创建一个Path2D对象。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | path | Path2D | Path2D对象。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | -------------- | + | path | Path2D | Path2D对象。 | | cmds | string | SVG的Path描述字符串。 | - 返回值 @@ -1528,17 +1530,17 @@ drawImage(image: Image, sx: number, sy: number, sWidth: number, sHeight: number, 进行图像绘制。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | image | Image | 图片资源，请参考[Image对象](../arkui-js/js-components-canvas-image.md)。 | - | sx | number | 裁切源图像时距离源图像左上角的x坐标值。 | - | sy | number | 裁切源图像时距离源图像左上角的y坐标值。 | - | sWidth | number | 裁切源图像时需要裁切的宽度。 | - | sHeight | number | 裁切源图像时需要裁切的高度。 | - | dx | number | 绘制区域左上角在x轴的位置。 | - | dy | number | 绘制区域左上角在y 轴的位置。 | - | dWidth | number | 绘制区域的宽度。 | - | dHeight | number | 绘制区域的高度。 | + | 参数 | 类型 | 描述 | + | ------- | ------ | ---------------------------------------- | + | image | Image | 图片资源，请参考[Image对象](../arkui-js/js-components-canvas-image.md)。 | + | sx | number | 裁切源图像时距离源图像左上角的x坐标值。 | + | sy | number | 裁切源图像时距离源图像左上角的y坐标值。 | + | sWidth | number | 裁切源图像时需要裁切的宽度。 | + | sHeight | number | 裁切源图像时需要裁切的高度。 | + | dx | number | 绘制区域左上角在x轴的位置。 | + | dy | number | 绘制区域左上角在y 轴的位置。 | + | dWidth | number | 绘制区域的宽度。 | + | dHeight | number | 绘制区域的高度。 | - 示例 ``` @@ -1620,16 +1622,16 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): Object 创建一个线性渐变色，返回CanvasGradient对象，请参考[CanvasGradient对象](../arkui-js/js-components-canvas-canvasgradient.md)。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x0 | number | 起点的x轴坐标。 | - | y0 | number | 起点的y轴坐标。 | - | x1 | number | 终点的x轴坐标。 | - | y1 | number | 终点的y轴坐标。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | -------- | + | x0 | number | 起点的x轴坐标。 | + | y0 | number | 起点的y轴坐标。 | + | x1 | number | 终点的x轴坐标。 | + | y1 | number | 终点的y轴坐标。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ------ | ---------------------- | | Object | 返回创建的CanvasGradient对象。 | - 示例 @@ -1669,18 +1671,18 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, 创建一个径向渐变色，返回CanvasGradient对象，请参考CanvasGradient - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | x0 | number | 起始圆的x轴坐标。 | - | y0 | number | 起始圆的y轴坐标。 | - | r0 | number | 起始圆的半径。必须是非负且有限的。 | - | x1 | number | 终点圆的x轴坐标。 | - | y1 | number | 终点圆的y轴坐标。 | - | r1 | number | 终点圆的半径。必须为非负且有限的。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | ----------------- | + | x0 | number | 起始圆的x轴坐标。 | + | y0 | number | 起始圆的y轴坐标。 | + | r0 | number | 起始圆的半径。必须是非负且有限的。 | + | x1 | number | 终点圆的x轴坐标。 | + | y1 | number | 终点圆的y轴坐标。 | + | r1 | number | 终点圆的半径。必须为非负且有限的。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ------ | ---------------------- | | Object | 返回创建的CanvasGradient对象。 | - 示例 @@ -1720,15 +1722,15 @@ createImageData(width: number, height: number, imageData: Object): Object 创建新的ImageData 对象，请参考[ImageData对象](../arkui-js/js-components-canvas-imagedata.md)。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | width | number | ImageData的宽度。 | - | height | number | ImageData的高度。 | + | 参数 | 类型 | 描述 | + | --------- | ------ | ----------------- | + | width | number | ImageData的宽度。 | + | height | number | ImageData的高度。 | | imagedata | Object | 复制现有的ImageData对象。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ------ | ----------------- | | Object | 返回创建的ImageData对象。 | - 示例 @@ -1758,16 +1760,16 @@ getImageData(sx: number, sy: number, sw: number, sh: number): Object 以当前canvas指定区域内的像素创建ImageData对象。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | sx | number | 需要输出的区域的左上角x坐标。 | - | sy | number | 需要输出的区域的左上角y坐标。 | - | sw | number | 需要输出的区域的宽度。 | - | sh | number | 需要输出的区域的高度。 | + | 参数 | 类型 | 描述 | + | ---- | ------ | --------------- | + | sx | number | 需要输出的区域的左上角x坐标。 | + | sy | number | 需要输出的区域的左上角y坐标。 | + | sw | number | 需要输出的区域的宽度。 | + | sh | number | 需要输出的区域的高度。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ------ | ----------------------- | | Object | 返回包含指定区域像素的ImageData对象。 | - 示例 @@ -1796,15 +1798,15 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX: number, dirtyY: 使用ImageData数据填充新的矩形区域。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | - | imagedata | Object | 包含像素值的ImageData对象。 | - | dx | number | 填充区域在x轴方向的偏移量。 | - | dy | number | 填充区域在y轴方向的偏移量。 | - | dirtyX | number | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | - | dirtyY | number | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | - | dirtyWidth | number | 源图像数据矩形裁切范围的宽度。 | - | dirtyHeight | number | 源图像数据矩形裁切范围的高度。 | + | 参数 | 类型 | 描述 | + | ----------- | ------ | ----------------------------- | + | imagedata | Object | 包含像素值的ImageData对象。 | + | dx | number | 填充区域在x轴方向的偏移量。 | + | dy | number | 填充区域在y轴方向的偏移量。 | + | dirtyX | number | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | + | dirtyY | number | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | + | dirtyWidth | number | 源图像数据矩形裁切范围的宽度。 | + | dirtyHeight | number | 源图像数据矩形裁切范围的高度。 | - 示例 ``` @@ -1841,8 +1843,8 @@ setLineDash(segments: Array): void 设置画布的虚线样式。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | + | 参数 | 类型 | 描述 | + | -------- | ----- | -------------------- | | segments | Array | 作为数组用来描述线段如何交替和间距长度。 | - 示例 @@ -1875,8 +1877,8 @@ getLineDash(): Array 获得当前画布的虚线样式。 - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ----- | ------------------------ | | Array | 返回数组，该数组用来描述线段如何交替和间距长度。 | - 示例 @@ -1905,8 +1907,8 @@ transferFromImageBitmap(bitmap: ImageBitmap): void 显示给定的ImageBitmap对象。 - 参数 - | 参数 | 类型 | 描述 | - | -------- | -------- | -------- | + | 参数 | 类型 | 描述 | + | ------ | ----------- | ------------------ | | bitmap | ImageBitmap | 待显示的ImageBitmap对象。 | - 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md index 68fa3939ca5c3a0d209c7ecf5c05dfe843af52c7..3512ec2398486322dbfd4bcdf374e8ffa9098342 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md @@ -12,11 +12,11 @@ ## 导入模块 ``` -import lottie from 'lottie-ohos-ets' +import lottie from '@ohos/lottieETS' ``` > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 在Terminal窗口使用 npm install 'lottie-ohos-ets'命令下载Lottie。 +> 在Terminal窗口使用 `npm install @ohos/lottieETS` 命令下载Lottie。 ## lottie.loadAnimation diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md index 7a2decde903a27a4cea908c2a7a75c5d5c6b1239..85036c9033d6101d1dee5d083cb929d39eb36d79 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md @@ -1,4 +1,4 @@ -# OffscreenCanvasRenderingConxt2D对象 +# OffscreenCanvasRenderingContext2D对象 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 从 API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,35 +12,35 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, setting: RenderingContextSettings) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | number | 是 | - | 离屏画布的宽度 | - | height | number | 是 | - | 离屏画布的高度 | - | setting | [RenderingContextSettings](ts-canvasrenderingcontext2d#renderingcontextsettings) | 是 | - | 见RenderingContextSettings接口描述。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ------- | ---------------------------------------- | ---- | ---- | ------------------------------ | + | width | number | 是 | - | 离屏画布的宽度 | + | height | number | 是 | - | 离屏画布的高度 | + | setting | [RenderingContextSettings](ts-canvasrenderingcontext2d.md#renderingcontextsettings) | 是 | - | 见RenderingContextSettings接口描述。 | ## 属性 -| 名称 | 类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| [fillStyle](#fillstyle) | <color> \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | - | 指定绘制的填充色。
- 类型为<color>时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 [createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | -| [lineWidth](#linewidth) | number | - | 设置绘制线条的宽度。 | -| [strokeStyle](#strokestyle) | <color> \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | - | 设置描边的颜色。
- 类型为<color>时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | -| [lineCap](#linecap) | string | 'butt' | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。 | -| [lineJoin](#linejoin) | string | 'miter' | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。 | -| [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。 | -| [font](#font) | string | 'normal normal 14px sans-serif' | 设置文本绘制中的字体样式。
语法：ctx.font='font-size font-family'
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列。
语法：ctx.font='font-style font-weight font-size font-family'
- font-style(可选)，用于指定字体样式，支持如下几种样式：'normal', 'italic'。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。 | -| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ltr布局模式下start和left一致，rtl布局模式下start和right一致·。 | -| [textBaseline](#textbaseline) | string | 'alphabetic' | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic 基线不需要考虑下行字母。 | -| [globalAlpha](#globalalpha) | number | - | 设置透明度，0.0为完全透明，1.0为完全不透明。 | -| [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量，精度为float。 | -| [globalCompositeOperation](#globalcompositeoperation) | string | 'source-over' | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。 | -| [shadowBlur](#shadowblur) | number | 0.0 | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。 | -| [shadowColor](#shadowcolor) | <color> | - | 设置绘制阴影时的阴影颜色。 | -| [shadowOffsetX](#shadowoffsetx) | number | - | 设置绘制阴影时和原有对象的水平偏移值。 | -| [shadowOffsetY](#shadowoffsety) | number | - | 设置绘制阴影时和原有对象的垂直偏移值。 | -| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | -| imageSmoothingQuality | string | 'low' | 用于设置图像平滑度，支持如下三种类型：'low', 'medium', 'high'。 | +| 名称 | 类型 | 默认值 | 描述 | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| [fillStyle](#fillstyle) | <color> \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | - | 指定绘制的填充色。
- 类型为<color>时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用 [createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | +| [lineWidth](#linewidth) | number | - | 设置绘制线条的宽度。 | +| [strokeStyle](#strokestyle) | <color> \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | - | 设置描边的颜色。
- 类型为<color>时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | +| [lineCap](#linecap) | string | 'butt' | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。 | +| [lineJoin](#linejoin) | string | 'miter' | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。 | +| [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。 | +| [font](#font) | string | 'normal normal 14px sans-serif' | 设置文本绘制中的字体样式。
语法：ctx.font='font-size font-family'
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列。
语法：ctx.font='font-style font-weight font-size font-family'
- font-style(可选)，用于指定字体样式，支持如下几种样式：'normal', 'italic'。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。 | +| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ltr布局模式下start和left一致，rtl布局模式下start和right一致·。 | +| [textBaseline](#textbaseline) | string | 'alphabetic' | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic 基线不需要考虑下行字母。 | +| [globalAlpha](#globalalpha) | number | - | 设置透明度，0.0为完全透明，1.0为完全不透明。 | +| [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量，精度为float。 | +| [globalCompositeOperation](#globalcompositeoperation) | string | 'source-over' | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。 | +| [shadowBlur](#shadowblur) | number | 0.0 | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。 | +| [shadowColor](#shadowcolor) | <color> | - | 设置绘制阴影时的阴影颜色。 | +| [shadowOffsetX](#shadowoffsetx) | number | - | 设置绘制阴影时和原有对象的水平偏移值。 | +| [shadowOffsetY](#shadowoffsety) | number | - | 设置绘制阴影时和原有对象的垂直偏移值。 | +| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | +| imageSmoothingQuality | string | 'low' | 用于设置图像平滑度，支持如下三种类型：'low', 'medium', 'high'。 | > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > <color>类型格式为 'rgb(255, 255, 255)'，'rgba(255, 255, 255, 1.0)'，'\#FFFFFF'。 @@ -450,19 +450,19 @@ struct LineDashOffset { ### globalCompositeOperation -| 名称 | 描述 | -| -------- | -------- | -| source-over | 在现有绘制内容上显示新绘制内容，属于默认值。 | -| source-atop | 在现有绘制内容顶部显示新绘制内容。 | -| source-in | 在现有绘制内容中显示新绘制内容。 | -| source-out | 在现有绘制内容之外显示新绘制内容。 | -| destination-over | 在新绘制内容上方显示现有绘制内容。 | -| destination-atop | 在新绘制内容顶部显示现有绘制内容。 | -| destination-in | 在新绘制内容中显示现有绘制内容。 | -| destination-out | 在新绘制内容外显示现有绘制内容。 | -| lighter | 显示新绘制内容和现有绘制内容。 | -| copy | 显示新绘制内容而忽略现有绘制内容。 | -| xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | +| 名称 | 描述 | +| ---------------- | ------------------------ | +| source-over | 在现有绘制内容上显示新绘制内容，属于默认值。 | +| source-atop | 在现有绘制内容顶部显示新绘制内容。 | +| source-in | 在现有绘制内容中显示新绘制内容。 | +| source-out | 在现有绘制内容之外显示新绘制内容。 | +| destination-over | 在新绘制内容上方显示现有绘制内容。 | +| destination-atop | 在新绘制内容顶部显示现有绘制内容。 | +| destination-in | 在新绘制内容中显示现有绘制内容。 | +| destination-out | 在新绘制内容外显示现有绘制内容。 | +| lighter | 显示新绘制内容和现有绘制内容。 | +| copy | 显示新绘制内容而忽略现有绘制内容。 | +| xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | ``` @Entry @@ -684,12 +684,12 @@ fillRect(x: number, y: number, w: number, h: number): void 填充一个矩形。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | - | y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ------ | ------ | ---- | ---- | ------------- | + | x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | + | y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | + | width | number | 是 | 0 | 指定矩形的宽度。 | + | height | number | 是 | 0 | 指定矩形的高度。 | - 示例 ``` @@ -728,12 +728,12 @@ strokeRect(x: number, y: number, w: number, h: number): void 绘制具有边框的矩形，矩形内部不填充。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定矩形的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ------ | ------ | ---- | ---- | ------------ | + | x | number | 是 | 0 | 指定矩形的左上角x坐标。 | + | y | number | 是 | 0 | 指定矩形的左上角y坐标。 | + | width | number | 是 | 0 | 指定矩形的宽度。 | + | height | number | 是 | 0 | 指定矩形的高度。 | - 示例 ``` @@ -771,12 +771,12 @@ clearRect(x: number, y: number, w: number, h: number): void 删除指定区域内的绘制内容。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | ------------- | + | x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | + | y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | + | width | number | 是 | 0 | 指定矩形的宽度。 | + | height | number | 是 | 0 | 指定矩形的高度。 | - 示例 ``` @@ -816,11 +816,11 @@ fillText(text: string, x: number, y: number): void 绘制填充类文本。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ---- | ------ | ---- | ---- | --------------- | + | text | string | 是 | “” | 需要绘制的文本内容。 | + | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | + | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | - 示例 ``` @@ -859,11 +859,11 @@ strokeText(text: string, x: number, y: number): void 绘制描边类文本。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | --------------- | + | text | string | 是 | “” | 需要绘制的文本内容。 | + | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | + | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | - 示例 ``` @@ -902,19 +902,19 @@ measureText(text: string): TextMetrics 该方法返回一个文本测算的对象，通过该对象可以获取指定文本的宽度值。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | text | string | 是 | "" | 需要进行测量的文本。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ---- | ------ | ---- | ---- | ---------- | + | text | string | 是 | "" | 需要进行测量的文本。 | - 返回值 - | 类型 | 说明 | - | -------- | -------- | + | 类型 | 说明 | + | ----------- | ------- | | TextMetrics | 文本的尺寸信息 | - TextMetrics类型描述 - | 属性 | 类型 | 描述 | - | -------- | -------- | -------- | - | width | number | 字符串的宽度。 | + | 属性 | 类型 | 描述 | + | ----- | ------ | ------- | + | width | number | 字符串的宽度。 | - 示例 ``` @@ -954,9 +954,9 @@ stroke(path?: Path2D): void 进行边框绘制操作。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ---------------------------------------- | ---- | ---- | ------------ | + | path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | - 示例 ``` @@ -1037,10 +1037,10 @@ moveTo(x: number, y: number): void 路径从当前点移动到指定点。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ---- | ------ | ---- | ---- | --------- | + | x | number | 是 | 0 | 指定位置的x坐标。 | + | y | number | 是 | 0 | 指定位置的y坐标。 | - 示例 ``` @@ -1081,10 +1081,10 @@ lineTo(x: number, y: number): void 从当前点到指定点进行路径连接。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | --------- | + | x | number | 是 | 0 | 指定位置的x坐标。 | + | y | number | 是 | 0 | 指定位置的y坐标。 | - 示例 ``` @@ -1165,10 +1165,10 @@ createPattern(image: ImageBitmap, repetition: string): CanvasPattern 通过指定图像和重复方式创建图片填充的模板。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象，具体参考ImageBitmap对象。 | - | repetition | string | 是 | “” | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | + | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象，具体参考ImageBitmap对象。 | + | repetition | string | 是 | “” | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | - 示例 ``` @@ -1209,14 +1209,14 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | - | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | - | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | - | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | -------------- | + | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | + | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | + | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | + | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | + | x | number | 是 | 0 | 路径结束时的x坐标值。 | + | y | number | 是 | 0 | 路径结束时的y坐标值。 | - 示例 ``` @@ -1257,12 +1257,12 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void 创建二次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | - | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ----------- | + | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | + | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | + | x | number | 是 | 0 | 路径结束时的x坐标值。 | + | y | number | 是 | 0 | 路径结束时的y坐标值。 | - 示例 ``` @@ -1303,14 +1303,14 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 弧线圆心的x坐标值。 | - | y | number | 是 | 0 | 弧线圆心的y坐标值。 | - | radius | number | 是 | 0 | 弧线的圆半径。 | - | startAngle | number | 是 | 0 | 弧线的起始弧度。 | - | endAngle | number | 是 | 0 | 弧线的终止弧度。 | - | anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------------- | ------- | ---- | ----- | ---------- | + | x | number | 是 | 0 | 弧线圆心的x坐标值。 | + | y | number | 是 | 0 | 弧线圆心的y坐标值。 | + | radius | number | 是 | 0 | 弧线的圆半径。 | + | startAngle | number | 是 | 0 | 弧线的起始弧度。 | + | endAngle | number | 是 | 0 | 弧线的终止弧度。 | + | anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | - 示例 ``` @@ -1350,13 +1350,13 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | - | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | - | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | - | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | - | radius | number | 是 | 0 | 圆弧的圆半径值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | --------------- | + | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | + | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | + | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | + | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | + | radius | number | 是 | 0 | 圆弧的圆半径值。 | - 示例 ``` @@ -1396,16 +1396,16 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | - | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | - | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | - | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | - | rotation | number | 是 | 0 | 椭圆的旋转角度，单位为弧度。 | - | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度，以弧度表示。 | - | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度，以弧度表示。 | - | anticlockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | + | 参数 | 类型 | 必填 | 默认值 | 说明 | + | ------------- | ------- | ---- | ----- | ----------------- | + | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | + | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | + | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | + | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | + | rotation | number | 是 | 0 | 椭圆的旋转角度，单位为弧度。 | + | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度，以弧度表示。 | + | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度，以弧度表示。 | + | anticlockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | - 示例 @@ -1446,12 +1446,12 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | ------------- | + | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | + | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | + | width | number | 是 | 0 | 指定矩形的宽度。 | + | height | number | 是 | 0 | 指定矩形的高度。 | - 示例 ``` @@ -1565,9 +1565,9 @@ rotate(rotate: number): void 针对当前坐标轴进行顺时针旋转。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | rotate | number | 是 | 0 | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | ---------------------------------------- | + | rotate | number | 是 | 0 | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | - 示例 ``` @@ -1606,10 +1606,10 @@ scale(x: number, y: number): void 设置canvas画布的缩放变换属性，后续的绘制操作将按照缩放比例进行缩放。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 设置水平方向的缩放值。 | - | y | number | 是 | 0 | 设置垂直方向的缩放值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ----------- | + | x | number | 是 | 0 | 设置水平方向的缩放值。 | + | y | number | 是 | 0 | 设置垂直方向的缩放值。 | - 示例 ``` @@ -1650,20 +1650,20 @@ transform方法对应一个变换矩阵，想对一个图形进行变化的时 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 变换后的坐标计算方式（x和y为变换前坐标，x'和y'为变换后坐标）： -> +> > - x' = scaleX \* x + skewY \* y + translateX -> +> > - y' = skewX \* x + scaleY \* y + translateY - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | scaleX | number | 是 | 0 | 指定水平缩放值。 | - | skewX | number | 是 | 0 | 指定水平倾斜值。 | - | skewY | number | 是 | 0 | 指定垂直倾斜值。 | - | scaleY | number | 是 | 0 | 指定垂直缩放值。 | - | translateX | number | 是 | 0 | 指定水平移动值。 | - | translateY | number | 是 | 0 | 指定垂直移动值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---------- | ------ | ---- | ---- | -------- | + | scaleX | number | 是 | 0 | 指定水平缩放值。 | + | skewX | number | 是 | 0 | 指定水平倾斜值。 | + | skewY | number | 是 | 0 | 指定垂直倾斜值。 | + | scaleY | number | 是 | 0 | 指定垂直缩放值。 | + | translateX | number | 是 | 0 | 指定水平移动值。 | + | translateY | number | 是 | 0 | 指定垂直移动值。 | - 示例 ``` @@ -1708,14 +1708,14 @@ setTransform(scaleX: number, skewX: number, skewY: number, scale: number, transl setTransfrom方法使用的参数和transform()方法相同，但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | scaleX | number | 是 | 0 | 指定水平缩放值。 | - | skewX | number | 是 | 0 | 指定水平倾斜值。 | - | skewY | number | 是 | 0 | 指定垂直倾斜值。 | - | scaleY | number | 是 | 0 | 指定垂直缩放值。 | - | translateX | number | 是 | 0 | 指定水平移动值。 | - | translateY | number | 是 | 0 | 指定垂直移动值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---------- | ------ | ---- | ---- | -------- | + | scaleX | number | 是 | 0 | 指定水平缩放值。 | + | skewX | number | 是 | 0 | 指定水平倾斜值。 | + | skewY | number | 是 | 0 | 指定垂直倾斜值。 | + | scaleY | number | 是 | 0 | 指定垂直缩放值。 | + | translateX | number | 是 | 0 | 指定水平移动值。 | + | translateY | number | 是 | 0 | 指定垂直移动值。 | - 示例 ``` @@ -1757,10 +1757,10 @@ translate(x: number, y: number): void 移动当前坐标系的原点。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 设置水平平移量。 | - | y | number | 是 | 0 | 设置竖直平移量。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | -------- | + | x | number | 是 | 0 | 设置水平平移量。 | + | y | number | 是 | 0 | 设置竖直平移量。 | - 示例 ``` @@ -1804,17 +1804,17 @@ drawImage(image: ImageBitmap, sx: number, sy: number, sWidth: number, sHeight: n 进行图像绘制。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图片资源，请参考ImageBitmap。 | - | sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | - | sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | - | sWidth | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | - | sHeight | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | - | dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | - | dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | - | dWidth | number | 否 | 0 | 绘制区域的宽度。 | - | dHeight | number | 否 | 0 | 绘制区域的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------- | ---------------------------------------- | ---- | ---- | -------------------- | + | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图片资源，请参考ImageBitmap。 | + | sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | + | sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | + | sWidth | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | + | sHeight | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | + | dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | + | dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | + | dWidth | number | 否 | 0 | 绘制区域的宽度。 | + | dHeight | number | 否 | 0 | 绘制区域的高度。 | - 示例 @@ -1854,10 +1854,10 @@ createImageData(width: number, height: number): Object 根据宽高创建ImageData对象，请参考[ImageData](ts-components-canvas-imagebitmap.md)。 - 参数 - | 参数 | 类型 | 必填 | 默认 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | number | 是 | 0 | ImageData的宽度。 | - | height | number | 是 | 0 | ImageData的高度。 | + | 参数 | 类型 | 必填 | 默认 | 描述 | + | ------ | ------ | ---- | ---- | ------------- | + | width | number | 是 | 0 | ImageData的宽度。 | + | height | number | 是 | 0 | ImageData的高度。 | ### createImageData @@ -1867,9 +1867,9 @@ createImageData(imageData: ImageData): Object 根据已创建的ImageData对象创建新的ImageData对象，请参考[ImageData](ts-components-canvas-imagebitmap.md)。 - 参数 - | 参数 | 类型 | 必填 | 默认 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | imagedata | [ImageData](ts-components-canvas-imagebitmap.md) | 是 | null | 被复制的ImageData对象。 | + | 参数 | 类型 | 必填 | 默认 | 描述 | + | --------- | ---------------------------------------- | ---- | ---- | ---------------- | + | imagedata | [ImageData](ts-components-canvas-imagebitmap.md) | 是 | null | 被复制的ImageData对象。 | ### getImageData @@ -1879,12 +1879,12 @@ getImageData(sx: number, sy: number, sw: number, sh: number): Object 以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagebitmap.md)对象。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | - | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | - | sw | number | 是 | 0 | 需要输出的区域的宽度。 | - | sh | number | 是 | 0 | 需要输出的区域的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | --------------- | + | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | + | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | + | sw | number | 是 | 0 | 需要输出的区域的宽度。 | + | sh | number | 是 | 0 | 需要输出的区域的高度。 | ### putImageData @@ -1894,15 +1894,15 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX?: number, dirtyY? 使用[ImageData](ts-components-canvas-imagebitmap.md)数据填充新的矩形区域。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | - | dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | - | dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | - | dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | - | dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | - | dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | - | dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ----------- | ------ | ---- | ------------ | ----------------------------- | + | imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | + | dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | + | dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | + | dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | + | dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | + | dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | + | dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | - 示例 ``` @@ -2013,12 +2013,12 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void 创建一个线性渐变色。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x0 | number | 是 | 0 | 起点的x轴坐标。 | - | y0 | number | 是 | 0 | 起点的y轴坐标。 | - | x1 | number | 是 | 0 | 终点的x轴坐标。 | - | y1 | number | 是 | 0 | 终点的y轴坐标。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | -------- | + | x0 | number | 是 | 0 | 起点的x轴坐标。 | + | y0 | number | 是 | 0 | 起点的y轴坐标。 | + | x1 | number | 是 | 0 | 终点的x轴坐标。 | + | y1 | number | 是 | 0 | 终点的y轴坐标。 | - 示例 ``` @@ -2062,14 +2062,14 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, 创建一个径向渐变色。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x0 | number | 是 | 0 | 起始圆的x轴坐标。 | - | y0 | number | 是 | 0 | 起始圆的y轴坐标。 | - | r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | - | x1 | number | 是 | 0 | 终点圆的x轴坐标。 | - | y1 | number | 是 | 0 | 终点圆的y轴坐标。 | - | r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ----------------- | + | x0 | number | 是 | 0 | 起始圆的x轴坐标。 | + | y0 | number | 是 | 0 | 起始圆的y轴坐标。 | + | r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | + | x1 | number | 是 | 0 | 终点圆的x轴坐标。 | + | y1 | number | 是 | 0 | 终点圆的y轴坐标。 | + | r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | - 示例 ``` diff --git a/zh-cn/application-dev/ui/ui-ts-basic-components-button.md b/zh-cn/application-dev/ui/ui-ts-basic-components-button.md index 1a1f300b7e5f7ae21a6339dca555944611321f4e..7c2c54b35ac29ab1cce06183e0c6ec8a4d59a031 100644 --- a/zh-cn/application-dev/ui/ui-ts-basic-components-button.md +++ b/zh-cn/application-dev/ui/ui-ts-basic-components-button.md @@ -8,10 +8,11 @@ Button是按钮组件，通常用于响应用户的点击操作，如提交表 Button通过调用接口来创建，接口调用有以下两种形式： -- Button(options?: {type?: ButtonType, stateEffect?: boolean}) - 该接口用于创建包含子组件的按钮，其中type用于设置Button类型，stateEffect属性设置Button是否开启点击效果。 +- 创建包含子组件的按钮 + + `Button(options?: {type?: ButtonType, stateEffect?: boolean})`，该接口用于创建包含子组件的按钮，其中type用于设置Button类型，stateEffect属性设置Button是否开启点击效果。 + - ``` Button({ type: ButtonType.Normal, stateEffect: true }) { Row() { @@ -23,10 +24,11 @@ Button通过调用接口来创建，接口调用有以下两种形式： ![zh-cn_image_0000001260555857](figures/zh-cn_image_0000001260555857.png) -- Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean }) - 该接口用于创建不包含子组件的按钮，其中label确定所创建的Button是否包含子组件。 +- 创建不包含子组件的按钮 + + `Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean })`，该接口用于创建不包含子组件的按钮，其中label确定所创建的Button是否包含子组件。 + - ``` Button('Ok', { type: ButtonType.Normal, stateEffect: true }) .borderRadius(8) @@ -42,7 +44,7 @@ Button通过调用接口来创建，接口调用有以下两种形式： Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆形按钮）和Normal（普通按钮），通过type进行设置。 - 胶囊按钮（默认类型） - + ``` Button('Disable', { type: ButtonType.Capsule, stateEffect: false }) .backgroundColor(0x317aff) @@ -52,7 +54,7 @@ Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆 ![zh-cn_image_0000001215645452](figures/zh-cn_image_0000001215645452.png) - 圆形按钮 - + ``` Button('Circle', { type: ButtonType.Circle, stateEffect: false }) .backgroundColor(0x317aff) @@ -68,7 +70,7 @@ Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆 - 设置边框弧度 一般使用通用属性来自定义按钮样式。例如通过borderRadius属性设置按钮的边框弧度。 - + ``` Button('circle border', { type: ButtonType.Normal }) .borderRadius(20) @@ -79,7 +81,7 @@ Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆 - 设置文本样式 通过添加文本样式设置按钮文本的展示样式。 - + ``` Button('font style', { type: ButtonType.Normal }) .fontSize(20) @@ -92,7 +94,7 @@ Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆 - 设置背景颜色 添加backgroundColor属性设置按钮的背景颜色。 - + ``` Button('background color').backgroundColor(0xF55A42) ``` @@ -102,7 +104,7 @@ Button有三种可选类型，分别为Capsule（胶囊类型）、Circle（圆 - 用作功能型按钮 为删除操作创建一个按钮。 - + ``` Button({ type: ButtonType.Circle, stateEffect: true }) { Image($r('app.media.ic_public_delete_filled')).width(30).height(30) @@ -133,7 +135,7 @@ Button('Ok', { type: ButtonType.Normal, stateEffect: true }) ``` import router from '@ohos.router' - + @Entry @Component struct ButtonCase1 { @@ -144,13 +146,13 @@ Button('Ok', { type: ButtonType.Normal, stateEffect: true }) router.push({ url: 'xxx' }) }) } - + ListItem() { Button("Second").onClick(() => { router.push({ url: 'yyy' }) }) } - + ListItem() { Button("Third").onClick(() => { router.push({ url: 'zzz' }) @@ -170,7 +172,7 @@ Button('Ok', { type: ButtonType.Normal, stateEffect: true }) - 用于表单的提交 在用户登录/注册页面，用户的登录或注册的提交操作会用按钮。 - + ``` @Entry @Component @@ -184,5 +186,5 @@ Button('Ok', { type: ButtonType.Normal, stateEffect: true }) } } ``` - + ![zh-cn_image_0000001190466492](figures/zh-cn_image_0000001190466492.png) diff --git a/zh-cn/application-dev/ui/ui-ts-layout-flex.md b/zh-cn/application-dev/ui/ui-ts-layout-flex.md index 53e82213fe20b937a904704a42f0941f0c3bba12..17911df5d9ef67a6fec7477aa57833a476bfa07a 100644 --- a/zh-cn/application-dev/ui/ui-ts-layout-flex.md +++ b/zh-cn/application-dev/ui/ui-ts-layout-flex.md @@ -8,7 +8,7 @@ Flex组件用于创建弹性布局，开发者可以通过Flex的接口创建容 接口的调用形式如下： -Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: FlexAlign, alignItems?: ItemAlign, alignContent?: FlexAlign }) +`Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: FlexAlign, alignItems?: ItemAlign, alignContent?: FlexAlign })` 通过参数direction定义弹性布局的布局方向，justifyContent定义弹性布局方向上的子组件对齐方式， alignContent定义与布局方向垂直的方向上的子组件对齐方式，wrap定义内容超过一行时是否换行。 ## 弹性布局方向 @@ -16,7 +16,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F 弹性布局有两个方向，子组件放置的方向是主轴，与主轴垂直的方向是交叉轴。通过direction参数设置容器主轴的方向，可选值有： - FlexDirection.Row（默认值）：主轴为水平方向，子组件从起始端沿着水平方向开始排布。 - + ``` Flex({ direction: FlexDirection.Row }) { Text('1').width('33%').height(50).backgroundColor(0xF5DEB3) @@ -32,7 +32,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218579606](figures/zh-cn_image_0000001218579606.png) - FlexDirection.RowReverse：主轴为水平方向，子组件从终点端沿着FlexDirection.Row相反的方向开始排布。 - + ``` Flex({ direction: FlexDirection.RowReverse }) { Text('1').width('33%').height(50).backgroundColor(0xF5DEB3) @@ -48,7 +48,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218739566](figures/zh-cn_image_0000001218739566.png) - FlexDirection.Column：主轴为垂直方向，子组件从起始端沿着垂直方向开始排布。 - + ``` Flex({ direction: FlexDirection.Column }) { Text('1').width('100%').height(50).backgroundColor(0xF5DEB3) @@ -64,7 +64,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001263019457](figures/zh-cn_image_0000001263019457.png) - FlexDirection.ColumnReverse：主轴为垂直方向，子组件从终点端沿着FlexDirection.Column相反的方向开始排布。 - + ``` Flex({ direction: FlexDirection.ColumnReverse }) { Text('1').width('100%').height(50).backgroundColor(0xF5DEB3) @@ -85,7 +85,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F 默认情况下，子组件在Flex容器中都排在一条线（又称"轴线"）上。通过wrap参数设置其他换行方式，可选值有： - FlexWrap.NoWrap : 不换行。如果子元素的宽度总和大于父元素的宽度，则子元素会被压缩宽度。 - + ``` Flex({ wrap: FlexWrap.NoWrap }) { Text('1').width('50%').height(50).backgroundColor(0xF5DEB3) @@ -100,7 +100,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001263139409](figures/zh-cn_image_0000001263139409.png) - FlexWrap.Wrap：换行。 - + ``` Flex({ wrap: FlexWrap.Wrap }) { Text('1').width('50%').height(50).backgroundColor(0xF5DEB3) @@ -115,7 +115,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218419614](figures/zh-cn_image_0000001218419614.png) - FlexWrap.WrapReverse：换行，且与行排列方向相反。 - + ``` Flex({ wrap: FlexWrap.WrapReverse}) { Text('1').width('50%').height(50).backgroundColor(0xF5DEB3) @@ -138,7 +138,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F 可以通过justifyContent参数设置在主轴的对齐方式，可选值有： - FlexAlign.Start: 元素在主轴方向首端对齐, 第一个元素与行首对齐，同时后续的元素与前一个对齐。 - + ``` Flex({ justifyContent: FlexAlign.Start }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -153,7 +153,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218259634](figures/zh-cn_image_0000001218259634.png) - FlexAlign.Center: 元素在主轴方向中心对齐，第一个元素与行首的距离与最后一个元素与行尾距离相同。 - + ``` Flex({ justifyContent: FlexAlign.Center }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -168,7 +168,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218579608](figures/zh-cn_image_0000001218579608.png) - FlexAlign.End: 元素在主轴方向尾部对齐, 最后一个元素与行尾对齐，其他元素与后一个对齐。 - + ``` Flex({ justifyContent: FlexAlign.End }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -183,7 +183,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218739568](figures/zh-cn_image_0000001218739568.png) - FlexAlign. SpaceBetween: ，Flex主轴方向均匀分配弹性元素，相邻元素之间距离相同。 第一个元素与行首对齐，最后一个元素与行尾对齐。 - + ``` Flex({ justifyContent: FlexAlign.SpaceBetween }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -198,7 +198,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001263019461](figures/zh-cn_image_0000001263019461.png) - FlexAlign. SpaceAround: Flex主轴方向均匀分配弹性元素，相邻元素之间距离相同。 第一个元素到行首的距离和最后一个元素到行尾的距离是相邻元素之间距离的一半。 - + ``` Flex({ justifyContent: FlexAlign.SpaceAround }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -213,7 +213,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001263339461](figures/zh-cn_image_0000001263339461.png) - FlexAlign. SpaceEvenly: Flex主轴方向元素等间距布局， 相邻元素之间的间距、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 - + ``` Flex({ justifyContent: FlexAlign.SpaceEvenly }) { Text('1').width('20%').height(50).backgroundColor(0xF5DEB3) @@ -233,7 +233,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F 可以通过alignItems参数设置在交叉轴的对齐方式，可选值有： - ItemAlign.Auto: 使用Flex容器中默认配置。 - + ``` Flex({ alignItems: ItemAlign.Auto }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) @@ -248,7 +248,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218419616](figures/zh-cn_image_0000001218419616.png) - ItemAlign.Start: 交叉轴方向首部对齐。 - + ``` Flex({ alignItems: ItemAlign.Start }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) @@ -263,7 +263,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001263259401](figures/zh-cn_image_0000001263259401.png) - ItemAlign.Center: 交叉轴方向居中对齐。 - + ``` Flex({ alignItems: ItemAlign.Center }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) @@ -278,7 +278,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218259636](figures/zh-cn_image_0000001218259636.png) - ItemAlign.End：交叉轴方向底部对齐。 - + ``` Flex({ alignItems: ItemAlign.End }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) @@ -293,7 +293,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218579610](figures/zh-cn_image_0000001218579610.png) - ItemAlign. Stretch：交叉轴方向拉伸填充，在未设置尺寸时，拉伸到容器尺寸。 - + ``` Flex({ alignItems: ItemAlign.Stretch }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) @@ -308,7 +308,7 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ![zh-cn_image_0000001218739570](figures/zh-cn_image_0000001218739570.png) - ItemAlign.Baseline：交叉轴方向文本基线对齐。 - + ``` Flex({ alignItems: ItemAlign.Baseline }) { Text('1').width('33%').height(30).backgroundColor(0xF5DEB3) diff --git a/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md b/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md index df9383f16bbd3f62f6de1e8dd6d148ca19d0dedc..8223e2a771379d0441519ee0ad3515ff6b0ae67b 100644 --- a/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md +++ b/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md @@ -8,7 +8,7 @@ 2. 给系统提供一种统一的定位标注，保证各模块各设备的布局一致性。 3. 给应用提供一种灵活的间距调整方法，满足特殊场景布局调整的可能性。 -为实现栅格布局效果，声明式范式提供了GridContainer栅格容器组件，配合其子组件的通用属性useSizeType来实现栅格布局。 +为实现栅格布局效果，声明式范式提供了[GridContainer](../reference/arkui-ts/ts-container-gridcontainer.md)栅格容器组件，配合其子组件的通用属性useSizeType来实现栅格布局。 ## 栅格系统 @@ -32,15 +32,13 @@ 系统以设备的水平宽度的屏幕密度像素值作为断点依据，根据当前设备水平宽度所在的断点范围，定义了设备的宽度类型。系统的栅格断点范围、设备宽度类型及其描述，以及对应的默认总列数(columns)，边距（gutter)，间隔(gutter)定义如下： -系统栅格定义 - -| 设备水平宽度断点范围 | 设备宽度类型 | 描述 | columns | gutter | margin | -| -------- | -------- | -------- | -------- | -------- | -------- | -| 0<水平宽度<320vp | XS | 最小宽度类型设备。 | 2 | 12vp | 12vp | -| 320vp<=水平宽度<600vp | SM | 小宽度类型设备。 | 4 | 24vp | 24vp | -| 600vp<=水平宽度<840vp | MD | 中等宽度类型设备。 | 8 | 24vp | 32vp | -| 840<=水平分辨率 | LG | 大宽度类型设备。 | 12 | 24vp | 48vp | +| 设备水平宽度断点范围 | 设备宽度类型 | 描述 | columns | gutter | margin | +| ----------------------- | ------ | --------- | ------- | ------ | ------ | +| 0<水平宽度<320vp | XS | 最小宽度类型设备。 | 2 | 12vp | 12vp | +| 320vp<=水平宽度<600vp | SM | 小宽度类型设备。 | 4 | 24vp | 24vp | +| 600vp<=水平宽度<840vp | MD | 中等宽度类型设备。 | 8 | 24vp | 32vp | +| 840<=水平分辨率 | LG | 大宽度类型设备。 | 12 | 24vp | 48vp | ## 如何使用 @@ -48,37 +46,40 @@ ### 创建栅格容器 -通过接口：GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length})创建栅格容器，栅格容器内的所有子组件可以使用栅格布局。 +通过接口`GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length})`创建栅格容器，栅格容器内的所有子组件可以使用栅格布局。 -可以通过参数定义栅格布局的总列数（columns)，间隔（gutter)，两侧边距（margin)。例如栅格容器总共分为6列，列于列间隔为10vp, 两侧边距为20vp： -``` -GridContainer({ columns: 6, gutter: 10, margin: 20 }) {} -``` -栅格容器不设置参数，或者sizeType设置为SizeType.Auto时使用默认的栅格系统定义，如： +- 可以通过参数定义栅格布局的总列数（columns)，间隔（gutter)，两侧边距（margin)。例如栅格容器总共分为6列，列于列间隔为10vp, 两侧边距为20vp： -``` -GridContainer() {} -``` -上述例子中，默认在在小宽度类型设备(SizeType.SM)上，栅格容器被分为4列，列于列的间隔为24vp, 两侧边距是24vp。在中等宽度类型设备(SizeType.MD)上，栅格容器被分为8列，列于列的间隔为24vp，两侧边距是32vp。 + ``` + GridContainer({ columns: 6, gutter: 10, margin: 20 }) {} + ``` + 栅格容器不设置参数，或者sizeType设置为SizeType.Auto时使用默认的栅格系统定义，如： + ``` + GridContainer() {} + ``` -也可以通过参数sizeType指定此栅格容器内的组件使用此设备宽度类型的栅格设置，如： + 上述例子中，默认在在小宽度类型设备(SizeType.SM)上，栅格容器被分为4列，列于列的间隔为24vp, 两侧边距是24vp。在中等宽度类型设备(SizeType.MD)上，栅格容器被分为8列，列于列的间隔为24vp，两侧边距是32vp。 -``` -GridContainer({ sizeType: SizeType.SM) { - Row() { - Text('1') - .useSizeType({ - xs: { span: 2}, - sm: { span: 3, offset: 1 }, - md: { span: 6, offset: 2 }, - lg: { span: 8, offset: 2 }, - }) - } -} -``` -上述例子中，不管在任何宽度类型的设备上， Text组件都使用SizeType.SM类型的栅格设置即占用3列，放置在第1列。 +- 也可以通过参数sizeType指定此栅格容器内的组件使用此设备宽度类型的栅格设置，如： + + ``` + GridContainer({ sizeType: SizeType.SM) { + Row() { + + Text('1') + .useSizeType({ + xs: { span: 2}, + sm: { span: 3, offset: 1 }, + md: { span: 6, offset: 2 }, + lg: { span: 8, offset: 2 }, + }) + } + } + ``` + + 上述例子中，不管在任何宽度类型的设备上， Text组件都使用SizeType.SM类型的栅格设置即占用3列，放置在第1列。 ### 栅格容器内子组件的栅格设置 @@ -97,7 +98,7 @@ GridContainer() { } } ``` -其中sm: { span: 2, offset: 0 } 指在设备宽度类型为SM的设备上，Text组件占用3列，且放在栅格容器的第1列上。 +其中`sm: { span: 2, offset: 0 } `指在设备宽度类型为SM的设备上，Text组件占用3列，且放在栅格容器的第1列上。 ## 场景示例 使用栅格布局可以灵活地在不同的设备宽度类型下呈现合适的效果，而不必书写大量的代码兼容不同宽度类型的设备。