InterstitialAd

InterstitialAd

Bases: BaseAd

Displays a full-screen interstitial ad.

RAISES	DESCRIPTION
AssertionError	When using this control on a web and/or non-mobile platform.

badge

badge: BadgeValue | None = None

A badge to show on top of this control.

col

col: ResponsiveNumber = 12

If a parent of this control is a ResponsiveRow, this property is used to determine how many virtual columns of a screen this control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}.

This control spans the 12 virtual columns by default.

/// details | Dimensions type: info | Breakpoint | Dimension | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px | ///

data

data: Any = skip_field()

Arbitrary data of any type.

disabled

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled.

Note

The value of this property will be propagated down to all children controls recursively.

/// details | Example type: example For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

///

expand

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose

expand_loose: bool = False

Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.

More information here.

Note

If expand_loose is True, it will have effect only if:

• expand is not None and
• the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

key

key: KeyValue | None = None

on_click

on_click: ControlEventHandler[BaseAd] | None = None

Called when this ad is clicked.

on_close

on_close: ControlEventHandler[BaseAd] | None = None

Called when the full screen view has been closed. You should restart anything paused while handling on_open.

on_error

on_error: ControlEventHandler[BaseAd] | None = None

Called when an ad request failed.

Event handler argument data property contains information about the error.

on_impression

on_impression: ControlEventHandler[BaseAd] | None = None

Called when an impression occurs on this ad.

on_load

on_load: ControlEventHandler[BaseAd] | None = None

Called when this ad is loaded successfully.

on_open

on_open: ControlEventHandler[BaseAd] | None = 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

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).

page

page: Page | BasePage | None

The page to which this control belongs to.

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.

request

request: AdRequest = field(
    default_factory=lambda: AdRequest()
)

Targeting information used to fetch an Ad.

rtl

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

tooltip

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

unit_id

unit_id: str

Ad unit ID for this ad.

visible

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.

before_event

before_event(e: ControlEvent)

before_update

before_update()

build

build()

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

clean

clean() -> None

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

show

show()

update

update() -> None

will_unmount

will_unmount()