Skip to content

bitmap property for bitmap_label #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 21, 2021
Merged

bitmap property for bitmap_label #156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
934c380
bitmap property for bitmap_label
FoamyGuy Aug 16, 2021
9563ef0
type links in the docstrings for bitmap label.
FoamyGuy Aug 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions adafruit_display_text/bitmap_label.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@

class Label(LabelBase):
"""A label displaying a string of text that is stored in a bitmap.
Note: This ``bitmap_label.py`` library utilizes a bitmap to display the text.
This method is memory-conserving relative to ``label.py``.
Note: This ``bitmap_label.py`` library utilizes a :py:class:`~displayio.Bitmap`
to display the text. This method is memory-conserving relative to ``label.py``.

For further reduction in memory usage, set ``save_text=False`` (text string will not
be stored and ``line_spacing`` and ``font`` are immutable with ``save_text``
Expand Down Expand Up @@ -534,3 +534,12 @@ def _set_label_direction(self, new_label_direction: str) -> None:

def _get_valid_label_directions(self) -> Tuple[str, ...]:
return "LTR", "RTL", "UPD", "UPR", "DWR"

@property
def bitmap(self):
"""
The Bitmap object that the text and background are drawn into.

:rtype: displayio.Bitmap
"""
return self._bitmap