Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App examples overview update pull request (main) #195

Merged
merged 1 commit into from
Aug 26, 2024
Merged

App examples overview update pull request (main) #195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 67 additions & 17 deletions doc/python_examples/examples_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-list-widget)
:Tags:
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id31">![Static Badge](https://img.shields.io/badge/selection--list--widget-blue)</a>
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id32">![Static Badge](https://img.shields.io/badge/selection--list--widget-blue)</a>

</div>

Expand All @@ -135,7 +135,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#selection-element-widget)
:Tags:
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id30">![Static Badge](https://img.shields.io/badge/selection--element--widget-blue)</a>
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id31">![Static Badge](https://img.shields.io/badge/selection--element--widget-blue)</a>

</div>

Expand All @@ -154,7 +154,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html#unit-widget)
:Tags:
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id38">![Static Badge](https://img.shields.io/badge/unit--widget-blue)</a>
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id39">![Static Badge](https://img.shields.io/badge/unit--widget-blue)</a>

</div>

Expand All @@ -173,7 +173,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/python_api_introduction/user_defined_dialogs.html)
:Tags:
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id43">![Static Badge](https://img.shields.io/badge/widget--properties-blue)</a>
<a href="#id6">![Static Badge](https://img.shields.io/badge/dialog-blue)</a> <a href="#id44">![Static Badge](https://img.shields.io/badge/widget--properties-blue)</a>

</div>

Expand Down Expand Up @@ -355,7 +355,7 @@ myst:
Example for SQL Database Access

:Tags:
<a href="#id34">![Static Badge](https://img.shields.io/badge/sql--database-blue)</a> <a href="#id23">![Static Badge](https://img.shields.io/badge/project--keywords-blue)</a>
<a href="#id35">![Static Badge](https://img.shields.io/badge/sql--database-blue)</a> <a href="#id23">![Static Badge](https://img.shields.io/badge/project--keywords-blue)</a>

</div>

Expand All @@ -374,7 +374,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/using_services/using_services.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/python_api.html#gom-api-services)
:Tags:
<a href="#id32">![Static Badge](https://img.shields.io/badge/service-blue)</a>
<a href="#id33">![Static Badge](https://img.shields.io/badge/service-blue)</a>

</div>

Expand All @@ -393,7 +393,7 @@ myst:
:References:
[API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/python_api.html#gom-api-settings)
:Tags:
<a href="#id33">![Static Badge](https://img.shields.io/badge/settings-blue)</a>
<a href="#id34">![Static Badge](https://img.shields.io/badge/settings-blue)</a>

</div>

Expand All @@ -410,7 +410,7 @@ myst:
App template for running unit testing and generating a test coverage report

:Tags:
<a href="#id37">![Static Badge](https://img.shields.io/badge/testing-blue)</a>
<a href="#id38">![Static Badge](https://img.shields.io/badge/testing-blue)</a>

</div>

Expand Down Expand Up @@ -667,7 +667,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#section)
:Tags:
<a href="#id29">![Static Badge](https://img.shields.io/badge/section-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id30">![Static Badge](https://img.shields.io/badge/section-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -686,7 +686,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface)
:Tags:
<a href="#id35">![Static Badge](https://img.shields.io/badge/surface-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id36">![Static Badge](https://img.shields.io/badge/surface-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -705,7 +705,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface-curve)
:Tags:
<a href="#id36">![Static Badge](https://img.shields.io/badge/surface--curve-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id37">![Static Badge](https://img.shields.io/badge/surface--curve-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -724,7 +724,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume)
:Tags:
<a href="#id44">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id39">![Static Badge](https://img.shields.io/badge/volume-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id45">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id40">![Static Badge](https://img.shields.io/badge/volume-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -743,7 +743,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-defects)
:Tags:
<a href="#id44">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id40">![Static Badge](https://img.shields.io/badge/volume--defects-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id45">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id41">![Static Badge](https://img.shields.io/badge/volume--defects-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -762,7 +762,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-region)
:Tags:
<a href="#id44">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id41">![Static Badge](https://img.shields.io/badge/volume--region-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id45">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id42">![Static Badge](https://img.shields.io/badge/volume--region-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand All @@ -781,7 +781,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#volume-section)
:Tags:
<a href="#id44">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id42">![Static Badge](https://img.shields.io/badge/volume--section-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id45">![Static Badge](https://img.shields.io/badge/xray-blue)</a> <a href="#id43">![Static Badge](https://img.shields.io/badge/volume--section-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand Down Expand Up @@ -822,7 +822,7 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_actuals.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#surface)
:Tags:
<a href="#id18">![Static Badge](https://img.shields.io/badge/mesh-blue)</a> <a href="#id35">![Static Badge](https://img.shields.io/badge/surface-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>
<a href="#id18">![Static Badge](https://img.shields.io/badge/mesh-blue)</a> <a href="#id36">![Static Badge](https://img.shields.io/badge/surface-blue)</a> <a href="#id27">![Static Badge](https://img.shields.io/badge/scripted--actual-blue)</a>

</div>

Expand Down Expand Up @@ -892,7 +892,49 @@ myst:
:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/scripted_elements/scripted_checks.html), [API](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_api/scripted_elements_api.html#scalar-surface)
:Tags:
<a href="#id28">![Static Badge](https://img.shields.io/badge/scripted--check-blue)</a> <a href="#id35">![Static Badge](https://img.shields.io/badge/surface-blue)</a>
<a href="#id28">![Static Badge](https://img.shields.io/badge/scripted--check-blue)</a> <a href="#id36">![Static Badge](https://img.shields.io/badge/surface-blue)</a>

</div>

</section>


## scripted_diagrams &mdash; Creating custom diagrams

<hr class="small-margin">
<section id="osmmapdiagram">
<div id="osmmapdiagram" class="example-block-odd">
<h3>OSMMapDiagram — <a class="reference external" href="https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_diagrams/OSMMapDiagram/doc/Documentation.md">view</a> /
<a class="reference external" href="https://software-store.zeiss.com/products/apps/OSMMapDiagram">download</a>
<a class="headerlink" href="#osmmapdiagram" title="Link to this heading"></a></h3>


:Description:
Display geolocation using a scripted diagram

:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/using_scripted_diagrams/using_scripted_diagrams.html)
:Tags:
<a href="#id34">![Static Badge](https://img.shields.io/badge/settings-blue)</a> <a href="#id29">![Static Badge](https://img.shields.io/badge/scripted--diagrams-blue)</a>

</div>

</section>

<section id="scripteddiagrambasics">
<div id="scripteddiagrambasics" class="example-block-even">
<h3>ScriptedDiagramBasics — <a class="reference external" href="https://github.com/ZEISS/zeiss-inspect-app-examples/blob/main/AppExamples/scripted_diagrams/ScriptedDiagramBasics/doc/Documentation.md">view</a> /
<a class="reference external" href="https://software-store.zeiss.com/products/apps/ScriptedDiagramBasics">download</a>
<a class="headerlink" href="#scripteddiagrambasics" title="Link to this heading"></a></h3>


:Description:
Scripted diagram basics

:References:
[HowTo](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/howtos/using_scripted_diagrams/using_scripted_diagrams.html)
:Tags:
<a href="#id34">![Static Badge](https://img.shields.io/badge/settings-blue)</a> <a href="#id29">![Static Badge](https://img.shields.io/badge/scripted--diagrams-blue)</a>

</div>

Expand Down Expand Up @@ -1087,6 +1129,12 @@ myst:
* <a href="#scriptedsurfacecheck">ScriptedSurfaceCheck</a>


### <a name="scripted-diagrams"></a>![Static Badge](https://img.shields.io/badge/scripted--diagrams-blue)

* <a href="#osmmapdiagram">OSMMapDiagram</a>
* <a href="#scripteddiagrambasics">ScriptedDiagramBasics</a>


### <a name="section"></a>![Static Badge](https://img.shields.io/badge/section-blue)

* <a href="#scriptedactualsection">ScriptedActualSection</a>
Expand All @@ -1109,6 +1157,8 @@ myst:

### <a name="settings"></a>![Static Badge](https://img.shields.io/badge/settings-blue)

* <a href="#osmmapdiagram">OSMMapDiagram</a>
* <a href="#scripteddiagrambasics">ScriptedDiagramBasics</a>
* <a href="#settingsapi">SettingsAPI</a>


Expand Down