提交 1776cc39 编写于 作者: Z zhongjianfei

fix docs bugs for ArkTS card.

Signed-off-by: Nzhongjianfei <zhongjianfei@huawei.com>
Change-Id: Iddc0525494d824cf7b4c10c1d950d04b970bfadb
上级 5752db5c
...@@ -54,8 +54,6 @@ ...@@ -54,8 +54,6 @@
## TouchType ## TouchType
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------ | ------------------------------ | | ------ | ------------------------------ |
| Down | 手指按下时触发。 | | Down | 手指按下时触发。 |
...@@ -65,8 +63,6 @@ ...@@ -65,8 +63,6 @@
## MouseButton ## MouseButton
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------- | ---------------- | | ------- | ---------------- |
| Left | 鼠标左键。 | | Left | 鼠标左键。 |
...@@ -78,8 +74,6 @@ ...@@ -78,8 +74,6 @@
## MouseAction ## MouseAction
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------- | -------------- | | ------- | -------------- |
| Press | 鼠标按键按下。 | | Press | 鼠标按键按下。 |
...@@ -109,7 +103,7 @@ ...@@ -109,7 +103,7 @@
## AnimationStatus ## AnimationStatus
从API version 9开始,该接口支持在ArkTS卡片中使用。 从API version 10开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------- | ------------------ | | ------- | ------------------ |
...@@ -120,7 +114,7 @@ ...@@ -120,7 +114,7 @@
## FillMode ## FillMode
从API version 9开始,该接口支持在ArkTS卡片中使用。 从API version 10开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| --------- | ------------------------------------------------------------ | | --------- | ------------------------------------------------------------ |
...@@ -142,8 +136,6 @@ ...@@ -142,8 +136,6 @@
## KeyType ## KeyType
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ---- | ---------- | | ---- | ---------- |
| Down | 按键按下。 | | Down | 按键按下。 |
...@@ -151,8 +143,6 @@ ...@@ -151,8 +143,6 @@
## KeySource ## KeySource
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------------------- | | -------- | -------------------- |
| Unknown | 输入设备类型未知。 | | Unknown | 输入设备类型未知。 |
...@@ -172,8 +162,6 @@ ...@@ -172,8 +162,6 @@
## Week ## Week
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| -------- | ---------------------- | | -------- | ---------------------- |
| Mon | 星期一 | | Mon | 星期一 |
...@@ -242,8 +230,6 @@ ...@@ -242,8 +230,6 @@
## RelateType ## RelateType
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------ | ------------------------------- | | ------ | ------------------------------- |
| FILL | 缩放当前子组件以填充满父组件 | | FILL | 缩放当前子组件以填充满父组件 |
...@@ -384,8 +370,6 @@ ...@@ -384,8 +370,6 @@
## SharedTransitionEffectType ## SharedTransitionEffectType
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ----------- | ---------- | | ----------- | ---------- |
| Static | 目标页面元素的位置保持不变,可以配置透明度动画。目前,只有为重定向到目标页面而配置的静态效果才会生效。 | | Static | 目标页面元素的位置保持不变,可以配置透明度动画。目前,只有为重定向到目标页面而配置的静态效果才会生效。 |
...@@ -458,8 +442,6 @@ ...@@ -458,8 +442,6 @@
## ResponseType<sup>8+</sup> ## ResponseType<sup>8+</sup>
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ---------- | -------------------------- | | ---------- | -------------------------- |
| LongPress | 通过长按触发菜单弹出。 | | LongPress | 通过长按触发菜单弹出。 |
...@@ -467,8 +449,6 @@ ...@@ -467,8 +449,6 @@
## HoverEffect<sup>8+</sup> ## HoverEffect<sup>8+</sup>
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| --------- | ---------------------------- | | --------- | ---------------------------- |
| Auto | 使用组件的系统默认悬浮效果。 | | Auto | 使用组件的系统默认悬浮效果。 |
...@@ -478,8 +458,6 @@ ...@@ -478,8 +458,6 @@
## Placement<sup>8+</sup> ## Placement<sup>8+</sup>
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ------------- | ------------------------------------------------------------ | | ------------- | ------------------------------------------------------------ |
| Left | 气泡提示位于组件左侧,与组件左侧中心对齐。 | | Left | 气泡提示位于组件左侧,与组件左侧中心对齐。 |
...@@ -507,8 +485,6 @@ ...@@ -507,8 +485,6 @@
## HitTestMode<sup>9+</sup> ## HitTestMode<sup>9+</sup>
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 名称 | 描述 | | 名称 | 描述 |
| ----------- | -------------------- | | ----------- | -------------------- |
| Default | 自身节点和子节点都响应触摸事件的命中测试,但会阻止被该节点屏蔽的其他节点的命中测试。 | | Default | 自身节点和子节点都响应触摸事件的命中测试,但会阻止被该节点屏蔽的其他节点的命中测试。 |
......
...@@ -12,6 +12,8 @@ ...@@ -12,6 +12,8 @@
CanvasRenderingContext2D(setting: RenderingContextSetting) CanvasRenderingContext2D(setting: RenderingContextSetting)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 | | 参数名 | 参数类型 | 必填 | 参数描述 |
...@@ -25,6 +27,8 @@ RenderingContextSettings(antialias?: boolean) ...@@ -25,6 +27,8 @@ RenderingContextSettings(antialias?: boolean)
用来配置CanvasRenderingContext2D对象的参数,包括是否开启抗锯齿。 用来配置CanvasRenderingContext2D对象的参数,包括是否开启抗锯齿。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 | | 参数名 | 参数类型 | 必填 | 参数描述 |
...@@ -36,23 +40,23 @@ RenderingContextSettings(antialias?: boolean) ...@@ -36,23 +40,23 @@ RenderingContextSettings(antialias?: boolean)
| 名称 | 类型 | 描述 | | 名称 | 类型 | 描述 |
| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [fillStyle](#fillstyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 指定绘制的填充色。<br/>-&nbsp;类型为string时,表示设置填充区域的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。 | | [fillStyle](#fillstyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 指定绘制的填充色。<br/>-&nbsp;类型为string时,表示设置填充区域的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 | | [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 |
| [strokeStyle](#strokestyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 设置描边的颜色。<br/>-&nbsp;类型为string时,表示设置描边使用的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。 | | [strokeStyle](#strokestyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 设置描边的颜色。<br/>-&nbsp;类型为string时,表示设置描边使用的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式,可选值为:<br/>-&nbsp;'butt':线端点以方形结束。<br/>-&nbsp;'round':线端点以圆形结束。<br/>-&nbsp;'square':线端点以方形结束,该样式下会增加一个长度和线段厚度相同,宽度是线段厚度一半的矩形。<br/>默认值:'butt' | | [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式,可选值为:<br/>-&nbsp;'butt':线端点以方形结束。<br/>-&nbsp;'round':线端点以圆形结束。<br/>-&nbsp;'square':线端点以方形结束,该样式下会增加一个长度和线段厚度相同,宽度是线段厚度一半的矩形。<br/>默认值:'butt'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式,可选值为:<br/>-&nbsp;'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。<br/>-&nbsp;'bevel':在线段相连处使用三角形为底填充,&nbsp;每个部分矩形拐角独立。<br/>-&nbsp;'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。<br/>默认值:'miter' | | [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式,可选值为:<br/>-&nbsp;'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。<br/>-&nbsp;'bevel':在线段相连处使用三角形为底填充,&nbsp;每个部分矩形拐角独立。<br/>-&nbsp;'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。<br/>默认值:'miter'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [miterLimit](#miterlimit) | number | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 <br/>默认值:10 | | [miterLimit](#miterlimit) | number | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 <br/>默认值:10<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [font](#font) | string | 设置文本绘制中的字体样式。<br/>语法:ctx.font='font-size&nbsp;font-family'<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列。<br/>语法:ctx.font='font-style&nbsp;font-weight&nbsp;font-size&nbsp;font-family'<br/>-&nbsp;font-style(可选),用于指定字体样式,支持如下几种样式:'normal','italic'。<br/>-&nbsp;font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal',&nbsp;'bold',&nbsp;'bolder',&nbsp;'lighter',&nbsp;100,&nbsp;200,&nbsp;300,&nbsp;400,&nbsp;500,&nbsp;600,&nbsp;700,&nbsp;800,&nbsp;900。<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列,支持如下几种类型:'sans-serif',&nbsp;'serif',&nbsp;'monospace'。<br/>默认值:'normal normal 14px sans-serif' | | [font](#font) | string | 设置文本绘制中的字体样式。<br/>语法:ctx.font='font-size&nbsp;font-family'<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列。<br/>语法:ctx.font='font-style&nbsp;font-weight&nbsp;font-size&nbsp;font-family'<br/>-&nbsp;font-style(可选),用于指定字体样式,支持如下几种样式:'normal','italic'。<br/>-&nbsp;font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal',&nbsp;'bold',&nbsp;'bolder',&nbsp;'lighter',&nbsp;100,&nbsp;200,&nbsp;300,&nbsp;400,&nbsp;500,&nbsp;600,&nbsp;700,&nbsp;800,&nbsp;900。<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列,支持如下几种类型:'sans-serif',&nbsp;'serif',&nbsp;'monospace'。<br/>默认值:'normal normal 14px sans-serif'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式,可选值为:<br/>-&nbsp;'left':文本左对齐。<br/>-&nbsp;'right':文本右对齐。<br/>-&nbsp;'center':文本居中对齐。<br/>-&nbsp;'start':文本对齐界线开始的地方。<br/>-&nbsp;'end':文本对齐界线结束的地方。<br/>ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。<br/>默认值:'left' | | [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式,可选值为:<br/>-&nbsp;'left':文本左对齐。<br/>-&nbsp;'right':文本右对齐。<br/>-&nbsp;'center':文本居中对齐。<br/>-&nbsp;'start':文本对齐界线开始的地方。<br/>-&nbsp;'end':文本对齐界线结束的地方。<br/>ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。<br/>默认值:'left'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式,可选值为:<br/>-&nbsp;'alphabetic':文本基线是标准的字母基线。<br/>-&nbsp;'top':文本基线在文本块的顶部。<br/>-&nbsp;'hanging':文本基线是悬挂基线。<br/>-&nbsp;'middle':文本基线在文本块的中间。<br/>-&nbsp;'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。<br/>-&nbsp;'bottom':文本基线在文本块的底部。&nbsp;与ideographic基线的区别在于ideographic基线不需要考虑下行字母。<br/>默认值:'alphabetic' | | [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式,可选值为:<br/>-&nbsp;'alphabetic':文本基线是标准的字母基线。<br/>-&nbsp;'top':文本基线在文本块的顶部。<br/>-&nbsp;'hanging':文本基线是悬挂基线。<br/>-&nbsp;'middle':文本基线在文本块的中间。<br/>-&nbsp;'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。<br/>-&nbsp;'bottom':文本基线在文本块的底部。&nbsp;与ideographic基线的区别在于ideographic基线不需要考虑下行字母。<br/>默认值:'alphabetic'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [globalAlpha](#globalalpha) | number | 设置透明度,0.0为完全透明,1.0为完全不透明。 | | [globalAlpha](#globalalpha) | number | 设置透明度,0.0为完全透明,1.0为完全不透明。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量,精度为float。 <br/>默认值:0.0 | | [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量,精度为float。 <br/>默认值:0.0<br/>从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'。<br/>默认值:'source-over' | | [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over','source-atop','source-in','source-out','destination-over','destination-atop','destination-in','destination-out','lighter','copy','xor'。<br/>默认值:'source-over'<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别,值越大越模糊,精度为float。 <br/>默认值:0.0 | | [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别,值越大越模糊,精度为float。 <br/>默认值:0.0<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。 | | [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。 | | [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。 | | [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 <br/>默认值:true | | [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 <br/>默认值:true<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
> **说明:** > **说明:**
> >
...@@ -657,6 +661,8 @@ fillRect(x: number, y: number, w: number, h: number): void ...@@ -657,6 +661,8 @@ fillRect(x: number, y: number, w: number, h: number): void
填充一个矩形。 填充一个矩形。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -701,6 +707,8 @@ strokeRect(x: number, y: number, w: number, h: number): void ...@@ -701,6 +707,8 @@ strokeRect(x: number, y: number, w: number, h: number): void
绘制具有边框的矩形,矩形内部不填充。 绘制具有边框的矩形,矩形内部不填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -745,6 +753,8 @@ clearRect(x: number, y: number, w: number, h: number): void ...@@ -745,6 +753,8 @@ clearRect(x: number, y: number, w: number, h: number): void
删除指定区域内的绘制内容。 删除指定区域内的绘制内容。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -791,6 +801,8 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void ...@@ -791,6 +801,8 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void
绘制填充类文本。 绘制填充类文本。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -836,6 +848,8 @@ strokeText(text: string, x: number, y: number, maxWidth?:number): void ...@@ -836,6 +848,8 @@ strokeText(text: string, x: number, y: number, maxWidth?:number): void
绘制描边类文本。 绘制描边类文本。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -881,6 +895,8 @@ measureText(text: string): TextMetrics ...@@ -881,6 +895,8 @@ measureText(text: string): TextMetrics
该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。 该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -889,9 +905,9 @@ measureText(text: string): TextMetrics ...@@ -889,9 +905,9 @@ measureText(text: string): TextMetrics
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | ---------------- | | ----------- | ------------------------------------------------------------ |
| TextMetrics | 文本的尺寸信息。 | | TextMetrics | 文本的尺寸信息。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
**TextMetrics类型描述:** **TextMetrics类型描述:**
...@@ -951,6 +967,8 @@ stroke(path?: Path2D): void ...@@ -951,6 +967,8 @@ stroke(path?: Path2D): void
进行边框绘制操作。 进行边框绘制操作。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -997,6 +1015,8 @@ beginPath(): void ...@@ -997,6 +1015,8 @@ beginPath(): void
创建一个新的绘制路径。 创建一个新的绘制路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -1037,6 +1057,8 @@ moveTo(x: number, y: number): void ...@@ -1037,6 +1057,8 @@ moveTo(x: number, y: number): void
路径从当前点移动到指定点。 路径从当前点移动到指定点。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1082,6 +1104,8 @@ lineTo(x: number, y: number): void ...@@ -1082,6 +1104,8 @@ lineTo(x: number, y: number): void
从当前点到指定点进行路径连接。 从当前点到指定点进行路径连接。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1127,6 +1151,8 @@ closePath(): void ...@@ -1127,6 +1151,8 @@ closePath(): void
结束当前路径形成一个封闭路径。 结束当前路径形成一个封闭路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -1167,6 +1193,8 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu ...@@ -1167,6 +1193,8 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu
通过指定图像和重复方式创建图片填充的模板。 通过指定图像和重复方式创建图片填充的模板。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 描述 | | 参数 | 类型 | 必填 | 描述 |
...@@ -1218,6 +1246,8 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, ...@@ -1218,6 +1246,8 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number,
创建三次贝赛尔曲线的路径。 创建三次贝赛尔曲线的路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1267,6 +1297,8 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void ...@@ -1267,6 +1297,8 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void
创建二次贝赛尔曲线的路径。 创建二次贝赛尔曲线的路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1314,6 +1346,8 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, ...@@ -1314,6 +1346,8 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number,
绘制弧线路径。 绘制弧线路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1362,6 +1396,8 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void ...@@ -1362,6 +1396,8 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void
依据圆弧经过的点和圆弧半径创建圆弧路径。 依据圆弧经过的点和圆弧半径创建圆弧路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1409,6 +1445,8 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number ...@@ -1409,6 +1445,8 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number
在规定的矩形区域绘制一个椭圆。 在规定的矩形区域绘制一个椭圆。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1459,6 +1497,8 @@ rect(x: number, y: number, w: number, h: number): void ...@@ -1459,6 +1497,8 @@ rect(x: number, y: number, w: number, h: number): void
创建矩形路径。 创建矩形路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1504,6 +1544,8 @@ fill(fillRule?: CanvasFillRule): void ...@@ -1504,6 +1544,8 @@ fill(fillRule?: CanvasFillRule): void
对封闭路径进行填充。 对封闭路径进行填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1545,6 +1587,8 @@ fill(path: Path2D, fillRule?: CanvasFillRule): void ...@@ -1545,6 +1587,8 @@ fill(path: Path2D, fillRule?: CanvasFillRule): void
对封闭路径进行填充。 对封闭路径进行填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1598,6 +1642,8 @@ clip(fillRule?: CanvasFillRule): void ...@@ -1598,6 +1642,8 @@ clip(fillRule?: CanvasFillRule): void
设置当前路径为剪切路径。 设置当前路径为剪切路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1641,6 +1687,8 @@ clip(path: Path2D, fillRule?: CanvasFillRule): void ...@@ -1641,6 +1687,8 @@ clip(path: Path2D, fillRule?: CanvasFillRule): void
设置当前路径为剪切路径 设置当前路径为剪切路径
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1693,6 +1741,8 @@ filter(filter: string): void ...@@ -1693,6 +1741,8 @@ filter(filter: string): void
为Canvas图形设置各类滤镜效果。该接口为空接口。 为Canvas图形设置各类滤镜效果。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1706,6 +1756,8 @@ getTransform(): Matrix2D ...@@ -1706,6 +1756,8 @@ getTransform(): Matrix2D
获取当前被应用到上下文的转换矩阵。该接口为空接口。 获取当前被应用到上下文的转换矩阵。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### resetTransform ### resetTransform
...@@ -1713,6 +1765,8 @@ resetTransform(): void ...@@ -1713,6 +1765,8 @@ resetTransform(): void
使用单位矩阵重新设置当前变形。该接口为空接口。 使用单位矩阵重新设置当前变形。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### direction ### direction
...@@ -1720,6 +1774,8 @@ direction(direction: CanvasDirection): void ...@@ -1720,6 +1774,8 @@ direction(direction: CanvasDirection): void
绘制文本时,描述当前文本方向的属性。该接口为空接口。 绘制文本时,描述当前文本方向的属性。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### rotate ### rotate
...@@ -1727,6 +1783,8 @@ rotate(angle: number): void ...@@ -1727,6 +1783,8 @@ rotate(angle: number): void
针对当前坐标轴进行顺时针旋转。 针对当前坐标轴进行顺时针旋转。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1769,6 +1827,8 @@ scale(x: number, y: number): void ...@@ -1769,6 +1827,8 @@ scale(x: number, y: number): void
设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。 设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1814,6 +1874,8 @@ transform(a: number, b: number, c: number, d: number, e: number, f: number): voi ...@@ -1814,6 +1874,8 @@ transform(a: number, b: number, c: number, d: number, e: number, f: number): voi
transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。 transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。
从API version 9开始,该接口支持在ArkTS卡片中使用。
> **说明:** > **说明:**
> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标): > 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标):
> >
...@@ -1874,6 +1936,8 @@ setTransform(a: number, b: number, c: number, d: number, e: number, f: number): ...@@ -1874,6 +1936,8 @@ setTransform(a: number, b: number, c: number, d: number, e: number, f: number):
setTransform方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 setTransform方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1931,6 +1995,8 @@ translate(x: number, y: number): void ...@@ -1931,6 +1995,8 @@ translate(x: number, y: number): void
移动当前坐标系的原点。 移动当前坐标系的原点。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1979,7 +2045,7 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh: ...@@ -1979,7 +2045,7 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh:
进行图像绘制。 进行图像绘制。
从API version 9开始,该接口支持在ArkTS卡片中使用。 从API version 9开始,该接口支持在ArkTS卡片中使用,卡片中不支持PixelMap对象
**参数:** **参数:**
...@@ -2032,6 +2098,8 @@ createImageData(sw: number, sh: number): ImageData ...@@ -2032,6 +2098,8 @@ createImageData(sw: number, sh: number): ImageData
创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md) 创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认 | 描述 | | 参数 | 类型 | 必填 | 默认 | 描述 |
...@@ -2044,6 +2112,8 @@ createImageData(imageData: ImageData): ImageData ...@@ -2044,6 +2112,8 @@ createImageData(imageData: ImageData): ImageData
创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md) 创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagedata.md)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认 | 描述 | | 参数 | 类型 | 必填 | 默认 | 描述 |
...@@ -2084,6 +2154,8 @@ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData ...@@ -2084,6 +2154,8 @@ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData
以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagedata.md)对象。 以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagedata.md)对象。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2140,6 +2212,8 @@ putImageData(imageData: ImageData, dx: number, dy: number, dirtyX: number, dirty ...@@ -2140,6 +2212,8 @@ putImageData(imageData: ImageData, dx: number, dy: number, dirtyX: number, dirty
使用[ImageData](ts-components-canvas-imagedata.md)数据填充新的矩形区域。 使用[ImageData](ts-components-canvas-imagedata.md)数据填充新的矩形区域。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2194,6 +2268,8 @@ setLineDash(segments: number[]): void ...@@ -2194,6 +2268,8 @@ setLineDash(segments: number[]): void
设置画布的虚线样式。 设置画布的虚线样式。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 描述 | | 参数 | 类型 | 描述 |
...@@ -2237,6 +2313,8 @@ getLineDash(): number[] ...@@ -2237,6 +2313,8 @@ getLineDash(): number[]
获得当前画布的虚线样式。 获得当前画布的虚线样式。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -2293,6 +2371,8 @@ imageSmoothingQuality(quality: imageSmoothingQuality) ...@@ -2293,6 +2371,8 @@ imageSmoothingQuality(quality: imageSmoothingQuality)
用于设置图像平滑度。该接口为空接口。 用于设置图像平滑度。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 描述 | | 参数 | 类型 | 描述 |
...@@ -2307,6 +2387,8 @@ transferFromImageBitmap(bitmap: ImageBitmap): void ...@@ -2307,6 +2387,8 @@ transferFromImageBitmap(bitmap: ImageBitmap): void
显示给定的ImageBitmap对象。 显示给定的ImageBitmap对象。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 描述 | | 参数 | 类型 | 描述 |
...@@ -2405,6 +2487,8 @@ restore(): void ...@@ -2405,6 +2487,8 @@ restore(): void
对保存的绘图上下文进行恢复。 对保存的绘图上下文进行恢复。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -2443,6 +2527,8 @@ save(): void ...@@ -2443,6 +2527,8 @@ save(): void
将当前状态放入栈中,保存canvas的全部状态,通常在需要保存绘制状态时调用。 将当前状态放入栈中,保存canvas的全部状态,通常在需要保存绘制状态时调用。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -2481,6 +2567,8 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void ...@@ -2481,6 +2567,8 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void
创建一个线性渐变色。 创建一个线性渐变色。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2530,6 +2618,8 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, ...@@ -2530,6 +2618,8 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number,
创建一个径向渐变色。 创建一个径向渐变色。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2623,4 +2713,6 @@ struct CanvasExample { ...@@ -2623,4 +2713,6 @@ struct CanvasExample {
## CanvasPattern ## CanvasPattern
一个Object对象, 通过[createPattern](#createpattern)方法创建。 一个Object对象, 通过[createPattern](#createpattern)方法创建。
\ No newline at end of file
从API version 9开始,该接口支持在ArkTS卡片中使用。
\ No newline at end of file
...@@ -88,6 +88,8 @@ onLayout?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions) ...@@ -88,6 +88,8 @@ onLayout?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions)
框架会在自定义组件布局时,将该自定义组件的子节点信息和自身的尺寸范围通过onLayout传递给该自定义组件。不允许在onLayout函数中改变状态变量。 框架会在自定义组件布局时,将该自定义组件的子节点信息和自身的尺寸范围通过onLayout传递给该自定义组件。不允许在onLayout函数中改变状态变量。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
...@@ -102,6 +104,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions ...@@ -102,6 +104,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions
框架会在自定义组件确定尺寸时,将该自定义组件的子节点信息和自身的尺寸范围通过onMeasure传递给该自定义组件。不允许在onMeasure函数中改变状态变量。 框架会在自定义组件确定尺寸时,将该自定义组件的子节点信息和自身的尺寸范围通过onMeasure传递给该自定义组件。不允许在onMeasure函数中改变状态变量。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
...@@ -114,6 +118,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions ...@@ -114,6 +118,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions
子组件布局信息。 子组件布局信息。
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 参数 | 参数类型 | 描述 | | 参数 | 参数类型 | 描述 |
| ---------- | ---------------------------------------- | ------------------- | | ---------- | ---------------------------------------- | ------------------- |
| name | string | 子组件名称。 | | name | string | 子组件名称。 |
...@@ -129,6 +135,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions ...@@ -129,6 +135,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions
子组件border信息。 子组件border信息。
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 参数 | 参数类型 | 描述 | | 参数 | 参数类型 | 描述 |
| ----------- | ------------------------------------ | ----------------------- | | ----------- | ------------------------------------ | ----------------------- |
| borderWidth | [EdgeWidths](ts-types.md#edgewidths) | 边框宽度类型,用于描述组件边框不同方向的宽度。 | | borderWidth | [EdgeWidths](ts-types.md#edgewidths) | 边框宽度类型,用于描述组件边框不同方向的宽度。 |
...@@ -140,6 +148,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions ...@@ -140,6 +148,8 @@ onMeasure?(children: Array&lt;LayoutChild&gt;, constraint: ConstraintSizeOptions
子组件layout信息。 子组件layout信息。
从API version 9开始,该接口支持在ArkTS卡片中使用。
| 参数 | 参数类型 | 描述 | | 参数 | 参数类型 | 描述 |
| ---------- | ---------------------------------------- | -------- | | ---------- | ---------------------------------------- | -------- |
| position | [Position](ts-types.md#position) | 子组件位置坐标。 | | position | [Position](ts-types.md#position) | 子组件位置坐标。 |
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
Shape(value?: PixelMap) Shape(value?: PixelMap)
从API version 9开始,该接口支持在ArkTS卡片中使用。 从API version 9开始,该接口支持在ArkTS卡片中使用,卡片中不支持使用PixelMap对象
**参数:** **参数:**
...@@ -52,8 +52,6 @@ Shape(value?: PixelMap) ...@@ -52,8 +52,6 @@ Shape(value?: PixelMap)
## 示例 ## 示例
### 示例1
```ts ```ts
// xxx.ets // xxx.ets
@Entry @Entry
......
...@@ -12,6 +12,8 @@ ...@@ -12,6 +12,8 @@
OffscreenCanvasRenderingContext2D(width: number, height: number, setting: RenderingContextSettings) OffscreenCanvasRenderingContext2D(width: number, height: number, setting: RenderingContextSettings)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 | | 参数名 | 参数类型 | 必填 | 参数描述 |
...@@ -25,23 +27,23 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, setting: Render ...@@ -25,23 +27,23 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, setting: Render
| 名称 | 类型 | 描述 | | 名称 | 类型 | 描述 |
| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [fillStyle](#fillstyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 指定绘制的填充色。<br/>-&nbsp;类型为string时,表示设置填充区域的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。 | | [fillStyle](#fillstyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 指定绘制的填充色。<br/>-&nbsp;类型为string时,表示设置填充区域的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 | | [lineWidth](#linewidth) | number | 设置绘制线条的宽度。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [strokeStyle](#strokestyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 设置描边的颜色。<br/>-&nbsp;类型为string时,表示设置描边使用的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。 | | [strokeStyle](#strokestyle) | string&nbsp;\|&nbsp;[CanvasGradient](ts-components-canvas-canvasgradient.md)&nbsp;\|&nbsp;[CanvasPattern](#canvaspattern) | 设置描边的颜色。<br/>-&nbsp;类型为string时,表示设置描边使用的颜色。<br/>-&nbsp;类型为CanvasGradient时,表示渐变对象,使用[createLinearGradient](#createlineargradient)方法创建。<br/>-&nbsp;类型为CanvasPattern时,使用[createPattern](#createpattern)方法创建。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式,可选值为:<br/>-&nbsp;'butt':线端点以方形结束。<br/>-&nbsp;'round':线端点以圆形结束。<br/>-&nbsp;'square':线端点以方形结束,该样式下会增加一个长度和线段厚度相同,宽度是线段厚度一半的矩形。<br/>-&nbsp;默认值:'butt'。 | | [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式,可选值为:<br/>-&nbsp;'butt':线端点以方形结束。<br/>-&nbsp;'round':线端点以圆形结束。<br/>-&nbsp;'square':线端点以方形结束,该样式下会增加一个长度和线段厚度相同,宽度是线段厚度一半的矩形。<br/>-&nbsp;默认值:'butt'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式,可选值为:<br/>-&nbsp;'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。<br/>-&nbsp;'bevel':在线段相连处使用三角形为底填充,&nbsp;每个部分矩形拐角独立。<br/>-&nbsp;'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。<br/>-&nbsp;默认值:'miter'。 | | [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式,可选值为:<br/>-&nbsp;'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。<br/>-&nbsp;'bevel':在线段相连处使用三角形为底填充,&nbsp;每个部分矩形拐角独立。<br/>-&nbsp;'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。<br/>-&nbsp;默认值:'miter'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [miterLimit](#miterlimit) | number | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 <br/>-&nbsp;默认值:10。 | | [miterLimit](#miterlimit) | number | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 <br/>-&nbsp;默认值:10。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [font](#font) | string | 设置文本绘制中的字体样式。<br/>语法:ctx.font='font-size&nbsp;font-family'<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列。<br/>语法:ctx.font='font-style&nbsp;font-weight&nbsp;font-size&nbsp;font-family'<br/>-&nbsp;font-style(可选),用于指定字体样式,支持如下几种样式:'normal','italic'。<br/>-&nbsp;font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal',&nbsp;'bold',&nbsp;'bolder',&nbsp;'lighter',&nbsp;100,&nbsp;200,&nbsp;300,&nbsp;400,&nbsp;500,&nbsp;600,&nbsp;700,&nbsp;800,&nbsp;900。<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列,支持如下几种类型:'sans-serif',&nbsp;'serif',&nbsp;'monospace'。<br/>-&nbsp;默认值:'normal normal 14px sans-serif'。 | | [font](#font) | string | 设置文本绘制中的字体样式。<br/>语法:ctx.font='font-size&nbsp;font-family'<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列。<br/>语法:ctx.font='font-style&nbsp;font-weight&nbsp;font-size&nbsp;font-family'<br/>-&nbsp;font-style(可选),用于指定字体样式,支持如下几种样式:'normal','italic'。<br/>-&nbsp;font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal',&nbsp;'bold',&nbsp;'bolder',&nbsp;'lighter',&nbsp;100,&nbsp;200,&nbsp;300,&nbsp;400,&nbsp;500,&nbsp;600,&nbsp;700,&nbsp;800,&nbsp;900。<br/>-&nbsp;font-size(可选),指定字号和行高,单位只支持px。<br/>-&nbsp;font-family(可选),指定字体系列,支持如下几种类型:'sans-serif',&nbsp;'serif',&nbsp;'monospace'。<br/>-&nbsp;默认值:'normal normal 14px sans-serif'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式,可选值为:<br/>-&nbsp;'left':文本左对齐。<br/>-&nbsp;'right':文本右对齐。<br/>-&nbsp;'center':文本居中对齐。<br/>-&nbsp;'start':文本对齐界线开始的地方。<br/>-&nbsp;'end':文本对齐界线结束的地方。<br/>> **说明:**<br/>>&nbsp;ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。<br/>-&nbsp;默认值:'left'。 | | [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式,可选值为:<br/>-&nbsp;'left':文本左对齐。<br/>-&nbsp;'right':文本右对齐。<br/>-&nbsp;'center':文本居中对齐。<br/>-&nbsp;'start':文本对齐界线开始的地方。<br/>-&nbsp;'end':文本对齐界线结束的地方。<br/>> **说明:**<br/>>&nbsp;ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。<br/>-&nbsp;默认值:'left'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式,可选值为:<br/>-&nbsp;'alphabetic':文本基线是标准的字母基线。<br/>-&nbsp;'top':文本基线在文本块的顶部。<br/>-&nbsp;'hanging':文本基线是悬挂基线。<br/>-&nbsp;'middle':文本基线在文本块的中间。<br/>-&nbsp;'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。<br/>-&nbsp;'bottom':文本基线在文本块的底部。&nbsp;与ideographic基线的区别在于ideographic基线不需要考虑下行字母。<br/>-&nbsp;默认值:'alphabetic'。 | | [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式,可选值为:<br/>-&nbsp;'alphabetic':文本基线是标准的字母基线。<br/>-&nbsp;'top':文本基线在文本块的顶部。<br/>-&nbsp;'hanging':文本基线是悬挂基线。<br/>-&nbsp;'middle':文本基线在文本块的中间。<br/>-&nbsp;'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。<br/>-&nbsp;'bottom':文本基线在文本块的底部。&nbsp;与ideographic基线的区别在于ideographic基线不需要考虑下行字母。<br/>-&nbsp;默认值:'alphabetic'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [globalAlpha](#globalalpha) | number | 设置透明度,0.0为完全透明,1.0为完全不透明。 | | [globalAlpha](#globalalpha) | number | 设置透明度,0.0为完全透明,1.0为完全不透明。 |
| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量,精度为float。 <br/>-&nbsp;默认值:0.0。 | | [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量,精度为float。 <br/>-&nbsp;默认值:0.0。<br/>从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'。<br/>-&nbsp;默认值:'source-over'。 | | [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over','source-atop','source-in','source-out','destination-over','destination-atop','destination-in','destination-out','lighter','copy','xor'。<br/>-&nbsp;默认值:'source-over'。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别,值越大越模糊,精度为float。 <br/>-&nbsp;默认值:0.0。 | | [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别,值越大越模糊,精度为float。 <br/>-&nbsp;默认值:0.0。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。 | | [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。 | | [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。 | | [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 <br/>-&nbsp;默认值:true。 | | [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 <br/>-&nbsp;默认值:true。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
> **说明:** > **说明:**
> fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。 > fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。
...@@ -700,6 +702,8 @@ fillRect(x: number, y: number, w: number, h: number): void ...@@ -700,6 +702,8 @@ fillRect(x: number, y: number, w: number, h: number): void
填充一个矩形。 填充一个矩形。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -747,6 +751,8 @@ strokeRect(x: number, y: number, w: number, h: number): void ...@@ -747,6 +751,8 @@ strokeRect(x: number, y: number, w: number, h: number): void
绘制具有边框的矩形,矩形内部不填充。 绘制具有边框的矩形,矩形内部不填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -794,6 +800,8 @@ clearRect(x: number, y: number, w: number, h: number): void ...@@ -794,6 +800,8 @@ clearRect(x: number, y: number, w: number, h: number): void
删除指定区域内的绘制内容。 删除指定区域内的绘制内容。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -843,6 +851,8 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void ...@@ -843,6 +851,8 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void
绘制填充类文本。 绘制填充类文本。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -891,6 +901,8 @@ strokeText(text: string, x: number, y: number): void ...@@ -891,6 +901,8 @@ strokeText(text: string, x: number, y: number): void
绘制描边类文本。 绘制描边类文本。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -939,6 +951,8 @@ measureText(text: string): TextMetrics ...@@ -939,6 +951,8 @@ measureText(text: string): TextMetrics
该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。 该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -947,9 +961,9 @@ measureText(text: string): TextMetrics ...@@ -947,9 +961,9 @@ measureText(text: string): TextMetrics
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | ------- | | ----------- | ------------------------------------------------------------ |
| TextMetrics | 文本的尺寸信息 | | TextMetrics | 文本的尺寸信息<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
**TextMetrics类型描述:** **TextMetrics类型描述:**
...@@ -1009,6 +1023,8 @@ stroke(path?: Path2D): void ...@@ -1009,6 +1023,8 @@ stroke(path?: Path2D): void
进行边框绘制操作。 进行边框绘制操作。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1058,6 +1074,8 @@ beginPath(): void ...@@ -1058,6 +1074,8 @@ beginPath(): void
创建一个新的绘制路径。 创建一个新的绘制路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -1101,6 +1119,8 @@ moveTo(x: number, y: number): void ...@@ -1101,6 +1119,8 @@ moveTo(x: number, y: number): void
路径从当前点移动到指定点。 路径从当前点移动到指定点。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1149,6 +1169,8 @@ lineTo(x: number, y: number): void ...@@ -1149,6 +1169,8 @@ lineTo(x: number, y: number): void
从当前点到指定点进行路径连接。 从当前点到指定点进行路径连接。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1197,6 +1219,8 @@ closePath(): void ...@@ -1197,6 +1219,8 @@ closePath(): void
结束当前路径形成一个封闭路径。 结束当前路径形成一个封闭路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -1240,6 +1264,8 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu ...@@ -1240,6 +1264,8 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu
通过指定图像和重复方式创建图片填充的模板。 通过指定图像和重复方式创建图片填充的模板。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1294,6 +1320,8 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, ...@@ -1294,6 +1320,8 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number,
创建三次贝赛尔曲线的路径。 创建三次贝赛尔曲线的路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1346,6 +1374,8 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void ...@@ -1346,6 +1374,8 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void
创建二次贝赛尔曲线的路径。 创建二次贝赛尔曲线的路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1396,6 +1426,8 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, ...@@ -1396,6 +1426,8 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number,
绘制弧线路径。 绘制弧线路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1447,6 +1479,8 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void ...@@ -1447,6 +1479,8 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void
依据圆弧经过的点和圆弧半径创建圆弧路径。 依据圆弧经过的点和圆弧半径创建圆弧路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1497,6 +1531,8 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number ...@@ -1497,6 +1531,8 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number
在规定的矩形区域绘制一个椭圆。 在规定的矩形区域绘制一个椭圆。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1549,6 +1585,8 @@ rect(x: number, y: number, w: number, h: number): void ...@@ -1549,6 +1585,8 @@ rect(x: number, y: number, w: number, h: number): void
创建矩形路径。 创建矩形路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1597,6 +1635,8 @@ fill(fillRule?: CanvasFillRule): void ...@@ -1597,6 +1635,8 @@ fill(fillRule?: CanvasFillRule): void
对封闭路径进行填充。 对封闭路径进行填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1638,6 +1678,8 @@ fill(path: Path2D, fillRule?: CanvasFillRule): void ...@@ -1638,6 +1678,8 @@ fill(path: Path2D, fillRule?: CanvasFillRule): void
对封闭路径进行填充。 对封闭路径进行填充。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1695,6 +1737,8 @@ clip(fillRule?: CanvasFillRule): void ...@@ -1695,6 +1737,8 @@ clip(fillRule?: CanvasFillRule): void
设置当前路径为剪切路径。 设置当前路径为剪切路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1741,6 +1785,8 @@ clip(path:Path2D, fillRule?: CanvasFillRule): void ...@@ -1741,6 +1785,8 @@ clip(path:Path2D, fillRule?: CanvasFillRule): void
设置封闭路径为剪切路径。 设置封闭路径为剪切路径。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1797,6 +1843,8 @@ filter(filter: string): void ...@@ -1797,6 +1843,8 @@ filter(filter: string): void
为Canvas图形设置各类滤镜效果。该接口为空接口。 为Canvas图形设置各类滤镜效果。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 说明 | | 参数 | 类型 | 必填 | 默认值 | 说明 |
...@@ -1810,6 +1858,8 @@ getTransform(): Matrix2D ...@@ -1810,6 +1858,8 @@ getTransform(): Matrix2D
获取当前被应用到上下文的转换矩阵。该接口为空接口。 获取当前被应用到上下文的转换矩阵。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### resetTransform ### resetTransform
...@@ -1817,6 +1867,8 @@ resetTransform(): void ...@@ -1817,6 +1867,8 @@ resetTransform(): void
使用单位矩阵重新设置当前变形。该接口为空接口。 使用单位矩阵重新设置当前变形。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### direction ### direction
...@@ -1824,6 +1876,8 @@ direction(direction: CanvasDirection): void ...@@ -1824,6 +1876,8 @@ direction(direction: CanvasDirection): void
绘制文本时,描述当前文本方向的属性。该接口为空接口。 绘制文本时,描述当前文本方向的属性。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
### rotate ### rotate
...@@ -1831,6 +1885,8 @@ rotate(angle: number): void ...@@ -1831,6 +1885,8 @@ rotate(angle: number): void
针对当前坐标轴进行顺时针旋转。 针对当前坐标轴进行顺时针旋转。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1876,6 +1932,8 @@ scale(x: number, y: number): void ...@@ -1876,6 +1932,8 @@ scale(x: number, y: number): void
设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。 设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -1924,6 +1982,8 @@ transform(a: number, b: number, c: number, d: number, e: number, f: number): voi ...@@ -1924,6 +1982,8 @@ transform(a: number, b: number, c: number, d: number, e: number, f: number): voi
transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。 transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。
从API version 9开始,该接口支持在ArkTS卡片中使用。
> **说明:** > **说明:**
> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标): > 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标):
> >
...@@ -1987,6 +2047,8 @@ setTransform(a: number, b: number, c: number, d: number, e: number, f: number): ...@@ -1987,6 +2047,8 @@ setTransform(a: number, b: number, c: number, d: number, e: number, f: number):
setTransform方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 setTransform方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2040,6 +2102,8 @@ translate(x: number, y: number): void ...@@ -2040,6 +2102,8 @@ translate(x: number, y: number): void
移动当前坐标系的原点。 移动当前坐标系的原点。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2091,6 +2155,8 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh: ...@@ -2091,6 +2155,8 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh:
进行图像绘制。 进行图像绘制。
从API version 9开始,该接口支持在ArkTS卡片中使用,卡片中不支持PixelMap对象。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2144,6 +2210,8 @@ createImageData(sw: number, sh: number): ImageData ...@@ -2144,6 +2210,8 @@ createImageData(sw: number, sh: number): ImageData
根据宽高创建ImageData对象,请参考[ImageData](ts-components-canvas-imagedata.md) 根据宽高创建ImageData对象,请参考[ImageData](ts-components-canvas-imagedata.md)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认 | 描述 | | 参数 | 类型 | 必填 | 默认 | 描述 |
...@@ -2156,6 +2224,8 @@ createImageData(imageData: ImageData): ImageData ...@@ -2156,6 +2224,8 @@ createImageData(imageData: ImageData): ImageData
根据已创建的ImageData对象创建新的ImageData对象,请参考[ImageData](ts-components-canvas-imagedata.md) 根据已创建的ImageData对象创建新的ImageData对象,请参考[ImageData](ts-components-canvas-imagedata.md)
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认 | 描述 | | 参数 | 类型 | 必填 | 默认 | 描述 |
...@@ -2217,6 +2287,8 @@ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData ...@@ -2217,6 +2287,8 @@ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData
以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagedata.md)对象。 以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagedata.md)对象。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2276,6 +2348,8 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX: number, dirtyY: ...@@ -2276,6 +2348,8 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX: number, dirtyY:
使用[ImageData](ts-components-canvas-imagedata.md)数据填充新的矩形区域。 使用[ImageData](ts-components-canvas-imagedata.md)数据填充新的矩形区域。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2331,6 +2405,8 @@ setLineDash(segments: number[]): void ...@@ -2331,6 +2405,8 @@ setLineDash(segments: number[]): void
设置画布的虚线样式。 设置画布的虚线样式。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 描述 | | 参数 | 类型 | 描述 |
...@@ -2375,6 +2451,8 @@ getLineDash(): number[] ...@@ -2375,6 +2451,8 @@ getLineDash(): number[]
获得当前画布的虚线样式。 获得当前画布的虚线样式。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -2481,6 +2559,8 @@ imageSmoothingQuality(quality: imageSmoothingQuality) ...@@ -2481,6 +2559,8 @@ imageSmoothingQuality(quality: imageSmoothingQuality)
用于设置图像平滑度。该接口为空接口。 用于设置图像平滑度。该接口为空接口。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 描述 | | 参数 | 类型 | 描述 |
...@@ -2544,6 +2624,8 @@ restore(): void ...@@ -2544,6 +2624,8 @@ restore(): void
对保存的绘图上下文进行恢复。 对保存的绘图上下文进行恢复。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -2585,6 +2667,8 @@ save(): void ...@@ -2585,6 +2667,8 @@ save(): void
对当前的绘图上下文进行保存。 对当前的绘图上下文进行保存。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**示例:** **示例:**
```ts ```ts
...@@ -2626,6 +2710,8 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void ...@@ -2626,6 +2710,8 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void
创建一个线性渐变色。 创建一个线性渐变色。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2678,6 +2764,8 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, ...@@ -2678,6 +2764,8 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number,
创建一个径向渐变色。 创建一个径向渐变色。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
| 参数 | 类型 | 必填 | 默认值 | 描述 | | 参数 | 类型 | 必填 | 默认值 | 描述 |
...@@ -2779,3 +2867,5 @@ struct OffscreenCanvasConicGradientPage { ...@@ -2779,3 +2867,5 @@ struct OffscreenCanvasConicGradientPage {
## CanvasPattern ## CanvasPattern
一个Object对象, 通过[createPattern](#createpattern)方法创建。 一个Object对象, 通过[createPattern](#createpattern)方法创建。
从API version 9开始,该接口支持在ArkTS卡片中使用。
\ No newline at end of file
...@@ -752,6 +752,8 @@ abstract get(): T ...@@ -752,6 +752,8 @@ abstract get(): T
读取从AppStorage/LocalStorage同步属性的数据。 读取从AppStorage/LocalStorage同步属性的数据。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**返回值:** **返回值:**
| 类型 | 描述 | | 类型 | 描述 |
...@@ -770,9 +772,10 @@ prop1.get(); // prop1.get()=47 ...@@ -770,9 +772,10 @@ prop1.get(); // prop1.get()=47
abstract set(newValue: T): void abstract set(newValue: T): void
设置AppStorage/LocalStorage同步属性的数据。 设置AppStorage/LocalStorage同步属性的数据。
从API version 9开始,该接口支持在ArkTS卡片中使用。
**参数:** **参数:**
......
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
| ----------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | | ----------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ |
| blur | number | - | 为当前组件添加内容模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。<br/>取值范围:[0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | blur | number | - | 为当前组件添加内容模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。<br/>取值范围:[0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| backdropBlur | number | - | 为当前组件添加背景模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。<br/>取值范围:[0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | backdropBlur | number | - | 为当前组件添加背景模糊效果,入参为模糊半径,模糊半径越大越模糊,为0时不模糊。<br/>取值范围:[0, +∞)<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| shadow | [ShadowOptions](#shadowoptions对象说明) \| [ShadowStyle](#shadowstyle10枚举说明) | - | 为当前组件添加阴影效果。<br/>入参类型为ShadowOptions时,可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。<br/>入参类型为ShadowStyle时,可指定不同阴影样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用<br/>**说明:**<br/>ArkTS卡片上不支持参数为 [ShadowStyle](#shadowstyle10枚举说明)类型。 | | shadow | [ShadowOptions](#shadowoptions对象说明) \| [ShadowStyle](#shadowstyle10枚举说明) | - | 为当前组件添加阴影效果。<br/>入参类型为ShadowOptions时,可以指定模糊半径、阴影的颜色、X轴和Y轴的偏移量。<br/>入参类型为ShadowStyle时,可指定不同阴影样式。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用ArkTS卡片上不支持参数为 [ShadowStyle](#shadowstyle10枚举说明)类型。 |
| grayscale | number | 0.0 | 为当前组件添加灰度效果。值定义为灰度转换的比例,入参1.0则完全转为灰度图像,入参则0.0图像无变化,入参在0.0和1.0之间时,效果呈线性变化。(百分比)<br/>取值范围:[0, 1]<br/>**说明:** <br/>设置小于0的值时,按值为0处理,设置大于1的值时,按值为1处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | grayscale | number | 0.0 | 为当前组件添加灰度效果。值定义为灰度转换的比例,入参1.0则完全转为灰度图像,入参则0.0图像无变化,入参在0.0和1.0之间时,效果呈线性变化。(百分比)<br/>取值范围:[0, 1]<br/>**说明:** <br/>设置小于0的值时,按值为0处理,设置大于1的值时,按值为1处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| brightness | number | 1.0 | 为当前组件添加高光效果,入参为高光比例,值为1时没有效果,小于1时亮度变暗,0为全黑,大于1时亮度增加,数值越大亮度越大。<br/>取值范围:[0, +∞)<br/>**说明:** <br/>设置小于0的值时,按值为0处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | brightness | number | 1.0 | 为当前组件添加高光效果,入参为高光比例,值为1时没有效果,小于1时亮度变暗,0为全黑,大于1时亮度增加,数值越大亮度越大。<br/>取值范围:[0, +∞)<br/>**说明:** <br/>设置小于0的值时,按值为0处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| saturate | number | 1.0 | 为当前组件添加饱和度效果,饱和度为颜色中的含色成分和消色成分(灰)的比例,入参为1时,显示原图像,大于1时含色成分越大,饱和度越大,小于1时消色成分越大,饱和度越小。(百分比)<br/>取值范围:[0, +∞)<br/>**说明:** <br/>设置小于0的值时,按值为0处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 | | saturate | number | 1.0 | 为当前组件添加饱和度效果,饱和度为颜色中的含色成分和消色成分(灰)的比例,入参为1时,显示原图像,大于1时含色成分越大,饱和度越大,小于1时消色成分越大,饱和度越小。(百分比)<br/>取值范围:[0, +∞)<br/>**说明:** <br/>设置小于0的值时,按值为0处理。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
......
...@@ -13,13 +13,13 @@ ...@@ -13,13 +13,13 @@
| 名称 | 参数类型 | 描述 | | 名称 | 参数类型 | 描述 |
| -----------| ---------------------------------------- | ------------------------------------ | | -----------| ---------------------------------------- | ------------------------------------ |
| fontColor | [ResourceColor](ts-types.md#resourcecolor) | 设置字体颜色。 | | fontColor | [ResourceColor](ts-types.md#resourcecolor) | 设置字体颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| fontSize | [Length](ts-types.md#length) | 设置字体大小,Length为number类型时,使用fp单位。字体默认大小16。不支持设置百分比字符串。 | | fontSize | [Length](ts-types.md#length) | 设置字体大小,Length为number类型时,使用fp单位。字体默认大小16。不支持设置百分比字符串。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| fontStyle | [FontStyle](ts-appendix-enums.md#fontstyle) | 设置字体样式。<br>默认值:FontStyle.Normal | | fontStyle | [FontStyle](ts-appendix-enums.md#fontstyle) | 设置字体样式。<br>默认值:FontStyle.Normal<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| fontWeight | number&nbsp;\|&nbsp;[FontWeight](ts-appendix-enums.md#fontweight)&nbsp;\|&nbsp;string | 设置文本的字体粗细,number类型取值[100,&nbsp;900],取值间隔为100,默认为400,取值越大,字体越粗。string类型仅支持number类型取值的字符串形式,例如"400",以及"bold"、"bolder"、"lighter"、"regular"、"medium",分别对应FontWeight中相应的枚举值。<br/>默认值:FontWeight.Normal | | fontWeight | number&nbsp;\|&nbsp;[FontWeight](ts-appendix-enums.md#fontweight)&nbsp;\|&nbsp;string | 设置文本的字体粗细,number类型取值[100,&nbsp;900],取值间隔为100,默认为400,取值越大,字体越粗。string类型仅支持number类型取值的字符串形式,例如"400",以及"bold"、"bolder"、"lighter"、"regular"、"medium",分别对应FontWeight中相应的枚举值。<br/>默认值:FontWeight.Normal<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| fontFamily | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 设置字体列表。默认字体'HarmonyOS Sans',且当前只支持这种字体。| | fontFamily | string&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 设置字体列表。默认字体'HarmonyOS Sans',且当前只支持这种字体。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| lineHeight | string&nbsp;\|&nbsp;number&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。 | | lineHeight | string&nbsp;\|&nbsp;number&nbsp;\|&nbsp;[Resource](ts-types.md#resource) | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| decoration | {<br/>type:&nbsp;[TextDecorationType](ts-appendix-enums.md#textdecorationtype),<br/>color?:&nbsp;[ResourceColor](ts-types.md#resourcecolor)<br/>} | 设置文本装饰线样式及其颜色。<br />默认值:{<br/>type:&nbsp;TextDecorationType.None,<br/>color:Color.Black<br/>} | | decoration | {<br/>type:&nbsp;[TextDecorationType](ts-appendix-enums.md#textdecorationtype),<br/>color?:&nbsp;[ResourceColor](ts-types.md#resourcecolor)<br/>} | 设置文本装饰线样式及其颜色。<br />默认值:{<br/>type:&nbsp;TextDecorationType.None,<br/>color:Color.Black<br/>}<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
## 示例 ## 示例
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册