Skip to content

Helios Web API

Version 0.10.5

Helios Web is the browser visualization layer: renderer selection, camera and interaction state, behaviors, mappers, filters, layouts, persistence, and export. The reference below is grouped by the way users usually extend or configure a visualization.

Core

The main visualization controller and primary user-facing entry points.

class Helios Main Helios Web visualization controller for one `helios-network` graph.

Constants

Named event ids, figure presets, and other exported constant surfaces.

symbol EVENTS Stable event names emitted by `Helios` instances. symbol FIGURE_EXPORT_PRESETS Built-in figure size presets for Helios exports.

Behaviors

Composable behavior modules for interaction, labels, legends, mappers, filters, interface state, and export controls.

class AppearanceBehavior Built-in behavior for global visual appearance and render quality. class Behavior Base class for reusable Helios application behaviors. symbol BEHAVIOR_IDS Ordered ids for the built-in behavior set. class BehaviorManager Runtime owner for active behavior instances on a Helios visualization. class BehaviorRegistry Registry mapping behavior ids to behavior constructors or factories. function createDefaultBehaviorRegistry Create a registry containing all built-in Helios Web behaviors. class ExporterBehavior Built-in behavior for figure export settings and preview capture. class FilterBehavior Built-in behavior for graph filtering. class HoverBehavior Built-in behavior for hover picking and hover labels. class InterfaceBehavior Built-in behavior for responsive interface and touch-oriented app state. class LabelsBehavior Built-in behavior for SVG label overlays. class LayoutBehavior Built-in behavior for choosing and controlling the active layout. class LegendsBehavior Built-in behavior for legend overlays. class MappersBehavior Built-in behavior for node and edge visual mappers. class SelectionBehavior Built-in behavior for node and edge selection state.

Layouts

Layout controllers and position delegates for static, worker, D3 force, and GPU force layouts.

class D3Force3DLayout Worker-backed layout adapter for the D3 Force 3D engine. symbol DEFAULT_LAYOUT_TUNING_MODEL Default model used to tune GPU force layout options from graph statistics. function extractLayoutTuningFeatures Extract graph features used by the layout tuning model. class GpuForceLayout GPU-backed force layout that can run through WebGPU or WebGL2 delegates. class GpuForcePositionDelegate Position delegate used by GPU force layouts. class Layout Base class for layout algorithms. class PositionDelegate Abstract source for layout positions owned outside the network buffers. function predictLayoutTuningOptions Predict layout option overrides for a network using the layout tuning model. class StaticLayout Layout that keeps existing node positions fixed. class WorkerLayout Worker-backed force or jitter layout.

Mappers

Visual attribute mapping primitives used to bind graph data to colors, sizes, opacity, and related channels.

class Mapper Low-level mapper for one node or edge visual mode. class MapperCollection Collection of named mappers for either node or edge visuals. symbol VISUAL_ATTRIBUTES Map of public mapper channel names to internal Helios visual attribute names. class VisualAttributes Ensures required visual attributes exist on the Helios network, seeds defaults, and provides helpers to apply mappers into sparse buffers.

Filters

Filter builders and behavior APIs for render-only or render-and-layout graph filtering.

class HeliosFilter Builder for reusable graph filter rule sets.

Export

Figure export presets, capability checks, PNG/SVG capture, and preview helpers.

function buildFigureExportPresetList Build export preset metadata for a viewport and renderer capability. function getFigureExportCapability Resolve renderer limits that constrain figure export dimensions. function resolveFigureExportOptions Normalize figure export options into concrete dimensions and capture flags.

Persistence

State manager, storage manager, session, preference, and envelope APIs for saving and restoring visualization state.

function applyOverridesToVisualizationState Apply sparse dotted-path overrides to a visualization state object. class BrowserStorageManager Browser storage manager backed by IndexedDB and Web Storage fallbacks. function createDefaultNetworkSource Normalize source-network metadata stored with visualization state. function createDefaultPreferencesState Normalize a preferences payload into the current public preference shape. function createDefaultUIState Normalize a UI payload into the current serializable UI state shape. function createHeliosStorageManager Create the storage manager selected by a Helios `storage` constructor option. function createMemoryIndexedDBFactory Create an in-memory IndexedDB-like factory for persistence tests. function createMemoryStorage Create an in-memory Storage-compatible object. function createPersistenceEnvelope Create a versioned persistence envelope. function diffOverrideMaps Compute sparse override differences between two flattened override maps. class DummyStorageManager In-memory storage facade used when durable persistence is disabled. function flattenVisualizationOverrides Flatten visualization state into sparse dotted override paths. class HeliosStateManager Central live state graph for Helios defaults, bindings, overrides, and reset status. class HeliosStorageManager Base storage facade for Helios state snapshots, sessions, and portable network state. class IndexedDBSessionStore Session store backed by IndexedDB. class LocalStoragePreferenceStore Preference store backed by the browser `localStorage` API. function migratePersistenceEnvelope Normalize a partial persistence object into the current envelope. function parsePersistenceEnvelope Parse and migrate persistence input. symbol PERSISTENCE_KINDS Supported persistence envelope kinds. symbol PERSISTENCE_SCHEMA_VERSION Current schema version for Helios Web persistence envelopes. class RemoteStorageManager Storage manager that delegates session records to a host-provided client. function serializePersistenceEnvelope Serialize a persistence envelope to JSON. class SessionStore Low-level session record store used by Helios storage managers. class StateBindingController Binding controller that keeps registered state entries synchronized with runtime owners. class StateTransaction Helper passed to `HeliosStateManager.transaction()` for grouped state writes. class UIAttribute Observable UI attribute descriptor used to bind controls to Helios state.

Internal

Advanced exported utilities that are usually consumed by Helios Web itself or custom integrations.

function applyCameraPose Apply a captured or merged pose to a renderer camera. function base64ToUint8Array Decode base64-encoded binary colormap data. class CameraTransitionController Time-based camera transition controller used by Helios camera animations. function captureCameraPose Capture a renderer camera into a serializable pose object. symbol colormaps Built-in color map registry grouped by source collection. function colormapToInterpolator Resolve a colormap to an interpolation function. function colormapToScheme Resolve a colormap to a discrete color scheme. function createCategoricalColormap Create a categorical palette from a colormap. function createColormapScale Create a numeric colormap scale. function createDefaultMappers Create the default node and edge mapper collections for a network. function createPanelSchemaIndicator Create a DOM indicator that reflects dirty status for a panel schema. function createYawPitchQuaternion Build a normalized camera rotation quaternion from yaw and pitch angles. function decodeColormapData Decode packed RGB colormap bytes into color tuples. symbol DEFAULT_NODE_COLORMAP Default node colormap used by Helios when no explicit node color mapper is set. function defineHeliosWebComponents Register Helios Web custom elements in a document or window. function ensureDefaultStyles Ensure the default Helios UI stylesheet is present in a document. symbol FILTERS_PANEL_SCHEMA Built-in state schema for the Filters panel. class HeliosUI Optional built-in control surface for a Helios visualization. function humanizeControlLabel Convert a state key or control identifier into a display label. symbol LABELS_PANEL_SCHEMA Built-in state schema for the Labels panel. symbol LAYOUT_PANEL_SCHEMA Built-in state schema for the Layout panel. symbol LEGENDS_PANEL_SCHEMA Built-in state schema for the Legends panel. symbol MAPPERS_PANEL_SCHEMA Built-in state schema for the Mappers panel. function mergeCameraPose Merge a partial camera pose into an existing pose. function normalizePanelSchema Normalize a panel schema into the canonical shape used by Helios UI panels. function panelSchemaKeys Return all state keys referenced by a panel schema. function panelSchemaSectionKeys Return all state keys referenced by one panel schema section. function panelSchemaSectionStatus Compute the dirty status for one panel schema section. function panelSchemaStatus Compute the dirty status for a full panel schema. class PanelStack Collapsible stack of UI subpanels used by the optional Helios UI. function resolvePanelItemLabel Resolve the display label for a panel schema item. symbol SCENE_PANEL_SCHEMA Built-in state schema for the Scene panel. symbol SELECTION_PANEL_SCHEMA Built-in state schema for the Selection panel. class TabbedPanel Small tabbed panel primitive used by the optional Helios UI.

Typed Reference

The docs build emits a structured typed reference at ../reference.json from source exports and code annotations. TypeScript declaration files are downstream artifacts and are not used as an API documentation source.

Annotation Coverage Notes

Top-level public exports without source summaries:

  • No unannotated public exports detected.

Primary public class members currently using generated fallback descriptions:

  • No generated member-summary fallbacks detected.