LineChart
LineChart
#
Bases: ConstrainedControl
Draws a line chart.
animate_offset
#
animate_offset: AnimationValue | None = None
Setting control's animate_offset
to either True
, number or an instance of
animation.Animation
class enables implicit animation of Control.offset
property.
offset
property is an instance of transform.Offset
class which specifies
horizontal x
and vertical y
offset of a control scaled to control's size.
For example, an offset transform.Offset(-0.25, 0)
will result in a horizontal
translation of one quarter the width of the control.
Offset animation is used for various sliding effects:
import flet as ft
def main(page: ft.Page):
c = ft.Container(
width=150,
height=150,
bgcolor="blue",
border_radius=10,
offset=ft.transform.Offset(-2, 0),
animate_offset=ft.animation.Animation(1000),
)
def animate(e):
c.offset = ft.transform.Offset(0, 0)
c.update()
page.add(
c,
ft.ElevatedButton("Reveal!", on_click=animate),
)
ft.run(main)
animate_opacity
#
animate_opacity: AnimationValue | None = None
Setting control's animate_opacity
to either True
, number or an instance of
animation.Animation
class enables implicit animation of Control.opacity
property.
import flet as ft
def main(page: ft.Page):
c = ft.Container(
width=150,
height=150,
bgcolor="blue",
border_radius=10,
animate_opacity=300,
)
def animate_opacity(e):
c.opacity = 0 if c.opacity == 1 else 1
c.update()
page.add(
c,
ft.ElevatedButton(
"Animate opacity",
on_click=animate_opacity,
),
)
ft.app(main)
animate_position
#
animate_position: AnimationValue | None = None
Setting control's animate_position
to either True
, number or an instance of
animation.Animation
class (see above) enables implicit animation of Control's
left
, top
, right
and bottom
properties.
Please note Control position works inside Stack
control only.
import flet as ft
def main(page: ft.Page):
c1 = ft.Container(width=50, height=50, bgcolor="red", animate_position=1000)
c2 = ft.Container(
width=50, height=50, bgcolor="green", top=60, left=0, animate_position=500
)
c3 = ft.Container(
width=50, height=50, bgcolor="blue", top=120, left=0, animate_position=1000
)
def animate_container(e):
c1.top = 20
c1.left = 200
c2.top = 100
c2.left = 40
c3.top = 180
c3.left = 100
page.update()
page.add(
ft.Stack([c1, c2, c3], height=250),
ft.ElevatedButton("Animate!", on_click=animate_container),
)
ft.run(main)
animate_rotation
#
animate_rotation: AnimationValue | None = None
Setting control's animate_rotation
to either True
, number or an instance of
animation.Animation
class enables implicit animation of Control.rotate
property.
from math import pi
import flet as ft
def main(page: ft.Page):
c = ft.Container(
width=100,
height=70,
bgcolor="blue",
border_radius=5,
rotate=ft.transform.Rotate(0, alignment=ft.Alignment.CENTER),
animate_rotation=ft.animation.Animation(300, ft.AnimationCurve.BOUNCE_OUT),
)
def animate(e):
c.rotate.angle += pi / 2
page.update()
page.vertical_alignment = ft.MainAxisAlignment.CENTER
page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
page.spacing = 30
page.add(
c,
ft.ElevatedButton("Animate!", on_click=animate),
)
ft.run(main)
animate_scale
#
animate_scale: AnimationValue | None = None
Setting control's animate_scale
to either True
, number or an instance of
animation.Animation
class enables implicit animation of Control.scale
property.
import flet as ft
def main(page: ft.Page):
c = ft.Container(
width=100,
height=100,
bgcolor="blue",
border_radius=5,
scale=ft.transform.Scale(scale=1),
animate_scale=ft.animation.Animation(600, ft.AnimationCurve.BOUNCE_OUT),
)
def animate(e):
c.scale = 2
page.update()
page.vertical_alignment = ft.MainAxisAlignment.CENTER
page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
page.spacing = 30
page.add(
c,
ft.ElevatedButton("Animate!", on_click=animate),
)
ft.run(main)
animation
#
animation: AnimationValue = field(
default_factory=lambda: Animation(
duration=Duration(milliseconds=150), curve=LINEAR
)
)
Controls chart implicit animation.
bottom
#
Effective inside Stack
only. The distance
that the child's bottom edge is inset from the bottom of the stack.
bottom_axis
#
Defines the appearance of the bottom axis, its title and labels.
col
#
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_series
#
data_series: list[LineChartData] = field(
default_factory=list
)
A list of LineChartData
controls drawn as separate lines on a chart.
disabled
#
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
#
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
#
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)
horizontal_grid_lines
#
horizontal_grid_lines: ChartGridLines | None = None
Controls drawing of chart's horizontal lines.
interactive
#
interactive: bool = True
Enables automatic tooltips and points highlighting when hovering over the chart.
left
#
Effective inside Stack
only. The distance
that the child's left edge is inset from the left of the stack.
left_axis
#
Defines the appearance of the left axis, its title and labels.
offset
#
offset: OffsetValue | None = None
Applies a translation transformation before painting the control.
The translation is expressed as a transform.Offset
scaled to the control's size.
For example, an Offset
with a x
of 0.25
will result in a horizontal
translation of one quarter the width of the control.
The following example displays container at 0, 0
top left corner of a stack as
transform applies -1 * 100, -1 * 100
(offset * control_size
) horizontal and
vertical translations to the control:
on_animation_end
#
on_animation_end: OptionalControlEventHandler[
ConstrainedControl
] = None
All controls with animate_*
properties have on_animation_end
event handler
which is called when animation complete and can be used to chain multiple
animations.
Event's object data
field contains the name of animation:
opacity
rotation
scale
offset
position
container
For example:
on_event
#
on_event: EventHandler[LineChartEvent] | None = None
Fires when a chart line is hovered or clicked.
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) and defaults to 1.0
.
page
#
The page (of type Page
or PageView
) 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
.
point_line_end
#
point_line_end: Number | None = None
The end of the vertical line drawn at selected point position.
Defaults to data point's y
value.
point_line_start
#
point_line_start: Number | None = None
The start of the vertical line drawn under the selected point.
Defaults to chart's bottom edge.
right
#
Effective inside Stack
only. The distance
that the child's right edge is inset from the right of the stack.
right_axis
#
Defines the appearance of the right axis, its title and labels.
rotate
#
rotate: RotateValue | None = None
Transforms control using a rotation around the center.
The value of rotate
property could be one of the following types:
number
- a rotation in clockwise radians. Full circle360°
ismath.pi * 2
radians,90°
ispi / 2
,45°
ispi / 4
, etc.transform.Rotate
- allows to specify rotationangle
as well asalignment
- the location of rotation center.
For example:
scale
#
scale: ScaleValue | None = None
Scale control along the 2D plane. Default scale factor is 1.0
- control is not
scaled. 0.5
- the control is twice smaller, 2.0
- the control is twice larger.
Different scale multipliers can be specified for x
and y
axis, but setting
Control.scale
property to an instance of transform.Scale
class.
Either scale
or scale_x
and scale_y
could be specified, but not all of them,
for example:
tooltip
#
tooltip: LineChartTooltip = field(
default_factory=lambda: LineChartTooltip()
)
The tooltip configuration for this chart.
top
#
Effective inside Stack
only. The distance
that the child's top edge is inset from the top of the stack.
top_axis
#
Defines the appearance of the top axis, its title and labels.
vertical_grid_lines
#
vertical_grid_lines: ChartGridLines | None = None
Controls drawing of chart's vertical lines.
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.
Examples#
Example 1#
import flet as ft
import flet_charts as fch
class State:
toggled = True
state = State()
def main(page: ft.Page):
data_1 = [
fch.LineChartData(
stroke_width=8,
color=ft.Colors.LIGHT_GREEN,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 1),
fch.LineChartDataPoint(3, 1.5),
fch.LineChartDataPoint(5, 1.4),
fch.LineChartDataPoint(7, 3.4),
fch.LineChartDataPoint(10, 2),
fch.LineChartDataPoint(12, 2.2),
fch.LineChartDataPoint(13, 1.8),
],
),
fch.LineChartData(
color=ft.Colors.PINK,
below_line_bgcolor=ft.Colors.with_opacity(0, ft.Colors.PINK),
stroke_width=8,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 1),
fch.LineChartDataPoint(3, 2.8),
fch.LineChartDataPoint(7, 1.2),
fch.LineChartDataPoint(10, 2.8),
fch.LineChartDataPoint(12, 2.6),
fch.LineChartDataPoint(13, 3.9),
],
),
fch.LineChartData(
color=ft.Colors.CYAN,
stroke_width=8,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 2.8),
fch.LineChartDataPoint(3, 1.9),
fch.LineChartDataPoint(6, 3),
fch.LineChartDataPoint(10, 1.3),
fch.LineChartDataPoint(13, 2.5),
],
),
]
data_2 = [
fch.LineChartData(
stroke_width=4,
color=ft.Colors.with_opacity(0.5, ft.Colors.LIGHT_GREEN),
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 1),
fch.LineChartDataPoint(3, 4),
fch.LineChartDataPoint(5, 1.8),
fch.LineChartDataPoint(7, 5),
fch.LineChartDataPoint(10, 2),
fch.LineChartDataPoint(12, 2.2),
fch.LineChartDataPoint(13, 1.8),
],
),
fch.LineChartData(
color=ft.Colors.with_opacity(0.5, ft.Colors.PINK),
below_line_bgcolor=ft.Colors.with_opacity(0.2, ft.Colors.PINK),
stroke_width=4,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 1),
fch.LineChartDataPoint(3, 2.8),
fch.LineChartDataPoint(7, 1.2),
fch.LineChartDataPoint(10, 2.8),
fch.LineChartDataPoint(12, 2.6),
fch.LineChartDataPoint(13, 3.9),
],
),
fch.LineChartData(
color=ft.Colors.with_opacity(0.5, ft.Colors.CYAN),
stroke_width=4,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(1, 3.8),
fch.LineChartDataPoint(3, 1.9),
fch.LineChartDataPoint(6, 5),
fch.LineChartDataPoint(10, 3.3),
fch.LineChartDataPoint(13, 4.5),
],
),
]
chart = fch.LineChart(
data_series=data_1,
border=ft.Border(
bottom=ft.BorderSide(4, ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE))
),
tooltip=fch.LineChartTooltip(
bgcolor=ft.Colors.with_opacity(0.8, ft.Colors.BLUE_GREY)
),
min_y=0,
max_y=4,
min_x=0,
max_x=14,
expand=True,
right_axis=fch.ChartAxis(show_labels=False),
left_axis=fch.ChartAxis(
label_size=40,
labels=[
fch.ChartAxisLabel(
value=1,
label=ft.Text("1m", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=2,
label=ft.Text("2m", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=3,
label=ft.Text("3m", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=4,
label=ft.Text("4m", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=5,
label=ft.Text("5m", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=6,
label=ft.Text("6m", size=14, weight=ft.FontWeight.BOLD),
),
],
),
bottom_axis=fch.ChartAxis(
label_size=32,
labels=[
fch.ChartAxisLabel(
value=2,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="SEP",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
fch.ChartAxisLabel(
value=7,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="OCT",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
fch.ChartAxisLabel(
value=12,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="DEC",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
],
),
)
def toggle_data(e: ft.Event[ft.IconButton]):
if state.toggled:
chart.data_series = data_2
chart.data_series[2].point = True
chart.max_y = 6
chart.interactive = False
else:
chart.data_series = data_1
chart.max_y = 4
chart.interactive = True
state.toggled = not state.toggled
chart.update()
page.add(ft.IconButton(ft.Icons.REFRESH, on_click=toggle_data), chart)
ft.run(main)
Example 2#
import flet as ft
import flet_charts as fch
class State:
toggled = True
state = State()
def main(page: ft.Page):
data_1 = [
fch.LineChartData(
stroke_width=5,
color=ft.Colors.CYAN,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(0, 3),
fch.LineChartDataPoint(2.6, 2),
fch.LineChartDataPoint(4.9, 5),
fch.LineChartDataPoint(6.8, 3.1),
fch.LineChartDataPoint(8, 4),
fch.LineChartDataPoint(9.5, 3),
fch.LineChartDataPoint(11, 4),
],
)
]
data_2 = [
fch.LineChartData(
stroke_width=5,
color=ft.Colors.CYAN,
curved=True,
rounded_stroke_cap=True,
points=[
fch.LineChartDataPoint(0, 3.44),
fch.LineChartDataPoint(2.6, 3.44),
fch.LineChartDataPoint(4.9, 3.44),
fch.LineChartDataPoint(6.8, 3.44),
fch.LineChartDataPoint(8, 3.44),
fch.LineChartDataPoint(9.5, 3.44),
fch.LineChartDataPoint(11, 3.44),
],
)
]
chart = fch.LineChart(
expand=True,
data_series=data_1,
min_y=0,
max_y=6,
min_x=0,
max_x=11,
border=ft.Border.all(3, ft.Colors.with_opacity(0.2, ft.Colors.ON_SURFACE)),
horizontal_grid_lines=fch.ChartGridLines(
interval=1, color=ft.Colors.with_opacity(0.2, ft.Colors.ON_SURFACE), width=1
),
vertical_grid_lines=fch.ChartGridLines(
interval=1, color=ft.Colors.with_opacity(0.2, ft.Colors.ON_SURFACE), width=1
),
tooltip=fch.LineChartTooltip(
bgcolor=ft.Colors.with_opacity(0.8, ft.Colors.BLUE_GREY)
),
left_axis=fch.ChartAxis(
label_size=40,
labels=[
fch.ChartAxisLabel(
value=1,
label=ft.Text("10K", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=3,
label=ft.Text("30K", size=14, weight=ft.FontWeight.BOLD),
),
fch.ChartAxisLabel(
value=5,
label=ft.Text("50K", size=14, weight=ft.FontWeight.BOLD),
),
],
),
bottom_axis=fch.ChartAxis(
label_size=32,
labels=[
fch.ChartAxisLabel(
value=2,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="MAR",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
fch.ChartAxisLabel(
value=5,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="JUN",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
fch.ChartAxisLabel(
value=8,
label=ft.Container(
margin=ft.Margin(top=10),
content=ft.Text(
value="SEP",
size=16,
weight=ft.FontWeight.BOLD,
color=ft.Colors.with_opacity(0.5, ft.Colors.ON_SURFACE),
),
),
),
],
),
)
def toggle_data(e: ft.ControlEvent):
if state.toggled:
chart.data_series = data_2
chart.interactive = False
else:
chart.data_series = data_1
chart.interactive = True
state.toggled = not state.toggled
chart.update()
page.add(ft.ElevatedButton("avg", on_click=toggle_data), chart)
ft.run(main)