Skip to content

Commit 6befec3

Browse files
authored
Update README.md
1 parent 16f6246 commit 6befec3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The URLs will render an image of a chart:
5656

5757
You can set the following properties:
5858

59-
### config: dict
59+
### config: dict or str
6060
The actual Chart.js chart configuration.
6161

6262
### width: int
@@ -78,13 +78,13 @@ The device pixel ratio of the chart. This will multiply the number of pixels by
7878

7979
There are two ways to get a URL for your chart object.
8080

81-
### getUrl(): string
81+
### get_url(): str
8282

8383
Returns a URL that will display the chart image when loaded.
8484

85-
### getShortUrl(): Promise
85+
### get_short_url(): str
8686

87-
Uses the quickchart.io web service to create a fixed-length chart URL that displays the chart image. The Promise resolves with a URL such as `https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401`.
87+
Uses the quickchart.io web service to create a fixed-length chart URL that displays the chart image. Returns a URL such as `https://quickchart.io/chart/render/f-a1d3e804-dfea-442c-88b0-9801b9808401`.
8888

8989
Note that short URLs expire after a few days for users of the free service. You can [subscribe](https://quickchart.io/pricing/) to keep them around longer.
9090

0 commit comments

Comments
 (0)