Image

Examples

See these.

Image

Bases: Shape

Draws an image.

data

data: Any = skip_field()

Arbitrary data of any type.

height

height: Number | None = None

The height of the rectangle to draw the image into. Use image height if None.

key

key: KeyValue | None = None

page

page: Page | PageView | None

The page (of type Page or PageView) to which this control belongs to.

paint

paint: Paint | None = None

A paint to composite the image into canvas.

parent

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

src

src: str | None = None

Draws an image from a source.

This could be an external URL or a local asset file.

src_bytes

src_bytes: bytes | None = None

Draws an image from a bytes array.

width

width: Number | None = None

The width of the rectangle to draw the image into. Use image width if None.

x

x: Number | None = None

The x-axis coordinate of the image's top-left corner.

y

y: Number | None = None

The y-axis coordinate of the image's top-left corner.

before_event

before_event(e: ControlEvent)

before_update

before_update()

This method is called every time when this control is being updated.

Note

Make sure not to call/request an update() here.

build

build()

Called once during control initialization to define its child controls. self.page is available in this method.

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

update

update() -> None

will_unmount

will_unmount()