.. role:: ts-api-decorator

###############
LabelAppearance
###############

.. js:module:: cee.mrk
   :noindex:

.. container:: ts-api-section

   .. js:class:: LabelAppearance

      Appearance settings for text labels



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.mrk.LabelAppearance.backgroundColor`
   * :js:attr:`~cee.mrk.LabelAppearance.backgroundVisible`
   * :js:attr:`~cee.mrk.LabelAppearance.borderColor`
   * :js:attr:`~cee.mrk.LabelAppearance.borderVisible`
   * :js:attr:`~cee.mrk.LabelAppearance.borderWidth`
   * :js:attr:`~cee.mrk.LabelAppearance.cornerRadius`
   * :js:attr:`~cee.mrk.LabelAppearance.fontFamily`
   * :js:attr:`~cee.mrk.LabelAppearance.fontSize`
   * :js:attr:`~cee.mrk.LabelAppearance.fontStyle`
   * :js:attr:`~cee.mrk.LabelAppearance.fontVariant`
   * :js:attr:`~cee.mrk.LabelAppearance.fontWeight`
   * :js:attr:`~cee.mrk.LabelAppearance.opacity`
   * :js:attr:`~cee.mrk.LabelAppearance.textColor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~cee.mrk.LabelAppearance.getAsProperties`
   * :js:meth:`~cee.mrk.LabelAppearance.setFromProperties`





------------

Accessors
=========

.. container:: ts-api-section

   .. js:function:: LabelAppearance.backgroundColor()



      Color of the filled background


      :rtype: Color3Like

   .. js:function:: LabelAppearance.backgroundColor( clr)

      :param clr: None
      :type clr: Color3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.backgroundVisible()



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


      :rtype: boolean

   .. js:function:: LabelAppearance.backgroundVisible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.borderColor()



      Color of the label border


      :rtype: Color3Like

   .. js:function:: LabelAppearance.borderColor( clr)

      :param clr: None
      :type clr: Color3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.borderVisible()



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


      :rtype: boolean

   .. js:function:: LabelAppearance.borderVisible( visible)

      :param visible: None
      :type visible: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.borderWidth()



      Width of the label border in pixels


      :rtype: number

   .. js:function:: LabelAppearance.borderWidth( width)

      :param width: None
      :type width: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.cornerRadius()



      Radius, in pixels, of rounded corners.

      Setting a value of 0 disables rounded corners. Default 0


      :rtype: number

   .. js:function:: LabelAppearance.cornerRadius( radiusInPixels)

      :param radiusInPixels: None
      :type radiusInPixels: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.fontFamily()



      Font family

      Corresponds to the CSS font-family property


      :rtype: string

   .. js:function:: LabelAppearance.fontFamily( family)

      :param family: None
      :type family: string


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.fontSize()



      Font size in pixels


      :rtype: number

   .. js:function:: LabelAppearance.fontSize( sizeInPixels)

      :param sizeInPixels: None
      :type sizeInPixels: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.fontStyle()



      Corresponds to the CSS font-style property


      :rtype: unknown | unknown | unknown

   .. js:function:: LabelAppearance.fontStyle( style)

      :param style: None
      :type style: unknown | unknown | unknown


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.fontVariant()



      Corresponds to the CSS font-variant property


      :rtype: unknown | unknown

   .. js:function:: LabelAppearance.fontVariant( variant)

      :param variant: None
      :type variant: unknown | unknown


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.fontWeight()



      Corresponds to the CSS font-weight property


      :rtype: unknown | unknown | unknown | unknown

   .. js:function:: LabelAppearance.fontWeight( weight)

      :param weight: None
      :type weight: unknown | unknown | unknown | unknown


      :rtype: void



.. container:: ts-api-section

   .. js:function:: 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).


      :rtype: number

   .. js:function:: LabelAppearance.opacity( opacity)

      :param opacity: None
      :type opacity: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: LabelAppearance.textColor()



      The color of the text


      :rtype: Color3Like

   .. js:function:: LabelAppearance.textColor( clr)

      :param clr: None
      :type clr: Color3Like


      :rtype: void



Methods
=======

.. rst-class:: ts-api-section

getAsProperties
---------------

.. js:method:: LabelAppearance.getAsProperties()



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


   :rtype: LabelAppearanceProperties

.. rst-class:: ts-api-section

setFromProperties
-----------------

.. js:method:: LabelAppearance.setFromProperties( props)

   :param props: None
   :type props: Partial <LabelAppearanceProperties>


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


   :rtype: void

