LabelAppearance

class cee.mrk.LabelAppearance()

Appearance settings for text labels

Accessors

  • backgroundColor

  • backgroundVisible

  • borderColor

  • borderVisible

  • borderWidth

  • cornerRadius

  • fontFamily

  • fontSize

  • fontStyle

  • fontVariant

  • fontWeight

  • opacity

  • textColor

Methods

Accessors

cee.mrk.backgroundColor()

Color of the filled background

Return type:

Color3Like

cee.mrk.backgroundColor(clr)
Arguments:

  • clr (Color3Like) – None

Return type:

void

cee.mrk.backgroundVisible()

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

Return type:

boolean

cee.mrk.backgroundVisible(visible)
Arguments:

  • visible (boolean) – None

Return type:

void

cee.mrk.borderColor()

Color of the label border

Return type:

Color3Like

cee.mrk.borderColor(clr)
Arguments:

  • clr (Color3Like) – None

Return type:

void

cee.mrk.borderVisible()

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

Return type:

boolean

cee.mrk.borderVisible(visible)
Arguments:

  • visible (boolean) – None

Return type:

void

cee.mrk.borderWidth()

Width of the label border in pixels

Return type:

number

cee.mrk.borderWidth(width)
Arguments:

  • width (number) – None

Return type:

void

cee.mrk.cornerRadius()

Radius, in pixels, of rounded corners.

Setting a value of 0 disables rounded corners. Default 0

Return type:

number

cee.mrk.cornerRadius(radiusInPixels)
Arguments:

  • radiusInPixels (number) – None

Return type:

void

cee.mrk.fontFamily()

Font family

Corresponds to the CSS font-family property

Return type:

string

cee.mrk.fontFamily(family)
Arguments:

  • family (string) – None

Return type:

void

cee.mrk.fontSize()

Font size in pixels

Return type:

number

cee.mrk.fontSize(sizeInPixels)
Arguments:

  • sizeInPixels (number) – None

Return type:

void

cee.mrk.fontStyle()

Corresponds to the CSS font-style property

Return type:

unknown | unknown | unknown

cee.mrk.fontStyle(style)
Arguments:

  • style (unknown | unknown | unknown) – None

Return type:

void

cee.mrk.fontVariant()

Corresponds to the CSS font-variant property

Return type:

unknown | unknown

cee.mrk.fontVariant(variant)
Arguments:

  • variant (unknown | unknown) – None

Return type:

void

cee.mrk.fontWeight()

Corresponds to the CSS font-weight property

Return type:

unknown | unknown | unknown | unknown

cee.mrk.fontWeight(weight)
Arguments:

  • weight (unknown | unknown | unknown | unknown) – None

Return type:

void

cee.mrk.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

cee.mrk.opacity(opacity)
Arguments:

  • opacity (number) – None

Return type:

void

cee.mrk.textColor()

The color of the text

Return type:

Color3Like

cee.mrk.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