Rank

Rank card builder

```js new canvafy.Rank() ```
METHODS
* [build](#build) * [setAvatar](#set-avatar) * [setBackground](#set-background) * [setBarColor](#set-bar-color) * [setBarOpacity](#set-bar-opacity) * [setBorder](#set-border) * [setCurrentXp](#set-current-xp) * [setCustomStatus](#set-custom-status) * [setDiscriminator](#set-discriminator) * [setForegroundColor](#set-foreground-color) * [setForegroundOpacity](#set-foreground-opacity) * [setLevel](#set-level) * [setLevelColor](#set-level-color) * [setRank](#set-rank) * [setRankColor](#set-rank-color) * [setRequiredXp](#set-required-xp) * [setStatus](#set-status) * [setUsername](#set-username)

.build([options])

Build the rank card

Scope: `ASYNC` PARAMETER | TYPE | DESCRIPTION --- | --- | --- options | [BuildOptions](https://github.com/squarfiuz/canvafy/tree/main/docs/typedef/BuildOptions.md) | Build options Returns: [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\

.setAvatar(image)

Set the user avatar

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- image | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - [Buffer](https://developer.mozilla.org/en-US/docs/Glossary/buffer) - [Canvas.Image](https://www.tabnine.com/code/javascript/functions/canvas/loadImage) | Avatar image | https://someimage.com/avatar.png Returns: [Rank](#rank)

.setBackground(type, value)

Set the background color/image

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- type | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Type between 'color' and 'background | background value | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - [Buffer](https://developer.mozilla.org/en-US/docs/Glossary/buffer) - [Canvas.Image](https://www.tabnine.com/code/javascript/functions/canvas/loadImage) | Background or hexadecimal color | https://someimage.com/background.png / #ff5555 Returns: [Rank](#rank)

.setBarColor(color)

Set the progressbar color

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #5b58f2 Returns: [Rank](#rank)

.setBarOpacity(opacity)

Set the progressbar opacity

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- opacity | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Number between 0 and 1 (0 and 1 included) | 1 Returns: [Rank](#rank)

.setBorder(color)

Set the border color

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #70db6C Returns: [Rank](#rank)

.setCurrentXp(xp, [color])

Set the current XP

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- xp | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Current XP number | 200 color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color of current XP text | #000 Returns: [Rank](#rank)

.setCustomStatus(color)

Set the color of the avatar's border

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color of border avatar color | #ff5555 Returns: [Rank](#rank)

.setDiscriminator(discriminator, [color])

Set the user discriminator

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- discriminator | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Discriminator of the user | 7777 color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color of discriminator | #fff Returns: [Rank](#rank)

.setForegroundColor(color)

Set the the foreground color

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #2a2e35 Returns: [Rank](#rank)

.setForegroundOpacity(opacity)

Set the foreground opacity

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- opacity | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Number between 0 and 1 (0 and 1 included) | 0.8 Returns: [Rank](#rank)

.setLevel(data, [text])

Set the level

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- data | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Level Number | 1 text | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Level text | Level Returns: [Rank](#rank)

.setLevelColor(options)

Set the level color

PARAMETER | TYPE | DESCRIPTION --- | --- | --- options | [LevelColorOptions](https://github.com/squarfiuz/canvafy/tree/main/docs/typedef/LevelColorOptions.md) | The options for the level color Returns: [Rank](#rank)

.setRank(data, [text])

Set the rank

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- data | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Level Number | 1 text | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Level text | Level Returns: [Rank](#rank)

.setRankColor(options)

Set the rank color

PARAMETER | TYPE | DESCRIPTION --- | --- | --- options | [RankColorOptions](https://github.com/squarfiuz/canvafy/tree/main/docs/typedef/RankColorOptions.md) | The options for the rank color Returns: [Rank](#rank)

.setRequiredXp(xp, [color])

Set the required XP

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- xp | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Required XP number | 400 color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color of required XP text | #000 Returns: [Rank](#rank)

.setStatus(status)

Set the status for the avatar's border

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- status | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Discord status for set the avatar's border color | online/idle/dnd/stream/offline Returns: [Rank](#rank)

.setUsername(username, [color])

Set the user username

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- username | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Username of the user | squarfiuz color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color of username | #fff Returns: [Rank](#rank)