LabelAppearance

class cee.mrk.LabelAppearance()

Appearance settings for text labels

Accessors

Methods

Accessors

LabelAppearance.backgroundColor()

Color of the filled background

Return type:Color3Like
LabelAppearance.backgroundColor(clr)
Arguments:
  • clr (Color3Like) – None
Return type:

void
LabelAppearance.backgroundVisible()

Flag that determines if the filled background of the labels should be drawn or not.

Return type:boolean
LabelAppearance.backgroundVisible(visible)
Arguments:
  • visible (boolean) – None
Return type:

void
LabelAppearance.borderColor()

Color of the label border

Return type:Color3Like
LabelAppearance.borderColor(clr)
Arguments:
  • clr (Color3Like) – None
Return type:

void
LabelAppearance.borderVisible()

Flag that determines if border around the labels should be drawn or not.

Return type:boolean
LabelAppearance.borderVisible(visible)
Arguments:
  • visible (boolean) – None
Return type:

void
LabelAppearance.borderWidth()

Width of the label border in pixels

Return type:number
LabelAppearance.borderWidth(width)
Arguments:
  • width (number) – None
Return type:

void
LabelAppearance.cornerRadius()

Radius, in pixels, of rounded corners.

Setting a value of 0 disables rounded corners. Default 0

Return type:number
LabelAppearance.cornerRadius(radiusInPixels)
Arguments:
  • radiusInPixels (number) – None
Return type:

void
LabelAppearance.fontFamily()

Font family

Corresponds to the CSS font-family property

Return type:string
LabelAppearance.fontFamily(family)
Arguments:
  • family (string) – None
Return type:

void
LabelAppearance.fontSize()

Font size in pixels

Return type:number
LabelAppearance.fontSize(sizeInPixels)
Arguments:
  • sizeInPixels (number) – None
Return type:

void
LabelAppearance.fontStyle()

Corresponds to the CSS font-style property

Return type:unknown | unknown | unknown
LabelAppearance.fontStyle(style)
Arguments:
  • style (unknown | unknown | unknown) – None
Return type:

void
LabelAppearance.fontVariant()

Corresponds to the CSS font-variant property

Return type:unknown | unknown
LabelAppearance.fontVariant(variant)
Arguments:
  • variant (unknown | unknown) – None
Return type:

void
LabelAppearance.fontWeight()

Corresponds to the CSS font-weight property

Return type:unknown | unknown | unknown | unknown
LabelAppearance.fontWeight(weight)
Arguments:
  • weight (unknown | unknown | unknown | unknown) – None
Return type:

void
LabelAppearance.opacity()

The opacity of the label.

Setting the opacity will influence the label background and the border, but will not affect the actual label text. Opacity 1.0 is fully opaque, 0.0 if fully transparent (invisible).

Return type:number
LabelAppearance.opacity(opacity)
Arguments:
  • opacity (number) – None
Return type:

void
LabelAppearance.textColor()

The color of the text

Return type:Color3Like
LabelAppearance.textColor(clr)
Arguments:
  • clr (Color3Like) – None
Return type:

void

Methods

getAsProperties

LabelAppearance.getAsProperties()

Gets the appearance settings for this labels part as a Plain Old JavaScript Object (POJO).

Return type:LabelAppearanceProperties

setFromProperties

LabelAppearance.setFromProperties(props)
Arguments:

Applies the settings in the given properties object to this appearance object

Return type:void