Skip to content

Commit 27f1042

Browse files
authored
Add field unit to scalar bar title (#264)
* Add field unit to scalar bar title * Enable scalar_bar_args as kwarg
1 parent 0274a2a commit 27f1042

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

ansys/dpf/core/plotter.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@ def add_field(self, field, meshed_region=None, show_max=False, show_min=False,
131131
label_text_size=30, label_point_size=20, **kwargs):
132132
# Get the field name
133133
name = field.name.split("_")[0]
134-
kwargs.setdefault("stitle", name)
134+
unit = field.unit
135+
kwargs.setdefault("stitle", f"{name} ({unit})")
135136

136137
kwargs = self._set_scalar_bar_title(kwargs)
137138

@@ -262,7 +263,9 @@ def _set_scalar_bar_title(self, kwargs):
262263
meet_ver = meets_version(pv_version, version_to_reach)
263264
if meet_ver:
264265
# use scalar_bar_args
265-
scalar_bar_args = {'title': stitle}
266+
scalar_bar_args = kwargs.pop("scalar_bar_args", None)
267+
if not scalar_bar_args:
268+
scalar_bar_args = {'title': stitle}
266269
kwargs.setdefault("scalar_bar_args", scalar_bar_args)
267270
else:
268271
# use stitle
@@ -657,6 +660,7 @@ def plot_contour(
657660
location = field.location
658661
component_count = field.component_count
659662
name = field.name.split("_")[0]
663+
unit = field.unit
660664
break
661665

662666
if location == locations.nodal:
@@ -705,7 +709,7 @@ def plot_contour(
705709
kwargs.setdefault("nan_color", "grey")
706710

707711
# Set the scalar bar title
708-
kwargs.setdefault("stitle", name)
712+
kwargs.setdefault("stitle", f"{name} ({unit})")
709713
kwargs = self._internal_plotter._set_scalar_bar_title(kwargs)
710714

711715
# show axes

0 commit comments

Comments
 (0)