Skip to content

RichAttribution

RichAttribution #

Bases: MapLayer

An animated and interactive attribution layer that supports both images and text (displayed in a popup controlled by an icon button adjacent to the images).

alignment #

alignment: AttributionAlignment | None = None

The position in which to anchor this attribution control.

attributions #

attributions: list[SourceAttribution]

List of attributions to display.

TextSourceAttributions are shown in a popup box, unlike ImageSourceAttribution, which are visible permanently.

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

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.

permanent_height #

permanent_height: Number = 24.0

The height of the permanent row in which is found the popup menu toggle button. Also determines spacing between the items within the row.

popup_bgcolor #

popup_bgcolor: ColorValue | None = SURFACE

The color to use as the popup box's background color.

popup_border_radius #

popup_border_radius: BorderRadiusValue | None = None

The radius of the edges of the popup box.

popup_initial_display_duration #

popup_initial_display_duration: DurationValue = field(
    default_factory=lambda: Duration()
)

The popup box will be open by default and be hidden this long after the map is initialised.

This is useful with certain sources/tile servers that make immediate attribution mandatory and are not attributed with a permanently visible ImageSourceAttribution.

rtl #

rtl: bool = False

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

show_flutter_map_attribution #

show_flutter_map_attribution: bool = True

Whether to add an additional attribution logo and text for flutter-map, on which 'flet-map' package is based for map-renderings.

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

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

update #

update() -> None

will_unmount #

will_unmount()