xref: /docs/en/application-dev/reference/apis-arkui/arkui-js/js-components-canvas-canvasgradient.md (revision e41f4b71)

# CanvasGradient

>  **NOTE**
>
>  This component is supported since API version 4. Updates will be marked with a superscript to indicate their earliest API version.

**CanvasGradient** provides a canvas gradient object.


## addColorStop

addColorStop(offset: number, color: string): void

Adds a color stop for the **CanvasGradient** object based on the specified offset and gradient color.

**Parameters**

| Name    | Type    | Description                          |
| ------ | ------ | ---------------------------- |
| offset | number | Relative position of the gradient stop along the gradient vector, represented by the ratio of the distance between the gradient stop and the start point to the total length. The value ranges from 0 to 1.|
| color  | string | Gradient color to set.                    |

**Example**

  ```html
<!-- xxx.hml -->
<div>
  <canvas ref="canvas" style="width: 500px; height: 500px; background-color: #ffff00;"></canvas>
</div>
  ```

  ```js
// xxx.js
export default {
    onShow() {
        const el = this.$refs.canvas;
        const ctx = el.getContext('2d');
        const gradient = ctx.createLinearGradient(50, 0, 300, 100);
        gradient.addColorStop(0.0, '#ff0000')
        gradient.addColorStop(0.5, '#ffffff')
        gradient.addColorStop(1.0, '#00ff00')
        ctx.fillStyle = gradient
        ctx.fillRect(0, 0, 300, 300)
    }
}
  ```

  ![en-us_image_0000001152610806](figures/en-us_image_0000001152610806.png)