LabelAppearance

class cee.mrk.LabelAppearance()

Appearance settings for text labels

Index

Accessors

• backgroundColor
• backgroundVisible
• borderColor
• borderVisible
• borderWidth
• cornerRadius
• fontFamily
• fontSize
• fontStyle
• fontVariant
• fontWeight
• opacity
• textColor

Methods

• getAsProperties
• setFromProperties

Accessors

cee.mrk.LabelAppearance.backgroundColor()

get backgroundColor(): Color3Like

Color of the filled background

Returns: Color3Like

set backgroundColor(clr: Color3Like): void

Parameters

clr: Color3Like

Returns: void

cee.mrk.LabelAppearance.backgroundVisible()

get backgroundVisible(): boolean

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

Returns: boolean

set backgroundVisible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.mrk.LabelAppearance.borderColor()

get borderColor(): Color3Like

Color of the label border

Returns: Color3Like

set borderColor(clr: Color3Like): void

Parameters

clr: Color3Like

Returns: void

cee.mrk.LabelAppearance.borderVisible()

get borderVisible(): boolean

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

Returns: boolean

set borderVisible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.mrk.LabelAppearance.borderWidth()

get borderWidth(): number

Width of the label border in pixels

Returns: number

set borderWidth(width: number): void

Parameters

width: number

Returns: void

cee.mrk.LabelAppearance.cornerRadius()

get cornerRadius(): number

Radius, in pixels, of rounded corners.

Setting a value of 0 disables rounded corners. Default 0

Returns: number

set cornerRadius(radiusInPixels: number): void

Parameters

radiusInPixels: number

Returns: void

cee.mrk.LabelAppearance.fontFamily()

get fontFamily(): string

Font family

Corresponds to the CSS font-family property

Returns: string

set fontFamily(family: string): void

Parameters

family: string

Returns: void

cee.mrk.LabelAppearance.fontSize()

get fontSize(): number

Font size in pixels

Returns: number

set fontSize(sizeInPixels: number): void

Parameters

sizeInPixels: number

Returns: void

cee.mrk.LabelAppearance.fontStyle()

get fontStyle(): (“normal” | “italic” | “oblique”)

Corresponds to the CSS font-style property

Returns: (“normal” | “italic” | “oblique”)

set fontStyle(style: (“normal” | “italic” | “oblique”)): void

Parameters

style: (“normal” | “italic” | “oblique”)

Returns: void

cee.mrk.LabelAppearance.fontVariant()

get fontVariant(): (“normal” | “small-caps”)

Corresponds to the CSS font-variant property

Returns: (“normal” | “small-caps”)

set fontVariant(variant: (“normal” | “small-caps”)): void

Parameters

variant: (“normal” | “small-caps”)

Returns: void

cee.mrk.LabelAppearance.fontWeight()

get fontWeight(): (“bold” | “normal” | “lighter” | “bolder”)

Corresponds to the CSS font-weight property

Returns: (“bold” | “normal” | “lighter” | “bolder”)

set fontWeight(weight: (“bold” | “normal” | “lighter” | “bolder”)): void

Parameters

weight: (“bold” | “normal” | “lighter” | “bolder”)

Returns: void

cee.mrk.LabelAppearance.opacity()

get opacity(): number

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).

Returns: number

set opacity(opacity: number): void

Parameters

opacity: number

Returns: void

cee.mrk.LabelAppearance.textColor()

get textColor(): Color3Like

The color of the text

Returns: Color3Like

set textColor(clr: Color3Like): void

Parameters

clr: Color3Like

Returns: void

Methods

cee.mrk.LabelAppearance.getAsProperties()

getAsProperties(): LabelAppearanceProperties

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

Returns: LabelAppearanceProperties

cee.mrk.LabelAppearance.setFromProperties()

setFromProperties(props: Partial): void

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

Parameters

props: Partial

Returns: void