Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LabelAppearance

Appearance settings for text labels

Hierarchy

  • LabelAppearance

Index

Accessors

anchorPointColor

anchorPointColor: Color3Like

The color of the anchor point

anchorPointSize

anchorPointSize: number

The size of the anchor point in pixels. To disable drawing of the anchor point set the size to zero.

backgroundColor

backgroundColor: Color3Like

Color of the filled background

backgroundVisible

backgroundVisible: boolean

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

borderColor

borderColor: Color3Like

Color of the label border

borderVisible

borderVisible: boolean

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

borderWidth

borderWidth: number

Width of the label border in pixels

cornerRadius

cornerRadius: number

Radius, in pixels, of rounded corners.

Setting a value of 0 disables rounded corners. Default 0

fontFamily

fontFamily: string

Font family

Corresponds to the CSS font-family property

fontSize

fontSize: number

Font size in pixels

fontStyle

fontStyle: "normal" | "italic" | "oblique"

Corresponds to the CSS font-style property

fontVariant

fontVariant: "normal" | "small-caps"

Corresponds to the CSS font-variant property

fontWeight

fontWeight: "normal" | "bold" | "lighter" | "bolder"

Corresponds to the CSS font-weight property

opacity

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

textColor

textColor: Color3Like

The color of the text

Methods

getAsProperties

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

    Returns LabelAppearanceProperties

setFromProperties

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

    Parameters

    Returns void

Generated using TypeDoc