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

.. js:class:: cee.mrk.LabelAppearance

   Appearance settings for text labels
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.mrk.LabelAppearance.backgroundColor`
   * :js:func:`~cee.mrk.LabelAppearance.backgroundVisible`
   * :js:func:`~cee.mrk.LabelAppearance.borderColor`
   * :js:func:`~cee.mrk.LabelAppearance.borderVisible`
   * :js:func:`~cee.mrk.LabelAppearance.borderWidth`
   * :js:func:`~cee.mrk.LabelAppearance.cornerRadius`
   * :js:func:`~cee.mrk.LabelAppearance.fontFamily`
   * :js:func:`~cee.mrk.LabelAppearance.fontSize`
   * :js:func:`~cee.mrk.LabelAppearance.fontStyle`
   * :js:func:`~cee.mrk.LabelAppearance.fontVariant`
   * :js:func:`~cee.mrk.LabelAppearance.fontWeight`
   * :js:func:`~cee.mrk.LabelAppearance.opacity`
   * :js:func:`~cee.mrk.LabelAppearance.textColor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.mrk.LabelAppearance.getAsProperties`
   * :js:meth:`~cee.mrk.LabelAppearance.setFromProperties`
   
   



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: cee.mrk.LabelAppearance.backgroundColor

      .. rst-class:: sig-pretty-signature
      
         | *get* backgroundColor(): :js:class:`Color3Like <cee.Color3Like>`
      
      Color of the filled background
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* backgroundColor(**clr**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **clr**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.backgroundVisible

      .. rst-class:: sig-pretty-signature
      
         | *get* backgroundVisible(): *boolean*
      
      Flag that determines if the filled background of the labels should be drawn or not.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* backgroundVisible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.borderColor

      .. rst-class:: sig-pretty-signature
      
         | *get* borderColor(): :js:class:`Color3Like <cee.Color3Like>`
      
      Color of the label border
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* borderColor(**clr**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **clr**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.borderVisible

      .. rst-class:: sig-pretty-signature
      
         | *get* borderVisible(): *boolean*
      
      Flag that determines if border around the labels should be drawn or not.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* borderVisible(**visible**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **visible**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.borderWidth

      .. rst-class:: sig-pretty-signature
      
         | *get* borderWidth(): *number*
      
      Width of the label border in pixels
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* borderWidth(**width**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **width**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.cornerRadius

      .. rst-class:: sig-pretty-signature
      
         | *get* cornerRadius(): *number*
      
      Radius, in pixels, of rounded corners.
      
      Setting a value of 0 disables rounded corners. Default 0
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* cornerRadius(**radiusInPixels**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **radiusInPixels**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.fontFamily

      .. rst-class:: sig-pretty-signature
      
         | *get* fontFamily(): *string*
      
      Font family
      
      Corresponds to the CSS font-family property
      
      **Returns**\ : *string*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fontFamily(**family**\ : *string*\ ): *void*
      
      **Parameters**
      
      
         **family**\ : *string*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.fontSize

      .. rst-class:: sig-pretty-signature
      
         | *get* fontSize(): *number*
      
      Font size in pixels
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fontSize(**sizeInPixels**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **sizeInPixels**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.fontStyle

      .. rst-class:: sig-pretty-signature
      
         | *get* fontStyle(): (*"normal"* | *"italic"* | *"oblique"*\ )
      
      Corresponds to the CSS font-style property
      
      **Returns**\ : (*"normal"* \| *"italic"* \| *"oblique"*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fontStyle(**style**\ : (*"normal"* | *"italic"* | *"oblique"*\ )): *void*
      
      **Parameters**
      
      
         **style**\ : (*"normal"* \| *"italic"* \| *"oblique"*\ )
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.fontVariant

      .. rst-class:: sig-pretty-signature
      
         | *get* fontVariant(): (*"normal"* | *"small-caps"*\ )
      
      Corresponds to the CSS font-variant property
      
      **Returns**\ : (*"normal"* \| *"small-caps"*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fontVariant(**variant**\ : (*"normal"* | *"small-caps"*\ )): *void*
      
      **Parameters**
      
      
         **variant**\ : (*"normal"* \| *"small-caps"*\ )
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.fontWeight

      .. rst-class:: sig-pretty-signature
      
         | *get* fontWeight(): (*"bold"* | *"normal"* | *"lighter"* | *"bolder"*\ )
      
      Corresponds to the CSS font-weight property
      
      **Returns**\ : (*"bold"* \| *"normal"* \| *"lighter"* \| *"bolder"*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* fontWeight(**weight**\ : (*"bold"* | *"normal"* | *"lighter"* | *"bolder"*\ )): *void*
      
      **Parameters**
      
      
         **weight**\ : (*"bold"* \| *"normal"* \| *"lighter"* \| *"bolder"*\ )
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.opacity

      .. rst-class:: sig-pretty-signature
      
         | *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*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* opacity(**opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.mrk.LabelAppearance.textColor

      .. rst-class:: sig-pretty-signature
      
         | *get* textColor(): :js:class:`Color3Like <cee.Color3Like>`
      
      The color of the text
      
      **Returns**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* textColor(**clr**\ : :js:class:`Color3Like <cee.Color3Like>`\ ): *void*
      
      **Parameters**
      
      
         **clr**\ : :js:class:`Color3Like <cee.Color3Like>`
      
      
      **Returns**\ : *void*
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.mrk.LabelAppearance.getAsProperties

      .. rst-class:: sig-pretty-signature
      
         | getAsProperties(): :js:class:`LabelAppearanceProperties <cee.mrk.LabelAppearanceProperties>`
      
      Gets the appearance settings for this labels part as a Plain Old JavaScript Object (POJO).
      
      **Returns**\ : :js:class:`LabelAppearanceProperties <cee.mrk.LabelAppearanceProperties>`
      



.. js:method:: cee.mrk.LabelAppearance.setFromProperties

      .. rst-class:: sig-pretty-signature
      
         | setFromProperties(**props**\ : *Partial*\ ): *void*
      
      Applies the settings in the given properties object to this appearance object
      
      **Parameters**
      
      
         **props**\ : *Partial*
      
      
      **Returns**\ : *void*
      




