# Class pyglet.text.HTMLLabel

    layout.TextLayout --+
                        |
            DocumentLabel --+
                            |
                           HTMLLabel

HTML formatted text label.

A subset of HTML 4.01 is supported. See `pyglet.text.formats.html` for details.

## Methods

| __init__(self, text=`'````'`, location=None, x=0, y=0, width=None, height=None, anchor_x=`'``left``'`, anchor_y=`'``baseline``'`, multiline=False, dpi=None, batch=None, group=None) Create a label with an HTML string.
Inherited from `DocumentLabel`: `get_style`, `set_style` Inherited from `layout.TextLayout`: `begin_update`, `delete`, `draw`, `end_update`, `on_delete_text`, `on_insert_text`, `on_style_text`

## Properties

str | text HTML formatted text of the label.
Inherited from `DocumentLabel`: `bold`, `color`, `font_name`, `font_size`, `italic` Inherited from `layout.TextLayout`: `anchor_x`, `anchor_y`, `content_valign`, `document`, `dpi`, `height`, `multiline`, `width`, `x`, `y`

## Instance Variables

Inherited from `layout.TextLayout`: `background_group`, `content_height`, `content_width`, `foreground_decoration_group`, `foreground_group`, `top_group`

## Method Details

### __init__

(Constructor) __init__(self, text=`'````'`, location=None, x=0, y=0, width=None, height=None, anchor_x=`'``left``'`, anchor_y=`'``baseline``'`, multiline=False, dpi=None, batch=None, group=None)
Create a label with an HTML string.

Parameters:
  text : str
    HTML formatted text to display.
  location : `Location`
    Location object for loading images referred to in the document. By default, the working directory is used.
  x : int
    X coordinate of the label.
  y : int
    Y coordinate of the label.
  width : int
    Width of the label in pixels, or None
  height : int
    Height of the label in pixels, or None
  anchor_x : str
    Anchor point of the X coordinate: one of `"left"`, `"center"` or `"right"`.
  anchor_y : str
    Anchor point of the Y coordinate: one of `"bottom"`, `"baseline"`, `"center"` or `"top"`.
  multiline : bool
    If True, the label will be word-wrapped and render paragraph and line breaks. You must also set the width of the label.
  dpi : float
    Resolution of the fonts in this layout. Defaults to 96.
  batch : `Batch`
    Optional graphics batch to add the label to.
  group : `Group`
    Optional graphics group to use.
Overrides:
  DocumentLabel.__init__

## Property Details

### text

HTML formatted text of the label.

Type:
  str