BaseAd
BaseAd
#
Bases: Control
Base class for all ad controls in Flet Ads package.
| RAISES | DESCRIPTION |
|---|---|
AssertionError
|
When using this control on a web and/or non-mobile platform. |
col: ResponsiveNumber = 12
#
If a parent of the control is ResponsiveRow, col property is used to determine
how many virtual columns of a screen the control will span.
Can be a number or a dictionary configured to have a different value for specific
breakpoints, for example col={"sm": 6}. Breakpoints are named dimension ranges:
| Breakpoint | Dimension |
|---|---|
| xs | <576px |
| sm | ≥576px |
| md | ≥768px |
| lg | ≥992px |
| xl | ≥1200px |
| xxl | ≥1400px |
If col property is not specified, it spans the maximum number of columns (12).
data: Any = skip_field()
#
Arbitrary data of any type that can be attached to a control.
disabled: bool = False
#
Every control has disabled property which is False by default - control and all
its children are enabled.
disabled property is mostly used with data entry controls like TextField,
Dropdown, Checkbox, buttons.
However, disabled could be set to a parent control and its value will be
propagated down to all children recursively.
For example, if you have a form with multiple entry controls you can disable them all together by disabling container:
expand: bool | int | None = None
#
When a child Control is placed into a Column
or a Row you can "expand" it to fill the
available space.
expand property could be a boolean value (True - expand control to fill all
available space) or an integer - an "expand factor" specifying how to divide a free
space with other expanded child controls.
For more information and examples about expand property see "Expanding children"
sections in Column or
Row.
Here is an example of expand being used in action for both Column
and Row:
import flet as ft
def main(page: ft.Page):
page.spacing = 0
page.padding = 0
page.add(
ft.Column(
controls=[
ft.Row(
[
ft.Card(
content=ft.Text("Card_1"),
color=ft.Colors.ORANGE_300,
expand=True,
height=page.height,
margin=0,
),
ft.Card(
content=ft.Text("Card_2"),
color=ft.Colors.GREEN_100,
expand=True,
height=page.height,
margin=0,
),
],
expand=True,
spacing=0,
),
],
expand=True,
spacing=0,
),
)
ft.app(main)
expand_loose: bool | None = None
#
Effective only if expand is True.
If expand_loose is True, the child control of a
Column or a Row
will be given the flexibility to expand to fill the available space in the main
axis (e.g., horizontally for a Row or vertically for a Column), but will not be
required to fill the available space.
The default value is False.
Here is the example of Containers placed in Rows with expand_loose = True:
import flet as ft
class Message(ft.Container):
def __init__(self, author, body):
super().__init__()
self.content = ft.Column(
controls=[
ft.Text(author, weight=ft.FontWeight.BOLD),
ft.Text(body),
],
)
self.border = ft.border.all(1, ft.Colors.BLACK)
self.border_radius = ft.border_radius.all(10)
self.bgcolor = ft.Colors.GREEN_200
self.padding = 10
self.expand = True
self.expand_loose = True
def main(page: ft.Page):
chat = ft.ListView(
padding=10,
spacing=10,
controls=[
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Hi, how are you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Hi I am good thanks, how about you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a
type specimen book.",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Thank you!",
),
],
),
],
)
page.window.width = 393
page.window.height = 600
page.window.always_on_top = False
page.add(chat)
ft.run(main)
key: str | int | float | bool | ValueKey | ScrollKey | None = None
#
on_click: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when this ad is clicked.
on_close: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when the full screen view has been closed. You should restart
anything paused while handling [on_open][..].
on_error: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when an ad request failed.
Event handler argument data property contains information about the error.
on_impression: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when an impression occurs on this ad.
on_load: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when this ad is loaded successfully.
on_open: ft.OptionalControlEventHandler[BaseAd] = None
#
Called when this ad opens up.
A full screen view/overlay is presented in response to the user clicking on an ad. You may want to pause animations and time sensitive interactions.
opacity: Number = 1.0
#
Defines the transparency of the control.
Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque
without any transparency) and defaults to 1.0.
page: Page | PageView | None
#
The page (of type Page or PageView) to which this control belongs to.
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.
request: AdRequest = field(default_factory=lambda: AdRequest())
#
Targeting information used to fetch an Ad.
rtl: bool = False
#
True to set text direction to right-to-left.
tooltip: TooltipValue | None = None
#
The tooltip property supports both strings
and Tooltip objects.
unit_id: str
#
Ad unit ID for this ad.
visible: bool = True
#
Every control has visible property which is True by default - control is
rendered on the page. Setting visible to False completely prevents control (and
all its children if any) from rendering on a page canvas. Hidden controls cannot be
focused or selected with a keyboard or mouse and they do not emit any events.