Link Search Menu Expand Document

arena-py API v0.8.0

arena.objects.ui

class Button:

Buttons of a ButtonPanel in the ARENA UI.

Parameters
  • str name: Button Name
  • str img: Image URl for image buttons (optional)
  • float size: Size of image button (optional)
  • float height: Height of image button, overrides size (optional)
  • float: Width of image button, overrides size (optional)
  • float borderRadius: Border radius of image button (optional)
Button(name='Button', **kwargs)
name
class ButtonPanel(arena.objects.arena_object.Object):

Button Panel in the ARENA UI.

Parameters
  • list[Button] buttons: List of Button objects
  • str title: Title of Button Panel (optional)
  • bool vertical: Whether to display buttons vertically (optional)
  • str font: Font of button panel ['Roboto', 'Roboto-Mono'] (optional)
ButtonPanel(**kwargs)
object_type = 'arenaui-button-panel'
def json_preprocess(self, **kwargs):
Inherited Members
class Prompt(arena.objects.arena_object.Object):

Popup Prompt in the ARENA UI.

Parameters
  • str title: Title of Prompt (optional)
  • str description: Additional desc text of prompt (optional)
  • list[str] buttons: List of button name strings (optional)
  • str width: Width of prompt (optional)
  • str font: Font of button panel ['Roboto', 'Roboto-Mono'] (optional)
Prompt(**kwargs)
object_type = 'arenaui-prompt'
Inherited Members
class Card(arena.objects.arena_object.Object):

Text/Image Card in the ARENA UI.

Parameters
  • str title: Title of Card (optional)
  • str body: Body text of Card (optional)
  • str bodyAlign: Text alignment of body text ['center', 'left', 'right', 'justify'] (optional)
  • str img: Image URL of Card (optional)
  • str imgCaption: Image caption (optional)
  • str imgDirection: Left or Right image placement vs body text [ 'left', 'right'] (optional)
  • str imgSize: Container size fitting of image ['cover', 'contain'] (optional)
  • float fontSize: Font size of card, scales both title and body (optional)
  • float widthScale: Width of card as a factor of the default (optional)
  • bool closeButton: Whether to display a close button (optional)
  • str font: Font of card ['Roboto', 'Roboto-Mono'] (optional)
Card(**kwargs)
object_type = 'arenaui-card'
Inherited Members