Skip to main content

MeganeViewerUiOptions

megane-viewer


megane-viewer / MeganeViewerUiOptions

Interface: MeganeViewerUiOptions

Defined in: components/MeganeViewer.tsx:68

Visibility switches for every piece of viewer UI that is not the 3D Viewport. Supplied to MeganeViewer through its ui prop as a partial object; omitted keys fall back to DEFAULT_MEGANE_VIEWER_UI (everything visible), so embedders only list what they want to hide.

Hiding a tool removes it from the DOM entirely — the pipeline still executes and the renderer still receives every update, so a viewer with pipelineEditor: false renders exactly the same scene, just without the editing chrome.

Properties

measurement

measurement: boolean

Defined in: components/MeganeViewer.tsx:85

Measurement readout panel plus the saved-measurement list.


perfHud

perfHud: boolean

Defined in: components/MeganeViewer.tsx:79

Perf HUD readout — atom count, bond count, draw calls, FPS.


pipelineEditor

pipelineEditor: boolean

Defined in: components/MeganeViewer.tsx:70

Pipeline editor panel on the right, with its toolbar and node graph.


resetView

resetView: boolean

Defined in: components/MeganeViewer.tsx:72

"Reset View" button in the top-left corner.


timeline

timeline: boolean

Defined in: components/MeganeViewer.tsx:81

Playback timeline (scrubber, play/pause, fps) along the bottom.


tooltip

tooltip: boolean

Defined in: components/MeganeViewer.tsx:83

Hover tooltip that follows the cursor over atoms and bonds.


viewAxes

viewAxes: boolean

Defined in: components/MeganeViewer.tsx:77

Axis-alignment buttons (±a/±b/±c while a cell is loaded, ±x/±y/±z always) under the Reset View button.