Skip to main content

A displayio Group that supports placement by anchor_point and anchored_position properties

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

A displayio Group that supports placement by anchor_point and anchored_position properties

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-anchored-group

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-anchored-group

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-anchored-group

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_anchored_group

Or the following command to update an existing version:

circup update

Usage Example

from adafruit_anchored_group import AnchoredGroup
from displayio import Group, Bitmap, TileGrid, Palette
from adafruit_display_text.bitmap_label import Label
import supervisor
import terminalio

display = supervisor.runtime.display

main_group = Group()

display.root_group = main_group

anchored_group = AnchoredGroup()

icon_bmp = Bitmap(30,30, 1)
icon_palette = Palette(1)
icon_palette[0] = 0xff00ff
icon_tg = TileGrid(bitmap=icon_bmp, pixel_shader=icon_palette)

lbl = Label(terminalio.FONT, text="Something")
lbl.anchor_point = (0, 0.5)
lbl.anchored_position = (icon_tg.x + (icon_tg.width * icon_tg.tile_width) + 6,
                         (icon_tg.y + (icon_tg.height * icon_tg.tile_height)) //2)


anchored_group.append(icon_tg)
anchored_group.append(lbl)
print(f"group size: {anchored_group.size}")

anchored_group.anchor_point = (1.0, 0)
anchored_group.anchored_position = (display.width-4, 0)

main_group.append(anchored_group)

while True:
    pass

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_anchored_group-1.1.1.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_anchored_group-1.1.1.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_anchored_group-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c8f14c03e2e73d9178acf2c0e1a60271c176ea6b015a90f7acc429fb810c10be
MD5 cc358a065c23cd26f5d7852d8e9558dd
BLAKE2b-256 6ce5f3ec951f63357bd43f677f2221d2df4d5b247b6dc1b166562836637afebd

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_anchored_group-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_anchored_group-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ee3a3e00cba6d6be26bf1160ccbb55ae65e776889ade830e7fcda35e7d3ab68
MD5 7046fac1feda33b1924d844927d3ae1d
BLAKE2b-256 2e4a4a6e92124386837847f54d47c2c346695d669eb6edc00b23e4ccf89605cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page