Docs
Widgets / directory

Image

IMAGE

Static or state-driven image frame for diagrams, icons or board photos.

At a glance

Default4 x 4
Minimum2 x 2
Resizeboth
Pinoptional
Interactiveno

Behavior

  • Can switch sources based on dashboard config or incoming values.
  • Useful for equipment maps, PCB shots and state illustrations.
  • Fits nicely inside richer showcase dashboards.

Firmware contract

Usually configured from the dashboard side rather than firmware logic.

On the app side this widget snaps to the 8-column square grid and uses both resizing. Its raw type is IMAGE and the matching icon token in the app is photo.fill.

Pin support: This widget mainly acts as infrastructure or service glue.

Transmission: Payload format depends on the widget type and the selected pinType.

Canvas preview

docs.widget.preview
Image
Image

Widget contract

PropertyValue
Raw typeIMAGE
Default size4 x 4
Minimum size2 x 2
Resize modeboth
Pin requirementoptional / infrastructure
Pin supportSee behavior and firmware contract above
Interactiveread-only / service
TransmissionDepends on the widget payload type

Allowed pin families

This widget is infrastructure-oriented and usually does not expose a user pin binding.

Transport path

Payload leaves the canvas through the dashboard transport and lands on the selected virtual, digital or analog endpoint.

Operational limits

Server-side behavior may still depend on board library support and project policy.

Configuration surface

  • Color, label and position are stored in the dashboard profile.
  • Use the app-side widget config sheet to tune behavior per widget type.

Limits and caveats

  • Server-side behavior may still depend on board library support and project policy.

Layout notes

Canvas footprint

4 x 4

Default footprint in the Plynx canvas before user resizing.

Resize floor

2 x 2

The minimum size accepted by the app during drag-resize.

Interaction model

Display

Whether the user edits state directly or only reads it.

Related widgets

Value Display

Fast numeric readout for single values like temperature, current or uptime.

Labeled Value

String template display with inline placeholder replacement for the current pin value.

Gauge

Circular analog-style meter for sensor values and percentages.

LCD

Character display widget inspired by classic 16x2 LCD modules.