From 74a176cfcb34a1b7b8e3f00bbb463f78da13c951 Mon Sep 17 00:00:00 2001 From: HelloCrease Date: Thu, 8 Jun 2023 20:05:27 +0800 Subject: [PATCH] update docs Signed-off-by: HelloCrease --- .../arkui-ts/ts-canvasrenderingcontext2d.md | 162 +++++++++--------- .../reference/arkui-ts/ts-container-list.md | 101 +++++------ .../ts-offscreencanvasrenderingcontext2d.md | 122 ++++++------- .../ui/arkts-graphics-display.md | 4 + .../web/web-in-page-app-function-invoking.md | 2 +- zh-cn/application-dev/website.md | 7 +- 6 files changed, 202 insertions(+), 196 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md index 1e4a0f358d..cf4a768595 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md @@ -16,9 +16,9 @@ CanvasRenderingContext2D(settings?: RenderingContextSettings) **参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | -| ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| setting | [RenderingContextSettings](#renderingcontextsettings) | 否 | 见[RenderingContextSettings](#renderingcontextsettings)。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| settings | [RenderingContextSettings](#renderingcontextsettings) | 否 | 见[RenderingContextSettings](#renderingcontextsettings)。 | ### RenderingContextSettings @@ -38,30 +38,30 @@ RenderingContextSettings(antialias?: boolean) ## 属性 -| 名称 | 类型 | 描述 | -| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [fillStyle](#fillstyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 指定绘制的填充色。
- 类型为string时，表示设置填充区域的颜色。
- 类型为number时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 | -| [strokeStyle](#strokestyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 设置描边的颜色。
- 类型为string时，表示设置描边使用的颜色。
- 类型为number时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
默认值：'butt'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
默认值：'miter'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
默认值：10
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [font](#font) | string | 设置文本绘制中的字体样式。
语法：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、vp。使用时需要添加单位。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
默认值：'normal normal 14px sans-serif'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
默认值：'left'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
默认值：'alphabetic'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [globalAlpha](#globalalpha) | number | 设置透明度，0.0为完全透明，1.0为完全不透明。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
默认值：0.0
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。
默认值：'source-over'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
默认值：0.0
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
默认值：true
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [height](#height) | number | 组件高度。
单位：vp
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [width](#width) | number | 组件宽度。
单位：vp
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [imageSmoothingQuality](#imagesmoothingquality) |ImageSmoothingQuality | imageSmoothingEnabled为true时，用于设置图像平滑度。可选值为：
- 'low'：低画质
- 'medium'：中画质
- 'high'：高画质。
默认值：low
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [direction](#direction) |CanvasDirection | 用于设置绘制文字时使用的文字方向。可选值为：
- 'inherit'：继承canvas组件已设定的文本方向
- 'ltr'：从左往右
- 'rtl'：从右往左。
默认值：inherit
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [filter](#filter) |string | 用于设置图像的滤镜。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| 名称 | 类型 | 描述 | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| [fillStyle](#fillstyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 指定绘制的填充色。
- 类型为string时，表示设置填充区域的颜色。
- 类型为number时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 | +| [strokeStyle](#strokestyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 设置描边的颜色。
- 类型为string时，表示设置描边使用的颜色。
- 类型为number时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
默认值：'butt'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
默认值：'miter'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
默认值：10
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [font](#font) | string | 设置文本绘制中的字体样式。
语法：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、vp。使用时需要添加单位。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
默认值：'normal normal 14px sans-serif'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
默认值：'left'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
默认值：'alphabetic'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [globalAlpha](#globalalpha) | number | 设置透明度，0.0为完全透明，1.0为完全不透明。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
默认值：0.0
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。
默认值：'source-over'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
默认值：0.0
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
默认值：true
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [height](#height) | number | 组件高度。
单位：vp
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [width](#width) | number | 组件宽度。
单位：vp
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [imageSmoothingQuality](#imagesmoothingquality) | ImageSmoothingQuality | imageSmoothingEnabled为true时，用于设置图像平滑度。可选值为：
- 'low'：低画质
- 'medium'：中画质
- 'high'：高画质。
默认值：low
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [direction](#direction) | CanvasDirection | 用于设置绘制文字时使用的文字方向。可选值为：
- 'inherit'：继承canvas组件已设定的文本方向
- 'ltr'：从左往右
- 'rtl'：从右往左。
默认值：inherit
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [filter](#filter) | string | 用于设置图像的滤镜。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | > **说明：** > @@ -872,12 +872,12 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void **参数：** -| 参数 | 类型 | 必填 | 默认值 | 说明 | -| -------- | ------ | ---- | ------ | ----------------------------- | -| text | string | 是 | '' | 需要绘制的文本内容。 | -| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | -| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | -| maxWidth | number | 否 | - | 指定文本允许的最大宽度。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| -------- | ------ | ---- | ---- | --------------- | +| text | string | 是 | '' | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +| maxWidth | number | 否 | - | 指定文本允许的最大宽度。 | **示例：** @@ -919,12 +919,12 @@ strokeText(text: string, x: number, y: number, maxWidth?:number): void **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| -------- | ------ | ---- | ------ | ----------------------------- | -| text | string | 是 | '' | 需要绘制的文本内容。 | -| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | -| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | -| maxWidth | number | 否 | - | 需要绘制的文本的最大宽度 。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | ------ | ---- | ---- | --------------- | +| text | string | 是 | '' | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +| maxWidth | number | 否 | - | 需要绘制的文本的最大宽度 。 | **示例：** @@ -966,14 +966,14 @@ measureText(text: string): TextMetrics **参数：** -| 参数 | 类型 | 必填 | 默认值 | 说明 | -| ---- | ------ | ---- | ------ | -------------------- | -| text | string | 是 | '' | 需要进行测量的文本。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | ---------- | +| text | string | 是 | '' | 需要进行测量的文本。 | **返回值：** -| 类型 | 说明 | -| ----------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| ----------- | ---------------------------------------- | | TextMetrics | 文本的尺寸信息。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | **TextMetrics类型描述:** @@ -1264,15 +1264,15 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu **参数：** -| 参数 | 类型 | 必填 | 描述 | -| ---------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | -| image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | 图源对象，具体参考ImageBitmap对象。 | -| repetition | string | 是 | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'、'clamp'、'mirror'。
默认值：'' | +| 参数 | 类型 | 必填 | 描述 | +| ---------- | ---------------------------------------- | ---- | ---------------------------------------- | +| image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | 图源对象，具体参考ImageBitmap对象。 | +| repetition | string | 是 | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'、'clamp'、'mirror'。
默认值：'' | **返回值：** -| 类型 | 说明 | -| ------------------------------- | ----------------------- | +| 类型 | 说明 | +| ---------------------------------------- | ----------------------- | | [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 通过指定图像和重复方式创建图片填充的模板对象。 | **示例：** @@ -1516,16 +1516,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 | 椭圆绘制的结束点角度，以弧度表示。 | -| counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。
true:逆时针方向绘制椭圆。
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 | 椭圆绘制的结束点角度，以弧度表示。 | +| counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。
true:逆时针方向绘制椭圆。
false:顺时针方向绘制椭圆。 | **示例：** @@ -1812,8 +1812,8 @@ filter(filter: string): void **参数:** -| 参数 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ---- | ------------ | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ---------------------------------------- | | filter | string | 是 | - | 接受各类滤镜效果的函数。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none' | **示例：** @@ -1888,8 +1888,8 @@ getTransform(): Matrix2D **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------- | ---------- | +| 类型 | 说明 | +| ---------------------------------------- | ----- | | [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 矩阵对象。 | @@ -2157,9 +2157,9 @@ setTransform(transform?: Matrix2D): void **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| --------- | ----------------------------------------------------- | ---- | ------ | ---------- | -| transform | [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 否 | null | 变换矩阵。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| --------- | ---------------------------------------- | ---- | ---- | ----- | +| transform | [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 否 | null | 变换矩阵。 | ### translate @@ -2388,15 +2388,15 @@ putImageData(imageData: ImageData, dx: number | string, dy: number | string, dir **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| ----------- | ---------------------------------------------- | ---- | --------------- | --------------------------------------------------------- | -| imagedata | [ImageData](ts-components-canvas-imagedata.md) | 是 | null | 包含像素值的ImageData对象。 | -| dx | number \| string10+ | 是 | 0 | 填充区域在x轴方向的偏移量。 | -| dy | number \| string10+ | 是 | 0 | 填充区域在y轴方向的偏移量。 | -| dirtyX | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | -| dirtyY | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | -| dirtyWidth | number \| string10+ | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | -| dirtyHeight | number \| string10+ | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----------- | ---------------------------------------- | ---- | ------------ | ----------------------------- | +| imagedata | [ImageData](ts-components-canvas-imagedata.md) | 是 | null | 包含像素值的ImageData对象。 | +| dx | number \| string10+ | 是 | 0 | 填充区域在x轴方向的偏移量。 | +| dy | number \| string10+ | 是 | 0 | 填充区域在y轴方向的偏移量。 | +| dirtyX | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | +| dirtyY | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | +| dirtyWidth | number \| string10+ | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | +| dirtyHeight | number \| string10+ | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | **示例：** @@ -2873,11 +2873,11 @@ createConicGradient(startAngle: number, x: number, y: number): CanvasGradient **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| ---------- | ------ | ---- | ------ | ------------------------------------------------------------ | -| startAngle | number | 是 | 0 | 开始渐变的角度，以弧度为单位。角度测量从中心右侧水平开始，顺时针移动。 | -| x | number | 是 | 0 | 圆锥渐变的中心x轴坐标。单位：vp | -| y | number | 是 | 0 | 圆锥渐变的中心y轴坐标。单位：vp | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ------ | ---- | ---- | ----------------------------------- | +| startAngle | number | 是 | 0 | 开始渐变的角度，以弧度为单位。角度测量从中心右侧水平开始，顺时针移动。 | +| x | number | 是 | 0 | 圆锥渐变的中心x轴坐标。单位：vp | +| y | number | 是 | 0 | 圆锥渐变的中心y轴坐标。单位：vp | **示例：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md index b9472dbddf..75c3642111 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md @@ -39,37 +39,37 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? **参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -| space | number \| string | 否 | 子组件主轴方向的间隔。
默认值：0
**说明：**
设置为除-1外其他负数或百分比时，按默认值显示。
space参数值小于List分割线宽度时，子组件主轴方向的间隔取分割线宽度。 | -| initialIndex | number | 否 | 设置当前List初次加载时视口起始位置显示的item的索引值。
默认值：0
**说明：**
设置为除-1外其他负数或超过了当前List最后一个item的索引值时视为无效取值，无效取值按默认值显示。 | -| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。
**说明：**
不允许和其他滚动类组件绑定同一个滚动控制对象。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------------ | ---------------------------------------- | ---- | ---------------------------------------- | +| space | number \| string | 否 | 子组件主轴方向的间隔。
默认值：0
**说明：**
设置为除-1外其他负数或百分比时，按默认值显示。
space参数值小于List分割线宽度时，子组件主轴方向的间隔取分割线宽度。 | +| initialIndex | number | 否 | 设置当前List初次加载时视口起始位置显示的item的索引值。
默认值：0
**说明：**
设置为除-1外其他负数或超过了当前List最后一个item的索引值时视为无效取值，无效取值按默认值显示。 | +| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。
**说明：**
不允许和其他滚动类组件绑定同一个滚动控制对象。 | ## 属性 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向。
默认值：Axis.Vertical
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| divider | {
strokeWidth: [Length](ts-types.md#length),
color?:[ResourceColor](ts-types.md#resourcecolor),
startMargin?: Length,
endMargin?: Length
} \| null | 设置ListItem分割线样式，默认无分割线。
- strokeWidth: 分割线的线宽。
- color: 分割线的颜色。
- startMargin: 分割线与列表侧边起始端的距离。
- endMargin: 分割线与列表侧边结束端的距离。
从API version 9开始，该接口支持在ArkTS卡片中使用。
endMargin +startMargin 不能超过列宽度。
startMargin和endMargin不支持设置百分比。
List的分割线画在主轴方向两个子组件之间，第一个子组件上方和最后一个子组件下方不会绘制分割线。
多列模式下，ListItem与ListItem之间的分割线起始边距从每一列的交叉轴方向起始边开始计算，其他情况从List交叉轴方向起始边开始计算。 | -| scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。
默认值：BarState.Off
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
API version 9及以下版本默认值为BarState.Off，API version 10的默认值为BarState.Auto。 | -| cachedCount | number | 设置列表中ListItem/ListItemGroup的预加载数量，只在[LazyForEach](../../quick-start/arkts-rendering-control-lazyforeach.md)中生效，其中ListItemGroup将作为一个整体进行计算，ListItemGroup中的所有ListItem会一次性全部加载出来。具体使用可参考[减少应用白块说明](../../ui/arkts-performance-improvement-recommendation.md#减少应用滑动白块)。
默认值：1
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
单列模式下，会在List显示的ListItem前后各缓存cachedCount个ListItem。
多列模式下， 会在List显示的ListItem前后各缓存cachedCount*列数个ListItem。 | -| editMode(deprecated) | boolean | 声明当前List组件是否处于可编辑模式。
从API version9开始废弃。可参考[示例3](#示例3)实现删除选中的list项。
默认值：false | -| edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | 设置组件的滑动效果，支持弹簧效果和阴影效果。
默认值：EdgeEffect.Spring
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| chainAnimation | boolean | 设置当前List是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果：List内的list-item间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。
默认值：false
- false：不启用链式联动。
- true：启用链式联动。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
链式动效生效后，List的分割线不显示。
链式动效生效需要满足以下前提条件：
-  List边缘效果为Spring类型
-  List没有启用多列模式 | -|chainAnimationOptions10+| [ChainAnimationOptions](#chainanimationoptions10对象说明) | 设置链式联动动效参数。
**系统API：** 此接口为系统接口。 | -| multiSelectable8+ | boolean | 是否开启鼠标框选。
默认值：false
- false：关闭框选。
- true：开启框选。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| lanes9+ | number \| [LengthConstrain](ts-types.md#lengthconstrain) | 以列模式为例（listDirection为Axis.Vertical）:
lanes用于决定List组件在交叉轴方向按几列布局。
默认值：1
规则如下：
- lanes为指定的数量时，根据指定的数量与List组件的交叉轴尺寸除以列数作为列的宽度。
- lanes设置了{minLength，maxLength}时，根据List组件的宽度自适应决定lanes数量（即列数），保证缩放过程中lane的宽度符合{minLength，maxLength}的限制。其中，minLength条件会被优先满足，即优先保证符合ListItem的交叉轴尺寸符合最小限制。
- lanes设置了{minLength，maxLength}，如果父组件交叉轴方向尺寸约束为无穷大时，固定按一列排列，列宽度按显示区域内最大的ListItem计算
- ListItemGroup在多列模式下也是独占一行，ListItemGroup中的ListItem按照List组件的lanes属性设置值来布局。
- lanes设置了{minLength，maxLength}时，计算列数会按照ListItemGroup的交叉轴尺寸计算。当ListItemGroup交叉轴尺寸与List交叉轴尺寸不一致时ListItemGroup中的列数与List中的列数可能不一样。
该接口支持在ArkTS卡片中使用。 | -| alignListItem9+ | [ListItemAlign](#listitemalign9枚举说明) | List交叉轴方向宽度大于ListItem交叉轴宽度 * lanes时，ListItem在List交叉轴方向的布局方式，默认为首部对齐。
默认值：ListItemAlign.Start
该接口支持在ArkTS卡片中使用。 | -| sticky9+ | [StickyStyle](#stickystyle9枚举说明) | 配合[ListItemGroup](ts-container-listitemgroup.md)组件使用，设置ListItemGroup中header和footer是否要吸顶或吸底。
默认值：StickyStyle.None
该接口支持在ArkTS卡片中使用。
**说明：**
sticky属性可以设置为 StickyStyle.Header \| StickyStyle.Footer 以同时支持header吸顶和footer吸底。 | +| 名称 | 参数类型 | 描述 | +| ----------------------------------- | ---------------------------------------- | ---------------------------------------- | +| listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向。
默认值：Axis.Vertical
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| divider | {
strokeWidth: [Length](ts-types.md#length),
color?:[ResourceColor](ts-types.md#resourcecolor),
startMargin?: Length,
endMargin?: Length
} \| null | 设置ListItem分割线样式，默认无分割线。
- strokeWidth: 分割线的线宽。
- color: 分割线的颜色。
- startMargin: 分割线与列表侧边起始端的距离。
- endMargin: 分割线与列表侧边结束端的距离。
从API version 9开始，该接口支持在ArkTS卡片中使用。
endMargin +startMargin 不能超过列宽度。
startMargin和endMargin不支持设置百分比。
List的分割线画在主轴方向两个子组件之间，第一个子组件上方和最后一个子组件下方不会绘制分割线。
多列模式下，ListItem与ListItem之间的分割线起始边距从每一列的交叉轴方向起始边开始计算，其他情况从List交叉轴方向起始边开始计算。 | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。
默认值：BarState.Off
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
API version 9及以下版本默认值为BarState.Off，API version 10的默认值为BarState.Auto。 | +| cachedCount | number | 设置列表中ListItem/ListItemGroup的预加载数量，只在[LazyForEach](../../quick-start/arkts-rendering-control-lazyforeach.md)中生效，其中ListItemGroup将作为一个整体进行计算，ListItemGroup中的所有ListItem会一次性全部加载出来。具体使用可参考[减少应用白块说明](../../ui/arkts-performance-improvement-recommendation.md#减少应用滑动白块)。
默认值：1
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
单列模式下，会在List显示的ListItem前后各缓存cachedCount个ListItem。
多列模式下， 会在List显示的ListItem前后各缓存cachedCount*列数个ListItem。 | +| editMode(deprecated) | boolean | 声明当前List组件是否处于可编辑模式。
从API version9开始废弃。可参考[示例3](#示例3)实现删除选中的list项。
默认值：false | +| edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | 设置组件的滑动效果，支持弹簧效果和阴影效果。
默认值：EdgeEffect.Spring
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| chainAnimation | boolean | 设置当前List是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果：List内的list-item间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。
默认值：false
- false：不启用链式联动。
- true：启用链式联动。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
链式动效生效后，List的分割线不显示。
链式动效生效需要满足以下前提条件：
-  List边缘效果为Spring类型
-  List没有启用多列模式 | +| chainAnimationOptions10+ | [ChainAnimationOptions](#chainanimationoptions10对象说明) | 设置链式联动动效参数。
**系统API：** 此接口为系统接口。 | +| multiSelectable8+ | boolean | 是否开启鼠标框选。
默认值：false
- false：关闭框选。
- true：开启框选。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| lanes9+ | number \| [LengthConstrain](ts-types.md#lengthconstrain) | 以列模式为例（listDirection为Axis.Vertical）:
lanes用于决定List组件在交叉轴方向按几列布局。
默认值：1
规则如下：
- lanes为指定的数量时，根据指定的数量与List组件的交叉轴尺寸除以列数作为列的宽度。
- lanes设置了{minLength，maxLength}时，根据List组件的宽度自适应决定lanes数量（即列数），保证缩放过程中lane的宽度符合{minLength，maxLength}的限制。其中，minLength条件会被优先满足，即优先保证符合ListItem的交叉轴尺寸符合最小限制。
- lanes设置了{minLength，maxLength}，如果父组件交叉轴方向尺寸约束为无穷大时，固定按一列排列，列宽度按显示区域内最大的ListItem计算
- ListItemGroup在多列模式下也是独占一行，ListItemGroup中的ListItem按照List组件的lanes属性设置值来布局。
- lanes设置了{minLength，maxLength}时，计算列数会按照ListItemGroup的交叉轴尺寸计算。当ListItemGroup交叉轴尺寸与List交叉轴尺寸不一致时ListItemGroup中的列数与List中的列数可能不一样。
该接口支持在ArkTS卡片中使用。 | +| alignListItem9+ | [ListItemAlign](#listitemalign9枚举说明) | List交叉轴方向宽度大于ListItem交叉轴宽度 * lanes时，ListItem在List交叉轴方向的布局方式，默认为首部对齐。
默认值：ListItemAlign.Start
该接口支持在ArkTS卡片中使用。 | +| sticky9+ | [StickyStyle](#stickystyle9枚举说明) | 配合[ListItemGroup](ts-container-listitemgroup.md)组件使用，设置ListItemGroup中header和footer是否要吸顶或吸底。
默认值：StickyStyle.None
该接口支持在ArkTS卡片中使用。
**说明：**
sticky属性可以设置为 StickyStyle.Header \| StickyStyle.Footer 以同时支持header吸顶和footer吸底。 | ## ListItemAlign9+枚举说明 该接口支持在ArkTS卡片中使用。 -| 名称 | 描述 | -| ------ | -------------------------------------- | +| 名称 | 描述 | +| ------ | ------------------------- | | Start | ListItem在List中，交叉轴方向首部对齐。 | | Center | ListItem在List中，交叉轴方向居中对齐。 | | End | ListItem在List中，交叉轴方向尾部对齐。 | @@ -78,11 +78,11 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? 该接口支持在ArkTS卡片中使用。 -| 名称 | 描述 | -| ------ | -------------------------------------- | -| None | ListItemGroup的header不吸顶，footer不吸底。 | -| Header | ListItemGroup的header吸顶，footer不吸底。 | -| Footer | ListItemGroup的footer吸底，header不吸底。 | +| 名称 | 描述 | +| ------ | ---------------------------------- | +| None | ListItemGroup的header不吸顶，footer不吸底。 | +| Header | ListItemGroup的header吸顶，footer不吸底。 | +| Footer | ListItemGroup的footer吸底，header不吸底。 | ## ChainEdgeEffect10+枚举说明 @@ -90,10 +90,10 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? **系统API：** 此接口为系统接口 -| 名称 | 描述 | -| ------ | -------------------------------------- | -| DEFAULT | 默认效果，列表滚动到边缘以后继续拖动，拖拽方向上的列表项间距缩小，拖拽反方向上的列表项间距扩大。 | -| STRETCH | 列表滚动到边缘以后继续拖动，所有列表项间距扩大。 | +| 名称 | 描述 | +| ------- | ---------------------------------------- | +| DEFAULT | 默认效果，列表滚动到边缘以后继续拖动，拖拽方向上的列表项间距缩小，拖拽反方向上的列表项间距扩大。 | +| STRETCH | 列表滚动到边缘以后继续拖动，所有列表项间距扩大。 | ## chainAnimationOptions10+对象说明 @@ -101,13 +101,13 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? **系统API：** 此接口为系统接口 -| 名称 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | --------------- | -| minSpace | [Length](ts-types.md#length) | 是 | 设置链式联动动效最小间距。 | -| maxSpace | [Length](ts-types.md#length) | 是 | 设置链式联动动效最大间距。 | -| conductivity | number | 否 | 设置链式联动动效传导系数。取值范围[0,1]，数值越大，动效传导范围越远。
默认为0.7。 | -| intensity | number | 否 | 设置链式联动动效效果强度。取值范围[0,1]，数值越大，动效效果越明显。
默认为0.3。 | -| edgeEffect | [ChainEdgeEffect](#chainedgeeffect10枚举说明) | 否 | 设置链式联动动效边缘效果。
默认为ChainEdgeEffect.DEFAULT。| +| 名称 | 类型 | 必填 | 说明 | +| ------------ | ---------------------------------------- | ---- | ---------------------------------------- | +| minSpace | [Length](ts-types.md#length) | 是 | 设置链式联动动效最小间距。 | +| maxSpace | [Length](ts-types.md#length) | 是 | 设置链式联动动效最大间距。 | +| conductivity | number | 否 | 设置链式联动动效传导系数。取值范围[0,1]，数值越大，动效传导范围越远。
默认为0.7。 | +| intensity | number | 否 | 设置链式联动动效效果强度。取值范围[0,1]，数值越大，动效效果越明显。
默认为0.3。 | +| edgeEffect | [ChainEdgeEffect](#chainedgeeffect10枚举说明) | 否 | 设置链式联动动效边缘效果。
默认为ChainEdgeEffect.DEFAULT。 | > **说明：** > @@ -115,16 +115,16 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onItemDelete(deprecated)(event: (index: number) => boolean) | 当List组件在编辑模式时，点击ListItem右边出现的删除按钮时触发。
从API version9开始废弃。
- index: 被删除的列表项的索引值。 | | onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发。
- scrollOffset: 每帧滚动的偏移量，List的内容向上滚动时偏移量为正，向下滚动时偏移量为负。
- [scrollState](#scrollstate枚举说明): 当前滑动状态。
使用控制器调用ScrollEdge和ScrollToIndex时不会触发，其余情况有滚动就会触发该事件。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | | onScrollIndex(event: (start: number, end: number) => void) | 有子组件划入或划出List显示区域时触发。
计算索引值时，ListItemGroup作为一个整体占一个索引值，不计算ListItemGroup内部ListItem的索引值。
- start: 滑动起始位置索引值。
- end: 滑动结束位置索引值。
触发该事件的条件：列表初始化时会触发一次，List显示区域内第一个子组件的索引值或后一个子组件的索引值有变化时会触发。
List的边缘效果为弹簧效果时，在List划动到边缘继续划动和松手回弹过程不会触发onScrollIndex事件。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| onReachStart(event: () => void) | 列表到达起始位置时触发。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
List初始化时如果initialIndex为0会触发一次，List滚动到起始位置时触发一次。List边缘效果为弹簧效果时，划动经过起始位置时触发一次，回弹回起始位置时再触发一次。 | -| onReachEnd(event: () => void) | 列表到底末尾位置时触发。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
List边缘效果为弹簧效果时，划动经过末尾位置时触发一次，回弹回末尾位置时再触发一次。 | +| onReachStart(event: () => void) | 列表到达起始位置时触发。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
List初始化时如果initialIndex为0会触发一次，List滚动到起始位置时触发一次。List边缘效果为弹簧效果时，划动经过起始位置时触发一次，回弹回起始位置时再触发一次。 | +| onReachEnd(event: () => void) | 列表到底末尾位置时触发。
从API version 9开始，该接口支持在ArkTS卡片中使用。
**说明：**
List边缘效果为弹簧效果时，划动经过末尾位置时触发一次，回弹回末尾位置时再触发一次。 | | onScrollFrameBegin9+(event: (offset: number, state: ScrollState) => { offsetRemain }) | 列表开始滑动时触发，事件参数传入即将发生的滑动量，事件处理函数中可根据应用场景计算实际需要的滑动量并作为事件处理函数的返回值返回，列表将按照返回值的实际滑动量进行滑动。
\- offset：即将发生的滑动量，单位vp。
\- state：当前滑动状态。
- offsetRemain：实际滑动量，单位vp。
触发该事件的条件：手指拖动List、List惯性划动时每帧开始时触发；List超出边缘回弹、使用滚动控制器的滚动不会触发。
该接口支持在ArkTS卡片中使用。
**说明：**
当listDirection的值为Axis.Vertical时，返回垂直方向滑动量，当listDirection的值为Axis.Horizontal时，返回水平方向滑动量。 | | onScrollStart9+(event: () => void) | 列表滑动开始时触发。手指拖动列表或列表的滚动条触发的滑动开始时，会触发该事件。使用[Scroller](ts-container-scroll.md#scroller)滑动控制器触发的带动画的滑动，动画开始时会触发该事件。
该接口支持在ArkTS卡片中使用。 | -| onScrollStop(event: () => void) | 列表滑动停止时触发。手拖动列表或列表的滚动条触发的滑动，手离开屏幕并且滑动停止时会触发该事件；使用[Scroller](ts-container-scroll.md#scroller)滑动控制器触发的带动画的滑动，动画停止会触发该事件。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| onScrollStop(event: () => void) | 列表滑动停止时触发。手拖动列表或列表的滚动条触发的滑动，手离开屏幕并且滑动停止时会触发该事件；使用[Scroller](ts-container-scroll.md#scroller)滑动控制器触发的带动画的滑动，动画停止会触发该事件。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | | onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发。
- from: 移动前索引值。
- to: 移动后索引值。 | | onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) \| void) | 开始拖拽列表元素时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。
- itemIndex: 被拖拽列表元素索引值。 | | onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入列表元素范围内时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。 | @@ -136,11 +136,11 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? 从API version 9开始，该接口支持在ArkTS卡片中使用。 -| 名称 | 描述 | -| ------ | ------------------------- | -| Idle | 空闲状态。使用控制器提供的方法滚动、拖动滚动条滚动时触发。 | -| Scroll | 手指拖动状态。使用手指拖动List滚动时触发。 | -| Fling | 惯性滚动状态。快速划动松手后惯性滚动和划动到边缘回弹时触发。 | +| 名称 | 描述 | +| ------ | ------------------------------ | +| Idle | 空闲状态。使用控制器提供的方法滚动、拖动滚动条滚动时触发。 | +| Scroll | 手指拖动状态。使用手指拖动List滚动时触发。 | +| Fling | 惯性滚动状态。快速划动松手后惯性滚动和划动到边缘回弹时触发。 | > **说明：** > @@ -158,8 +158,9 @@ List(value?:{space?: number | string, initialIndex?: number, scroller? > > - 绑定onDragStart事件，且事件回调中返回浮动UI布局。 +## 示例 -## 示例1 +### 示例1 ```ts // xxx.ets @@ -199,7 +200,7 @@ struct ListExample { ![zh-cn_image_0000001174264378](figures/zh-cn_image_0000001174264378.gif) -## 示例2 +### 示例2 ```ts // xxx.ets @@ -248,7 +249,7 @@ struct ListLanesExample { ![list](figures/list1.gif) -## 示例3 +### 示例3 ```ts // xxx.ets 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 8823443bf9..72b306e766 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md @@ -3,7 +3,7 @@ 使用OffscreenCanvasRenderingContext2D在Canvas上进行离屏绘制，绘制对象可以是矩形、文本、图片等。离屏绘制是指将需要绘制的内容先绘制在缓存区，然后将其转换成图片，一次性绘制到canvas上，加快了绘制速度。 > **说明：** -> +> > 从 API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -16,37 +16,37 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, settings?: Rend **参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | -| ------- | ------------------------------------------------------------ | ---- | ------------------------------------ | -| width | number | 是 | 离屏画布的宽度 | -| height | number | 是 | 离屏画布的高度 | -| setting | [RenderingContextSettings](ts-canvasrenderingcontext2d.md#renderingcontextsettings) | 否 | 见RenderingContextSettings接口描述。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | ---------------------------------------- | ---- | ------------------------------ | +| width | number | 是 | 离屏画布的宽度 | +| height | number | 是 | 离屏画布的高度 | +| settings | [RenderingContextSettings](ts-canvasrenderingcontext2d.md#renderingcontextsettings) | 否 | 见RenderingContextSettings接口描述。 | ## 属性 -| 名称 | 类型 | 描述 | -| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [fillStyle](#fillstyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 指定绘制的填充色。
- 类型为string时，表示设置填充区域的颜色。
- 类型为number时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [strokeStyle](#strokestyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 设置描边的颜色。
- 类型为string时，表示设置描边使用的颜色。
- 类型为number时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
- 默认值：'butt'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
- 默认值：'miter'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
- 默认值：10。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [font](#font) | string | 设置文本绘制中的字体样式。
语法：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、vp。使用时需要添加单位。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
- 默认值：'normal normal 14px sans-serif'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
> **说明：**
> ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
- 默认值：'left'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
- 默认值：'alphabetic'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [globalAlpha](#globalalpha) | number | 设置透明度，0.0为完全透明，1.0为完全不透明。 | -| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
- 默认值：0.0。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。
- 默认值：'source-over'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
- 默认值：0.0。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
- 默认值：true。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [imageSmoothingQuality](#imagesmoothingquality) |ImageSmoothingQuality | imageSmoothingEnabled为true时，用于设置图像平滑度。可选值为：
- 'low'：低画质
- 'medium'：中画质
- 'high'：高画质。
默认值：low
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [direction](#direction) |CanvasDirection | 用于设置绘制文字时使用的文字方向。可选值为：
- 'inherit'：继承canvas组件已设定的文本方向
- 'ltr'：从左往右
- 'rtl'：从右往左。
默认值：inherit
从API version 9开始，该接口支持在ArkTS卡片中使用。 | -| [filter](#filter) |string | 用于设置图像的滤镜。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| 名称 | 类型 | 描述 | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| [fillStyle](#fillstyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 指定绘制的填充色。
- 类型为string时，表示设置填充区域的颜色。
- 类型为number时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [strokeStyle](#strokestyle) | string \|number10+ \|[CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 设置描边的颜色。
- 类型为string时，表示设置描边使用的颜色。
- 类型为number时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
- 默认值：'butt'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
- 默认值：'miter'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
- 默认值：10。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [font](#font) | string | 设置文本绘制中的字体样式。
语法：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、vp。使用时需要添加单位。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
- 默认值：'normal normal 14px sans-serif'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
> **说明：**
> ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
- 默认值：'left'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
- 默认值：'alphabetic'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [globalAlpha](#globalalpha) | number | 设置透明度，0.0为完全透明，1.0为完全不透明。 | +| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
- 默认值：0.0。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。
- 默认值：'source-over'。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
- 默认值：0.0。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
- 默认值：true。
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [imageSmoothingQuality](#imagesmoothingquality) | ImageSmoothingQuality | imageSmoothingEnabled为true时，用于设置图像平滑度。可选值为：
- 'low'：低画质
- 'medium'：中画质
- 'high'：高画质。
默认值：low
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [direction](#direction) | CanvasDirection | 用于设置绘制文字时使用的文字方向。可选值为：
- 'inherit'：继承canvas组件已设定的文本方向
- 'ltr'：从左往右
- 'rtl'：从右往左。
默认值：inherit
从API version 9开始，该接口支持在ArkTS卡片中使用。 | +| [filter](#filter) | string | 用于设置图像的滤镜。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none'
从API version 9开始，该接口支持在ArkTS卡片中使用。 | > **说明：** > fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)'，'rgba(255, 255, 255, 1.0)'，'\#FFFFFF'。 @@ -964,8 +964,8 @@ measureText(text: string): TextMetrics **返回值：** -| 类型 | 说明 | -| ----------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| ----------- | ---------------------------------------- | | TextMetrics | 文本的尺寸信息
从API version 9开始，该接口支持在ArkTS卡片中使用。 | **TextMetrics类型描述:** @@ -1278,8 +1278,8 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu **返回值：** -| 类型 | 说明 | -| ------------------------------- | ----------------------- | +| 类型 | 说明 | +| ---------------------------------------- | ----------------------- | | [CanvasPattern](ts-components-canvas-canvaspattern.md#canvaspattern) | 通过指定图像和重复方式创建图片填充的模板对象。 | **示例：** @@ -1538,16 +1538,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 | 椭圆绘制的结束点角度，以弧度表示。 | -| counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。
true:逆时针方向绘制椭圆。
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 | 椭圆绘制的结束点角度，以弧度表示。 | +| counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。
true:逆时针方向绘制椭圆。
false:顺时针方向绘制椭圆。 | **示例：** @@ -1794,7 +1794,7 @@ clip(path:Path2D, fillRule?: CanvasFillRule): void | 参数 | 类型 | 必填 | 默认值 | 描述 | | -------- | -------------- | ---- | --------- | ---------------------------------------- | -| path | Path2D | 是 | | Path2D剪切路径。 | +| path | Path2D | 是 | | Path2D剪切路径。 | | fillRule | CanvasFillRule | 否 | "nonzero" | 指定要剪切对象的规则。
可选参数为："nonzero", "evenodd"。 | **示例：** @@ -1850,8 +1850,8 @@ filter(filter: string): void **参数:** -| 参数 | 类型 | 必填 | 默认值 | 说明 | -| ------ | ------ | ---- | ---- | ------------ | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ---------------------------------------- | | filter | string | 是 | - | 接受各类滤镜效果的函数。支持的滤镜效果如下：
- 'none': 无滤镜效果
- 'blur'：给图像设置高斯模糊
- 'brightness'：给图片应用一种线性乘法，使其看起来更亮或更暗
- 'contrast'：调整图像的对比度
- 'grayscale'：将图像转换为灰度图像
- 'hue-rotate'：给图像应用色相旋转
- 'invert'：反转输入图像
- 'opacity'：转化图像的透明程度
- 'saturate'：转换图像饱和度
- 'sepia'：将图像转换为深褐色
默认值：'none' | **示例：** @@ -1927,8 +1927,8 @@ getTransform(): Matrix2D **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------- | ---------- | +| 类型 | 说明 | +| ---------------------------------------- | ----- | | [Matrix2D](ts-components-canvas-matrix2d.md#Matrix2D) | 矩阵对象。 | ### resetTransform @@ -2460,15 +2460,15 @@ putImageData(imageData: Object, dx: number | string, dy: number | string, dirtyX **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| ----------- | ---------------------------------------- | ---- | --------------- | --------------------------------------------------------- | -| imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | -| dx | number \| string10+ | 是 | 0 | 填充区域在x轴方向的偏移量。 | -| dy | number \| string10+ | 是 | 0 | 填充区域在y轴方向的偏移量。 | -| dirtyX | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | -| dirtyY | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | -| dirtyWidth | number \| string10+ | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | -| dirtyHeight | number \| string10+ | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----------- | ---------------------------------------- | ---- | ------------ | ----------------------------- | +| imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | +| dx | number \| string10+ | 是 | 0 | 填充区域在x轴方向的偏移量。 | +| dy | number \| string10+ | 是 | 0 | 填充区域在y轴方向的偏移量。 | +| dirtyX | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | +| dirtyY | number \| string10+ | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | +| dirtyWidth | number \| string10+ | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | +| dirtyHeight | number \| string10+ | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | **示例：** @@ -2963,11 +2963,11 @@ createConicGradient(startAngle: number, x: number, y: number): CanvasGradient **参数：** -| 参数 | 类型 | 必填 | 默认值 | 描述 | -| ---------- | ------ | ---- | ------ | ------------------------------------------------------------ | -| startAngle | number | 是 | 0 | 开始渐变的角度，以弧度为单位。角度测量从中心右侧水平开始，顺时针移动。 | -| x | number | 是 | 0 | 圆锥渐变的中心x轴坐标。单位：vp | -| y | number | 是 | 0 | 圆锥渐变的中心y轴坐标。单位：vp | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ------ | ---- | ---- | ----------------------------------- | +| startAngle | number | 是 | 0 | 开始渐变的角度，以弧度为单位。角度测量从中心右侧水平开始，顺时针移动。 | +| x | number | 是 | 0 | 圆锥渐变的中心x轴坐标。单位：vp | +| y | number | 是 | 0 | 圆锥渐变的中心y轴坐标。单位：vp | **示例：** diff --git a/zh-cn/application-dev/ui/arkts-graphics-display.md b/zh-cn/application-dev/ui/arkts-graphics-display.md index 44816912f1..c6ebe8f642 100644 --- a/zh-cn/application-dev/ui/arkts-graphics-display.md +++ b/zh-cn/application-dev/ui/arkts-graphics-display.md @@ -26,6 +26,7 @@ Image支持加载存档图、多媒体像素图两种类型。 存档图类型的数据源可以分为本地资源、网络资源、Resource资源、媒体库datashare资源和base64。 - 本地资源 + 创建文件夹，将本地图片放入ets文件夹下的任意位置。 Image组件引入本地图片路径，即可显示图片（根目录为ets文件夹）。 @@ -36,6 +37,7 @@ Image支持加载存档图、多媒体像素图两种类型。 ``` - 网络资源 + 引入网络图片需申请权限ohos.permission.INTERNET，具体申请方式请参考[权限申请声明](../security/accesstoken-guidelines.md)。此时，Image组件的src参数为网络图片的链接。 ```ts @@ -43,6 +45,7 @@ Image支持加载存档图、多媒体像素图两种类型。 ``` - Resource资源 + 使用资源格式可以跨包/跨模块引入图片，resources文件夹下的图片都可以通过$r资源接口读 取到并转换到Resource格式。 **图1** resouces   @@ -68,6 +71,7 @@ Image支持加载存档图、多媒体像素图两种类型。 ``` - 媒体库datashare + 支持datashare://路径前缀的字符串，用于访问通过媒体库提供的图片路径。 1. 调用接口获取图库的照片url。 diff --git a/zh-cn/application-dev/web/web-in-page-app-function-invoking.md b/zh-cn/application-dev/web/web-in-page-app-function-invoking.md index caffe3d2cc..9b7fdaeab7 100644 --- a/zh-cn/application-dev/web/web-in-page-app-function-invoking.md +++ b/zh-cn/application-dev/web/web-in-page-app-function-invoking.md @@ -92,7 +92,7 @@ > 使用[registerJavaScriptProxy()](../reference/apis/js-apis-webview.md#registerjavascriptproxy)接口注册方法时，注册后需调用[refresh()](../reference/apis/js-apis-webview.md#refresh)接口生效。 -- index.htm前端页面触发应用侧代码。 +- index.html前端页面触发应用侧代码。 ```html diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index a6ef8f8762..00c4edaba9 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -714,15 +714,16 @@ - [颜色渐变](reference/arkui-ts/ts-universal-attributes-gradient-color.md) - [Popup控制](reference/arkui-ts/ts-universal-attributes-popup.md) - [Menu控制](reference/arkui-ts/ts-universal-attributes-menu.md) - - [点击控制](reference/arkui-ts/ts-universal-attributes-click.md) - [焦点控制](reference/arkui-ts/ts-universal-attributes-focus.md) - [悬浮态效果](reference/arkui-ts/ts-universal-attributes-hover-effect.md) - [组件标识](reference/arkui-ts/ts-universal-attributes-component-id.md) - - [触摸热区设置](reference/arkui-ts/ts-universal-attributes-touch-target.md) - [多态样式](reference/arkui-ts/ts-universal-attributes-polymorphic-style.md) - - [触摸测试控制](reference/arkui-ts/ts-universal-attributes-hit-test-behavior.md) - [分布式迁移标识](reference/arkui-ts/ts-universal-attributes-restoreId.md) - [前景色设置](reference/arkui-ts/ts-universal-attributes-foreground-color.md) + - 触摸交互控制 + - [点击控制](reference/arkui-ts/ts-universal-attributes-click.md) + - [触摸热区设置](reference/arkui-ts/ts-universal-attributes-touch-target.md) + - [触摸测试控制](reference/arkui-ts/ts-universal-attributes-hit-test-behavior.md) - 模态转场设置 - [全屏模态转场](reference/arkui-ts/ts-universal-attributes-modal-transition.md) - [半模态转场](reference/arkui-ts/ts-universal-attributes-sheet-transition.md) -- GitLab