🎨Welcome / Leave

Classes

WelcomeLeave

Functions

setAvatar(value) ⇒ WelcomeLeave

Set the avatar of the card

setTitulo(value, color) ⇒ WelcomeLeave

Set the title of the card

setSubtitulo(value, color) ⇒ WelcomeLeave

Set the subtitle of the card

setColorCircle(value) ⇒ WelcomeLeave

Set the color of the circle

setColorOverlay(value) ⇒ WelcomeLeave

Set the color of the overlay

setOpacityOverlay(value) ⇒ WelcomeLeave

Set the opacity of the overlay

setBackground(type, data) ⇒ WelcomeLeave

Set background image/color of the card

setTypeOverlay(type) ⇒ WelcomeLeave

Set the type of overlay

build([font]) ⇒ Promise.<Buffer>

Build the card

WelcomeLeave

Kind: global class

new WelcomeLeave()

Welcome or Leave card creator

PREVIEW

Example

const welcome = new canvacard.WelcomeLeave()
  .setAvatar(data.avatarURL)
  .setBackground('COLOR', '#000000')
  .setTitulo("Titulo de la Tarjeta👋", '#FFFFFF')
  .setSubtitulo("Subtitulo de la Tarjeta 👋", '#FFFFFF')
  .setOpacityOverlay(1)
  .setColorCircle('#FFFFFF')
  .setColorOverlay('#5865F2')
  .setTypeOverlay('ROUNDED');
const welcomeImage = await welcome.build("Suravaram");
canvacard.write(welcomeImage, "./welcomer.png");

setAvatar(value) ⇒ WelcomeLeave

Set the avatar of the card

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError Missing field: avatar

Param	Type	Description
value	string | Buffer	Avatar URL or Buffer

setTitulo(value, color) ⇒ WelcomeLeave

Set the title of the card

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError The title must be a string

Param	Type	Description
value	string	Title value
color	string	HTML5 color code "#000000"

setSubtitulo(value, color) ⇒ WelcomeLeave

Set the subtitle of the card

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError The subtitle must be a string

Param	Type	Description
value	string	Subtitle value
color	string	HTML5 color code "#000000"

setColorCircle(value) ⇒ WelcomeLeave

Set the color of the circle

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError The color must be a string

Param	Type	Description
value	string	HTML5 color code "#000000"

setColorOverlay(value) ⇒ WelcomeLeave

Set the color of the overlay

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError The color must be a string

Param	Type	Description
value	string	HTML5 color code "#000000"

setOpacityOverlay(value) ⇒ WelcomeLeave

Set the opacity of the overlay

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError The opacity must be a number

Param	Type	Description
value	number	Opacity value (0 to 1)

setBackground(type, data) ⇒ WelcomeLeave

Set background image/color of the card

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError Missing field: data

Param	Type	Description
type	"COLOR" | "IMAGE"	Type of background
data	string	Image URL or HTML color code

setTypeOverlay(type) ⇒ WelcomeLeave

Set the type of overlay

Kind: global function Returns: WelcomeLeave - The current instance of WelcomeLeave Throws:

• APIError Missing field: type

Param	Type	Description
type	"RECTANGLE" | "ROUNDED"	Type of overlay

build([font]) ⇒ Promise.<Buffer>

Build the card

Kind: global function Returns: Promise.<Buffer> - Card image in buffer format Throws:

• APIError Error loading background image

Param	Type	Default	Description
[font]	string	"Arial"	Font to use in the card