Canvacord

LeaderboardBuilder

extendsBuilder<LeaderboardProps>

Create a new leaderboard ui builder

new LeaderboardBuilder()

Properties

components

The components of this builder.

Type:Array<Node|Element>

graphemeProvider

The grapheme provider of this builder.

Type:GraphemeProvider

height

the height of this builder.

Type:number

options

The options manager of this builder.

Type:BuilderOptionsManager<LeaderboardProps>

tw

The tailwind subset to apply to this builder.

Type:string

variant

width

the width of this builder.

Type:number

style

Get the style of this builder.

Type:CSSProperties

Methods

addComponent(component); 

Add component to this builder.

ParameterTypeDescriptionOptional
component
T|Array<T>

the component to add.

Returns:LeaderboardBuilder

adjustCanvas(); 

Adjust the canvas size.

Returns:LeaderboardBuilder

bootstrap(data); 

Bootstrap this builder with data.

ParameterTypeOptional
data
LeaderboardProps
Returns:void

build(options); 

Convert this builder into an image.

ParameterTypeDescriptionOptional
options
Partial<BuilderBuildOptions>

the build options.

Returns:Promise<string|Buffer>

the image buffer or svg string.

render(); 

Render this leaderboard ui on the canvas

Returns:Promise<Element>

renderDefaultPlayer(__namedParameters); 

Render player ui on the canvas

ParameterTypeOptional
__namedParameters
{avatar:ImageSource|; displayName:string|; level:number|; rank:number|; username:string|; xp:number;}
Returns:Promise<Element>

renderDefaultPlayers(players); 

Render players ui on the canvas

ParameterTypeOptional
players
Array<Element>
Returns:Element

renderDefaultTop(__namedParameters); 

Render top players ui on the canvas

ParameterTypeOptional
__namedParameters
{avatar:ImageSource|; displayName:string|; level:number|; rank:number|; username:string|; xp:number;}
Returns:Promise<Element>

renderDefaultVariant(); 

Returns:Promise<Element>
renderHorizontalPlayer(__namedParameters); 
 
ParameterTypeOptional
__namedParameters
{avatar:ImageSource|; displayName:string|; level:number|; rank:number|; username:string|; xp:number;}
Returns:Promise<Element>
renderHorizontalVariant(); 
 
Returns:Promise<Element>
setBackground(background); 
 
Set background for this leaderboard ui
ParameterTypeDescriptionOptional
background
ImageSource
background image
Returns:LeaderboardBuilder
setBackgroundColor(color); 
 
Set background color for this leaderboard ui
ParameterTypeDescriptionOptional
color
string
background color
Returns:LeaderboardBuilder
setGraphemeProvider(provider); 
Set grapheme image provider for this builder.
ParameterTypeOptional
provider
GraphemeProvider
Returns:LeaderboardBuilder
setHeader(data); 
 
Set header for this leaderboard ui
ParameterTypeDescriptionOptional
data
{image:ImageSource|; subtitle:string|; title:string;}
header data
Returns:LeaderboardBuilder
setPlayers(players); 
 
Set players for this leaderboard ui. The canvas size will be adjusted automatically based on the number of players.
ParameterTypeDescriptionOptional
players
Array<{avatar:ImageSource|; displayName:string|; level:number|; rank:number|; username:string|; xp:number;}>
players data
Returns:LeaderboardBuilder
setStyle(newStyle); 
Set the style of this builder.
ParameterTypeDescriptionOptional
newStyle
CSSProperties
the new style.
Returns:LeaderboardBuilder
setTextStyles(config); 
 
Configures the text renderer for this leaderboard.
ParameterTypeDescriptionOptional
config
Partial<{level:string|; rank:string|; xp:string;}>
The configuration for this leaderboard.
Returns:LeaderboardBuilder
setVariant(variant); 
 
Set the ui variant for this leaderboard
ParameterTypeDescriptionOptional
variant
LeaderboardVariants
ui type
Returns:LeaderboardBuilder
static from(template); 
Create a builder from builder template.
ParameterTypeOptional
template
BuilderTemplate
Returns:Builder<Record<string|unknown>>