[Dev] Return fig object by VizroAI plot function

[nadijagraca]

Description

.plot() function of VizroAI now returns fig object (go.Figure type) by default. Returned fig objected can be used within Vizro dashboard.

Changes to ux:

• when run in python script, users need assign their output to a variable and add .show() in order to display the fig

Screenshot

Notice

• I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
  • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
  • I have not referenced individuals, products or companies in any commits, directly or indirectly.
  • I have not added data or restricted code in any commits, directly or indirectly.

[Anna-Xiong]

let's change the function name bit after changing it to return fig directly? something like _exec_code_and_retrieve_fig, but feel free to change it to other if it suits more

[maxschulz-COL]

We need to ensure that all the docs are up-to-date as well!

For instance, this https://vizro--438.org.readthedocs.build/projects/vizro-ai/en/438/pages/user-guides/run-vizro-ai/#python-script would need to change e.g.

I would probably rebase this PR on the big docs changes, and then see that these new changes are coherent.

Otherwise very exciting change!

[Anna-Xiong]

LGTM, thanks for addressing comments

[maxschulz-COL]

Lgtm! There are a few things that we should change in the near future, but they are not breaking, so let's delay until after the release.

This would involve:

• adjusting the docs regarding the application integration
• renaming of private methods to be more intuitive
• settling on the question of how a user should get the chart code only

[stichbury]

LGTM 🌟

Just a couple of minor tweaks as suggestions.