• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# CanvasGradient
2
3**CanvasGradient** provides a canvas gradient object.
4
5>  **NOTE**
6>
7>  The APIs of this module are supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.
8
9
10
11## addColorStop
12
13addColorStop(offset: number, color: string): void
14
15Adds a color stop for the **CanvasGradient** object based on the specified offset and gradient color.
16
17
18**Parameters**
19
20| Name    | Type    | Mandatory  | Default Value      | Description                          |
21| ------ | ------ | ---- | --------- | ---------------------------- |
22| offset | number | Yes   | 0         | Relative position of the gradient stop along the gradient vector. The value ranges from 0 to 1.|
23| color  | string | Yes   | '#ffffff' | Gradient color to set.                    |
24
25
26**Example**
27
28  ```ts
29// xxx.ets
30@Entry
31@Component
32struct Page45 {
33  private settings: RenderingContextSettings = new RenderingContextSettings(true)
34  private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings)
35
36  build() {
37    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
38      Canvas(this.context)
39        .width('100%')
40        .height('100%')
41        .backgroundColor('#ffff00')
42        .onReady(() => {
43          var grad = this.context.createLinearGradient(50, 0, 300, 100)
44          grad.addColorStop(0.0, '#ff0000')
45          grad.addColorStop(0.5, '#ffffff')
46          grad.addColorStop(1.0, '#00ff00')
47          this.context.fillStyle = grad
48          this.context.fillRect(0, 0, 500, 500)
49        })
50    }
51    .width('100%')
52    .height('100%')
53  }
54}
55  ```
56  ![en-us_image_0000001256858381](figures/en-us_image_0000001256858381.png)
57
58
59