Skip to content

Add tooltips to badges #263

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

Merged
merged 6 commits into from
Sep 19, 2025
Merged

Add tooltips to badges #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cdf6e4c
Add tooltips to badges
cjsha Nov 1, 2024
6d802d1
Simplify tooltip
cjsha Aug 21, 2025
f282ae1
Add tooltips
cjsha Aug 21, 2025
39dd253
Populate tooltips with informative content
cjsha Aug 21, 2025
3947d70
fix broken ref
cjsha Aug 22, 2025
f44f562
Separate Acquisition/Configuration and Device/Device Group properties…
cjsha Sep 19, 2025
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
44 changes: 11 additions & 33 deletions api/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,36 +26,14 @@ distinguishing when a property change will be applied to hardware and the scope
of the property's effect. The following tags are used throughout the
documentation designate these property categories:

<span class="badge oe-badge-border oe-badge-yellow"
id="configuration">Configuration</span> properties have an effect on hardware
when a workflow is started and are used to initialize the hardware state. If
they are changed while a workflow is running, they will not have an effect until
the workflow is restarted. For example, CreateContext's
<xref:OpenEphys.Onix1.CreateContext.Index> Configuration property is used to
specify the hardware prior to starting a recording, and editing this property
has no effect until the workflow is started or restarted.

<span class="badge oe-badge-border oe-badge-blue"
id="acquisition">Acquisition</span> properties have an immediate effect on
hardware when the workflow is running. For example, the
<xref:OpenEphys.Onix1.Headstage64ElectricalStimulatorTrigger.InterPulseInterval>
property allows dynamically configuring the duration between electrical
stimulation pulses. Along with its other Acquisition properties, the entire
electrical stimulation pattern can be modulated in real-time while the workflow
is running.

<span class="badge oe-badge-border oe-badge-green" id="device-group">Device
Group</span> properties are only available through [Device Group configuration
operators](xref:configure). These properties are used to configure a group of
devices. For example, ConfigureNeuropixelsV2eHeadstage's
<xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e.Port> property
configures the port name for all devices on the NeuropixelsV2e Headstage (which
in turn automatically configures each device's address).

<span class="badge oe-badge-border oe-badge-purple" id="device">Device</span>
properties are available through [Device configuration
operators](xref:device-configure) and Device Group configuration operators which
typically combine multiple individual devices. These properties are used to
configure a single device. For example, ConfigureBreakoutBoard's
<xref:OpenEphys.Onix1.ConfigureBreakoutBoard.AnalogIO> properties configure the
Breakout Board's Analog I/O device.
| Category | Description |
|----------|-------------|
| <span class="badge oe-badge-border oe-badge-yellow" id="configuration">Configuration</span> | Configuration properties have an effect on hardware when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running, they will not have an effect until the workflow is restarted. For example, CreateContext's <xref:OpenEphys.Onix1.CreateContext.Index> Configuration property is used to specify the hardware prior to starting a recording, and editing this property has no effect until the workflow is started or restarted. |
| <span class="badge oe-badge-border oe-badge-blue" id="acquisition">Acquisition</span> | Acquisition properties have an immediate effect on hardware when the workflow is running. For example, the <xref:OpenEphys.Onix1.Headstage64ElectricalStimulatorTrigger.InterPulseInterval> property allows dynamically configuring the duration between electrical stimulation pulses. Along with its other Acquisition properties, the entire electrical stimulation pattern can be modulated in real-time while the workflow is running. |

### Device Group and Device Properties

| Category | Description |
|--------- |-------------|
| <span class="badge oe-badge-border oe-badge-green" id="device-group">Device Group</span> | Device Group properties are only available through [Device Group configuration operators](xref:configure). They are used to configure a group of devices. For example, ConfigureNeuropixelsV2eHeadstage's <xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e.Port> property configures the port name for all devices on the NeuropixelsV2e Headstage (which in turn automatically configures each device's address). |
| <span class="badge oe-badge-border oe-badge-purple" id="device">Device</span> | Device properties are available through [Device configuration operators](xref:device-configure) and Device Group configuration operators which combine multiple individual device configuration operators. They are used to configure a single device. For example, ConfigureBreakoutBoard's <xref:OpenEphys.Onix1.ConfigureBreakoutBoard.AnalogIO> properties configure the Breakout Board's Analog I/O device. |
10 changes: 8 additions & 2 deletions template/partials/class.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,20 @@

{{^constituentOperator}}
<a class="xref" href="~/api/OpenEphys.Onix1.html#device-group">
<button class="badge oe-badge-border oe-badge-green">Device Group</button>
<button class="badge oe-badge-border oe-badge-green" data-bs-toggle="tooltip"
title="Device Group properties are only available through Device Group configuration operators. These properties are used to configure a group of devices.">
Device Group
</button>
</a>
<p>These are properties of the {{{oe.name}}} <a class="xref" href="~/api/configure.html">Device Group configuration operator</a>:</p>
{{/constituentOperator}}

{{#constituentOperator}}
<a class="xref" href="~/api/OpenEphys.Onix1.html#device">
<button class="badge oe-badge-border oe-badge-purple">Device</button>
<button class="badge oe-badge-border oe-badge-purple" data-bs-toggle="tooltip"
title="Device properties are available through Device configuration operators and Device Group configuration operators which typically combine multiple individual devices. These properties are used to configure a single device.">
Device
</button>
</a>
<p>{{{object}}} is a {{{type}}} device operator contained by the {{{oe.name}}} operator with the following properties:</p>
{{/constituentOperator}}
Expand Down
14 changes: 8 additions & 6 deletions template/partials/propertyTable.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,26 @@
<tr>
<td style = "white-space: nowrap;">
<code id="{{{id}}}">{{{name}}}</code>
{{#acquisition}}
{{#acquisition}}
<div>
<a class="xref" href="~/api/OpenEphys.Onix1.html#acquisition">
<button class="badge oe-badge-border oe-badge-blue">
<button class="badge oe-badge-border oe-badge-blue" data-bs-toggle="tooltip"
title="Configuration properties have an effect on hardware when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running, they will not have an effect until the workflow is restarted.">
Acquisition
</button>
</a>
</div>
{{/acquisition}}
{{#configuration}}
{{/acquisition}}
{{#configuration}}
<div>
<a class="xref" href="~/api/OpenEphys.Onix1.html#configuration">
<button class="badge oe-badge-border oe-badge-yellow">
<button class="badge oe-badge-border oe-badge-yellow" data-bs-toggle="tooltip"
title="Acquisition properties have an immediate effect on hardware when the workflow is running.">
Configuration
</button>
</a>
</div>
{{/configuration}}
{{/configuration}}
</td>
<td style = "white-space: nowrap;">
{{{type}}}
Expand Down
8 changes: 4 additions & 4 deletions template/public/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default {
title: 'Discord'
}
],
start: () => {
WorkflowContainer.init();
}
}
start: () => {
WorkflowContainer.init();
}
}
Loading