5643f8f6d2
* Added docs with new screenshots * Added doc to architecture * Added documentations to various extension modules * Added more documentation to modes * Added docs to managers * Added docs for services * Fixed deployment docs * Added white labelling documentation * Added i18n docs and measurement export
96 lines
2.1 KiB
Markdown
96 lines
2.1 KiB
Markdown
<table>
|
|
<thead>
|
|
<tr>
|
|
<th align="left">Property</th>
|
|
<th align="left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="left">
|
|
id
|
|
</td>
|
|
<td align="left">unique mode id used to refer to the mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
displayName
|
|
</td>
|
|
<td align="left">actual name of the mode being displayed for each study in the study summary panel</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="./lifeCycle.md#onModeEnter">
|
|
onModeEnter
|
|
</a>
|
|
</td>
|
|
<td align="left">hook is called when the mode is entered by the specified route</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="./lifeCycle.md#onModeExit">
|
|
onModeExit
|
|
</a>
|
|
</td>
|
|
<td align="left">hook is called when the mode exited</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
validationTags
|
|
</a>
|
|
</td>
|
|
<td align="left">validationTags</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
isValidMode
|
|
</a>
|
|
</td>
|
|
<td align="left">Checks if the mode is valid for a study</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
routes
|
|
</a>
|
|
</td>
|
|
<td align="left">route config which defines the route address, and the layout for it</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="./index.md#consuming-extensions">
|
|
extensions
|
|
</a>
|
|
</td>
|
|
<td align="left">extensions needed by the mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
hanging protocol
|
|
</a>
|
|
</td>
|
|
<td align="left">list of hanging protocols that the mode should have access to</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
sopClassHandlers
|
|
</a>
|
|
</td>
|
|
<td align="left">list of SOPClass modules needed by the mode </td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left">
|
|
<a href="">
|
|
hotkeys
|
|
</a>
|
|
</td>
|
|
<td align="left">hotkeys</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|