Feature/#551 Expose a metric control #1272

namnguyen20999 · 2024-05-07T10:41:45Z

Introduces the "metric" element to the project, facilitating synthetic data representation with customizable controls. Key properties include:

value: Numerical and mandatory (dynamic).
type: Static property with "none", "linear", and "circular" as valid values. Default: "circular".
min: Static numerical property defaulting to 0.
max: Static numerical property defaulting to 100.
delta: Dynamic numerical property with default None (no display).
threshold: Dynamic numerical property with default None (implying gauge).

This addition enhances data visualization capabilities, providing adaptability and precision.

Adding pytest cases for Metric.tsx components

github-actions · 2024-05-07T11:09:21Z

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
18311	16047	88%	0%	🟢

New Files

No new covered files...

Modified Files

File	Coverage	Status
taipy/gui/_renderers/factory.py	96%	🟢
TOTAL	96%	🟢

updated for commit: af4dd42 by action🐍

FredLL-Avaiga

A very good first PR
Needs a few changes but everything is there

taipy/gui/_renderers/factory.py

frontend/taipy-gui/src/components/Taipy/Metric.tsx

github-actions · 2024-05-09T09:27:02Z

Coverage report for `frontend/taipy-gui`

Branches coverage not met for global: expected >=80%, but got 62.623951182303585%

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	81.17% (+0.14% 🔼)	2587/3187
🟡	Branches	62.62% (-0.68% 🔻)	1642/2622
🟡	Functions	74.21% (+0.06% 🔼)	446/601
🟢	Lines	81.74% (+0.12% 🔼)	2413/2952

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / Dialog.tsx	80.43%	60.87%	100%	80.43%
🟡	`...` / TaipyRendered.tsx	64.58%	14.29%	50%	64.58%
🟡	`...` / index.ts	75%	26.67%	50%	74.47%
🟢	`...` / Expandable.tsx	100%	85%	100%	100%
🟢	`...` / Metric.tsx	100%	68.18%	100%	100%
🟢	`...` / PageContent.tsx	75%	100%	0%	100%
🟢	`...` / Pane.tsx	95.12%	73.81%	100%	94.87%
🟢	`...` / Part.tsx	88%	64.29%	75%	91.3%
🟡	`...` / Unregistered.tsx	62.5%	0%	0%	60%

Test suite run success

368 tests passing in 39 suites.

Report generated by 🧪jest coverage report action from af4dd42

frontend/taipy-gui/src/components/Taipy/Metric.tsx

taipy/gui/_renderers/factory.py

tests/gui/e2e/with_action/test_metric_indicator.py

… property for style

jrobinAV · 2024-05-14T06:46:58Z

I love the description you provided 😉 .
It helps both the reviewers to accelerate the review and the community to understand what will be in the next release.

Thx!

FredLL-Avaiga

another few comments

frontend/taipy-gui/src/components/Taipy/Metric.tsx

taipy/gui/viselements.json

FredLL-Avaiga

Almost there

frontend/taipy-gui/src/components/Taipy/Metric.tsx

tests/gui/e2e/__init__.py

frontend/taipy-gui/package.json

frontend/taipy-gui/src/components/Taipy/Metric.spec.tsx

frontend/taipy-gui/src/components/Taipy/Metric.tsx

frontend/taipy-gui/src/components/Taipy/index.ts

taipy/gui/_renderers/factory.py

frontend/taipy-gui/src/components/Taipy/Metric.tsx

FabienLelaquais

Very minor comments.
Well done!

tests/gui/e2e/with_action/test_metric_indicator.py

frontend/taipy-gui/src/components/Taipy/Metric.tsx

…iga/taipy into feature/#551-Exposing-metric-control

frontend/taipy-gui/src/components/Taipy/Metric.tsx

…iga/taipy into feature/#551-Exposing-metric-control

FredLL-Avaiga

Well done

Can you create another issue to update the stylekit css?
https://vscode.dev/github/Avaiga/taipy/blob/feature/%231037-date-format/frontend/taipy-gui/public/stylekit/controls/chart.css#L24

And we also need to support hover_text

FabienLelaquais

Minor readability comments.

FabienLelaquais · 2024-05-22T07:48:22Z

frontend/taipy-gui/src/components/Taipy/Metric.tsx

+            type: "indicator",
+            mode: "gauge" + (showValue ? "+number" : "")  + (delta !== undefined ? "+delta" : ""),
+            delta: {
+                reference: typeof value === 'number' && typeof delta === 'number' ? value - delta : undefined,


For better readability, I would change that to
(value === undefined || delta === undefined) ? undefined : (value - delta)
that is more efficient and more readable (value and delta ARE numbers - except when they're not).

FabienLelaquais · 2024-05-22T07:49:07Z

frontend/taipy-gui/src/components/Taipy/Metric.tsx

+            gauge: {
+                axis: {
+                    range: [
+                        typeof props.min === 'number' ? props.min : 0,


Same comment here.
The exception is 'undefined' - not (not number).

we're never sure of what we receive, I think it is safer this way.

Adding <Metric /> components to Taipy-gui.

06892d0

Adding pytest cases for Metric.tsx components

namnguyen20999 added 🖰 GUI Related to GUI ✨New feature 🔒 Staff only Can only be assigned to the Taipy R&D team labels May 7, 2024

namnguyen20999 added this to the Community 3.2 milestone May 7, 2024

namnguyen20999 requested review from dinhlongviolin1, FabienLelaquais and FredLL-Avaiga May 7, 2024 10:41

namnguyen20999 self-assigned this May 7, 2024

namnguyen20999 added 2 commits May 7, 2024 17:43

resolve conflict

b099da2

fix incorrect pytest mark

b7c0ad5

FredLL-Avaiga requested changes May 7, 2024

View reviewed changes

FredLL-Avaiga added 🟥 Priority: Critical Must be addressed as soon as possible 📝Release Notes Impacts the Release Notes or the Documentation in general labels May 7, 2024

Using useMemo instead of useState + useEffect

29ca496

FredLL-Avaiga reviewed May 10, 2024

View reviewed changes

frontend/taipy-gui/src/components/Taipy/Metric.tsx Outdated Show resolved Hide resolved

FredLL-Avaiga reviewed May 10, 2024

View reviewed changes

taipy/gui/_renderers/factory.py Outdated Show resolved Hide resolved

FredLL-Avaiga requested changes May 10, 2024

View reviewed changes

tests/gui/e2e/with_action/test_metric_indicator.py Outdated Show resolved Hide resolved

namnguyen20999 and others added 3 commits May 10, 2024 14:43

move style outside component and refactor threshold as dynamic_value

6784551

using useMemo for Plot layout & style

162b966

Merge branch 'develop' into feature/#551-Exposing-metric-control

1e24f1a

FredLL-Avaiga self-requested a review May 13, 2024 08:31

namnguyen20999 and others added 4 commits May 13, 2024 23:50

Merge branch 'develop' into feature/#551-Exposing-metric-control

04a0cb6

update min & max default type from int to string. update using height…

ede60cf

… property for style

change the property of min & max back to the number

1e0a2c1

trigger workflow

2417590

FredLL-Avaiga requested changes May 14, 2024

View reviewed changes

namnguyen20999 added 9 commits May 16, 2024 15:35

correcting the suffix for delta

d789639

remove format & format_delta

ba99a52

merge develop into US551

d2c72ea

merge develop intoUS551

83c0692

Merge branch 'develop' into feature/#551-Exposing-metric-control

f68778a

remove main.py

9122b12

fix linter

5864234

Trigger Build

2dc5d46

Merge branch 'develop' into feature/#551-Exposing-metric-control

1d4fabd

namnguyen20999 requested a review from FredLL-Avaiga May 21, 2024 07:08

This comment was marked as resolved.

Sign in to view

FredLL-Avaiga requested changes May 21, 2024

View reviewed changes

FabienLelaquais previously approved these changes May 21, 2024

View reviewed changes

tests/gui/e2e/with_action/test_metric_indicator.py Outdated Show resolved Hide resolved

frontend/taipy-gui/src/components/Taipy/Metric.tsx Outdated Show resolved Hide resolved

frontend/taipy-gui/src/components/Taipy/Metric.tsx Outdated Show resolved Hide resolved

namnguyen20999 added 2 commits May 21, 2024 17:29

adding logic to hide number + resolve review comments

b4491d6

adding default value for showValue

ccc9443

namnguyen20999 dismissed FabienLelaquais’s stale review via ccc9443 May 21, 2024 10:37

namnguyen20999 and others added 5 commits May 21, 2024 17:38

Merge branch 'develop' into feature/#551-Exposing-metric-control

ed21313

change sprintf-js back to 1.1.2

47c5061

Merge branch 'feature/#551-Exposing-metric-control' of github.com:Ava…

dc06dca

…iga/taipy into feature/#551-Exposing-metric-control

adding deps in data

2a512fc

Merge branch 'develop' into feature/#551-Exposing-metric-control

689566f

FredLL-Avaiga requested changes May 21, 2024

View reviewed changes

frontend/taipy-gui/src/components/Taipy/Metric.tsx Outdated Show resolved Hide resolved

frontend/taipy-gui/src/components/Taipy/Metric.tsx Show resolved Hide resolved

frontend/taipy-gui/src/components/Taipy/Metric.tsx Outdated Show resolved Hide resolved

namnguyen20999 added 2 commits May 22, 2024 09:57

change style & layout back to string

1bcf034

Merge branch 'feature/#551-Exposing-metric-control' of github.com:Ava…

af4dd42

…iga/taipy into feature/#551-Exposing-metric-control

FredLL-Avaiga self-requested a review May 22, 2024 07:33

namnguyen20999 requested a review from FabienLelaquais May 22, 2024 07:39

FredLL-Avaiga approved these changes May 22, 2024

View reviewed changes

FabienLelaquais approved these changes May 22, 2024

View reviewed changes

namnguyen20999 merged commit ffb6a26 into develop May 22, 2024
155 checks passed

namnguyen20999 deleted the feature/#551-Exposing-metric-control branch July 1, 2024 04:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/#551 Expose a metric control #1272

Feature/#551 Expose a metric control #1272

namnguyen20999 commented May 7, 2024 •

edited

Loading

github-actions bot commented May 7, 2024 •

edited

Loading

FredLL-Avaiga left a comment

github-actions bot commented May 9, 2024 •

edited

Loading

jrobinAV commented May 14, 2024 •

edited

Loading

FredLL-Avaiga left a comment

This comment was marked as resolved.

FredLL-Avaiga left a comment

FabienLelaquais left a comment

FredLL-Avaiga left a comment •

edited

Loading

FabienLelaquais left a comment

FabienLelaquais May 22, 2024

FabienLelaquais May 22, 2024

FredLL-Avaiga May 22, 2024

Feature/#551 Expose a metric control #1272

Feature/#551 Expose a metric control #1272

Conversation

namnguyen20999 commented May 7, 2024 • edited Loading

github-actions bot commented May 7, 2024 • edited Loading

☂️ Python Coverage

Overall Coverage

New Files

Modified Files

FredLL-Avaiga left a comment

Choose a reason for hiding this comment

github-actions bot commented May 9, 2024 • edited Loading

Coverage report for frontend/taipy-gui

Test suite run success

jrobinAV commented May 14, 2024 • edited Loading

FredLL-Avaiga left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

FredLL-Avaiga left a comment

Choose a reason for hiding this comment

FabienLelaquais left a comment

Choose a reason for hiding this comment

FredLL-Avaiga left a comment • edited Loading

Choose a reason for hiding this comment

FabienLelaquais left a comment

Choose a reason for hiding this comment

FabienLelaquais May 22, 2024

Choose a reason for hiding this comment

FabienLelaquais May 22, 2024

Choose a reason for hiding this comment

FredLL-Avaiga May 22, 2024

Choose a reason for hiding this comment

namnguyen20999 commented May 7, 2024 •

edited

Loading

github-actions bot commented May 7, 2024 •

edited

Loading

github-actions bot commented May 9, 2024 •

edited

Loading

Coverage report for `frontend/taipy-gui`

jrobinAV commented May 14, 2024 •

edited

Loading

FredLL-Avaiga left a comment •

edited

Loading