{ "description": "Typed Helios API documentation reference generated from public package boundaries and source annotations.", "packages": { "helios-network-js-wasm": { "notes": { "entry": "src/helios-network.js", "exportedSymbols": 12, "implementation": "src/js/HeliosNetwork.js" }, "symbols": [ { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "AttributeType", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const AttributeType = Object.freeze({", "source": { "line": 10, "path": "src/js/HeliosNetwork.js" }, "summary": "Enumeration of attribute types supported by the WASM network core. Values align with the constants defined in the native implementation." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "CategorySortOrder", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const CategorySortOrder = Object.freeze({", "source": { "line": 33, "path": "src/js/HeliosNetwork.js" }, "summary": "Ordering strategies used when converting string attributes to categories. Frequency ordering is useful for visualization legends; natural ordering keeps labels such as \"item2\" before \"item10\"." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "DimensionDifferenceMethod", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const DimensionDifferenceMethod = Object.freeze({", "source": { "line": 44, "path": "src/js/HeliosNetwork.js" }, "summary": "Finite-difference estimators for local and global graph dimension measures." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "NeighborDirection", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const NeighborDirection = Object.freeze({", "source": { "line": 55, "path": "src/js/HeliosNetwork.js" }, "summary": "Direction policy for neighbor traversal and degree-like measurements." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "StrengthMeasure", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const StrengthMeasure = Object.freeze({", "source": { "line": 65, "path": "src/js/HeliosNetwork.js" }, "summary": "Aggregation policy for edge-weight based node strength." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "ClusteringCoefficientVariant", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const ClusteringCoefficientVariant = Object.freeze({", "source": { "line": 76, "path": "src/js/HeliosNetwork.js" }, "summary": "Local clustering coefficient formula selector." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "MeasurementExecutionMode", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const MeasurementExecutionMode = Object.freeze({", "source": { "line": 86, "path": "src/js/HeliosNetwork.js" }, "summary": "Execution policy for native graph measurements that can run in serial or parallel." }, { "category": "Enums And Constants", "examples": [], "kind": "symbol", "methods": [], "name": "ConnectedComponentsMode", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "const ConnectedComponentsMode = Object.freeze({", "source": { "line": 96, "path": "src/js/HeliosNetwork.js" }, "summary": "Connected-component mode selector for weak or strongly connected components." }, { "category": "Classes", "examples": [], "kind": "class", "methods": [], "name": "NodeSelector", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "class NodeSelector extends Selector {", "source": { "line": 1463, "path": "src/js/HeliosNetwork.js" }, "summary": "Selector specialized for node indices." }, { "category": "Classes", "examples": [], "kind": "class", "methods": [], "name": "EdgeSelector", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "class EdgeSelector extends Selector {", "source": { "line": 1791, "path": "src/js/HeliosNetwork.js" }, "summary": "Selector specialized for edge indices." }, { "category": "Classes", "examples": [], "kind": "class", "methods": [ { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "measureLocalClusteringCoefficient", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'unweighted'", "description": "unweighted/onnela/newman", "name": "options.variant", "type": "(number|string)" }, { "attributes": "optional", "default": "null", "description": "Required for weighted variants.", "name": "options.edgeWeightAttribute", "type": "string|null" }, { "attributes": "optional", "default": "'both'", "description": "out/in/both", "name": "options.direction", "type": "(number|string)" }, { "attributes": "optional", "default": "null", "description": "Optional node subset.", "name": "options.nodes", "type": "Array|TypedArray|null" }, { "attributes": "optional", "default": "null", "description": "Optional node attribute name to store local clustering values.", "name": "options.outNodeAttribute", "type": "string|null" } ], "remarks": "", "returns": { "description": "", "type": "{nodeIndices:Uint32Array, values:Float32Array, valuesByNode:Float32Array, direction:number, variant:number}" }, "signature": "measureLocalClusteringCoefficient(options = {})", "source": { "line": 9918, "path": "src/js/HeliosNetwork.js" }, "summary": "Measures local clustering coefficients." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "measureCoreness", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'both'", "description": "out/in/both", "name": "options.direction", "type": "(number|string)" }, { "attributes": "optional", "default": "'single-thread'", "description": "auto/single-thread/parallel", "name": "options.executionMode", "type": "(number|string)" }, { "attributes": "optional", "default": "null", "description": "Optional node subset.", "name": "options.nodes", "type": "Array|TypedArray|null" }, { "attributes": "optional", "default": "null", "description": "Optional node attribute name to store coreness.", "name": "options.outNodeCorenessAttribute", "type": "string|null" } ], "remarks": "", "returns": { "description": "", "type": "{nodeIndices:Uint32Array, values:Uint32Array, valuesByNode:Uint32Array, direction:number, executionMode:number, maxCore:number}" }, "signature": "measureCoreness(options = {})", "source": { "line": 9972, "path": "src/js/HeliosNetwork.js" }, "summary": "Measures node coreness (k-core index)." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "createCorenessSession", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'both'", "description": "out/in/both", "name": "options.direction", "type": "(number|string)" }, { "attributes": "optional", "default": "'single-thread'", "description": "auto/single-thread/parallel", "name": "options.executionMode", "type": "(number|string)" }, { "attributes": "optional", "default": "null", "description": "Optional node subset for finalize() return payload.", "name": "options.nodes", "type": "Array|TypedArray|null" }, { "attributes": "optional", "default": "null", "description": "Optional node attribute to write coreness in finalize().", "name": "options.outNodeCorenessAttribute", "type": "string|null" } ], "remarks": "", "returns": { "description": "Session handle.", "type": "CorenessSession" }, "signature": "createCorenessSession(options = {})", "source": { "line": 10042, "path": "src/js/HeliosNetwork.js" }, "summary": "Creates a steppable coreness session for incremental execution. Run `session.step({budget})` in a loop until `phase` becomes `3` (done), then call `session.finalize()` to retrieve coreness values." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "createLeidenSession", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "1", "description": "Modularity resolution parameter (gamma).", "name": "options.resolution", "type": "number" }, { "attributes": "optional", "default": "null", "description": "Edge weight attribute name (dimension 1).", "name": "options.edgeWeightAttribute", "type": "string|null" }, { "attributes": "optional", "default": "0", "description": "RNG seed (0 uses a default seed).", "name": "options.seed", "type": "number" }, { "attributes": "optional", "default": "32", "description": "Maximum aggregation levels.", "name": "options.maxLevels", "type": "number" }, { "attributes": "optional", "default": "8", "description": "Max local-moving passes per phase.", "name": "options.maxPasses", "type": "number" }, { "attributes": "optional", "default": "", "description": "Alias for `maxPasses` (`passes` takes precedence when both are set).", "name": "options.passes", "type": "number" }, { "attributes": "optional", "default": "'community'", "description": "Default output name for finalize().", "name": "options.outNodeCommunityAttribute", "type": "string" }, { "attributes": "optional", "default": "true", "description": "Store communities as categorical codes instead of integers.", "name": "options.categoricalCommunities", "type": "boolean" } ], "remarks": "", "returns": { "description": "Session handle.", "type": "LeidenSession" }, "signature": "createLeidenSession(options = {})", "source": { "line": 10762, "path": "src/js/HeliosNetwork.js" }, "summary": "Creates a steppable Leiden session for incremental execution. Run `session.step({budget})` in a loop until `phase` becomes `5` (done), then call `session.finalize()` to write the output attribute." } ], "name": "HeliosNetwork", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class HeliosNetwork extends BaseEventTarget {", "source": { "line": 3199, "path": "src/js/HeliosNetwork.js" }, "summary": "High-level JavaScript wrapper around the Helios WASM network implementation. Manages lifetime, attribute registration, and buffer views." }, { "category": "Methods", "examples": [], "kind": "method", "methods": [], "name": "withBufferAccess", "parameters": [ { "attributes": "", "default": "", "description": "Callback to execute.", "name": "fn", "type": "function(): T" }, { "attributes": "optional", "default": "null", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Callback result.", "type": "T" }, "signature": "withBufferAccess(fn, options = null)", "source": { "line": 3894, "path": "src/js/HeliosNetwork.js" }, "summary": "Runs a callback inside a buffer access session, ensuring cleanup even on throw." }, { "category": "Methods", "examples": [ "net\n .nodeAttribute('weight', 1)\n .nodeAttribute('label', (_current, id) => `node-${id}`, { type: 'string' });" ], "kind": "method", "methods": [], "name": "nodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Scalar, array-like values, or callback.", "name": "valueOrFn", "type": "*|function(*, number, number, HeliosNetwork): *" }, { "attributes": "optional", "default": "", "description": "Optional type, dimension, and indexing controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "This is the recommended API for normal application code. It performs\nany needed allocation before writing values, so callers do not need to manage\nWASM typed-array view lifetime directly. Use `withBufferAccess(...)` only when\nyou intentionally want the lower-level fast path for very large writes.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "nodeAttribute(name, valueOrFn, options = {})", "source": { "line": 5556, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates one node attribute and returns the network for chaining. Missing attributes are defined from `options.type` / `options.dimension`, or inferred from the provided scalar, array-like value, or callback result. Array-like values are indexed by active ordinal by default; pass `{ indexBy: 'id' }` to index them by node id instead." }, { "category": "Methods", "examples": [ "net.edgeAttribute('capacity', [10, 20, 30]);" ], "kind": "method", "methods": [], "name": "edgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Scalar, array-like values, or callback.", "name": "valueOrFn", "type": "*|function(*, number, number, HeliosNetwork): *" }, { "attributes": "optional", "default": "", "description": "Optional type, dimension, and indexing controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "Array-like values are aligned to the active edge ordinal by default.\nPass `{ indexBy: 'id' }` when your values are keyed by stable edge id instead.\nFor bulk streaming writes into existing typed arrays, use the explicit buffer API.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "edgeAttribute(name, valueOrFn, options = {})", "source": { "line": 5573, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates one edge attribute and returns the network for chaining." }, { "category": "Methods", "examples": [ "net.nodeAttributes(['x', 'y'], (_current, _id, ordinal) => [ordinal, ordinal * 2]);" ], "kind": "method", "methods": [], "name": "nodeAttributes", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifiers.", "name": "names", "type": "string[]" }, { "attributes": "", "default": "", "description": "Sources for each attribute.", "name": "valuesOrFn", "type": "Object|Array|function(Object, number, number, HeliosNetwork): (Array|Object)" }, { "attributes": "optional", "default": "", "description": "Optional type, dimension, and indexing controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "Use this when multiple node attributes come from the same row,\nparser, or derived calculation. The callback receives current values, node id,\nactive ordinal, and the network, and may return either an array aligned with\n`names` or an object keyed by attribute name.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "nodeAttributes(names, valuesOrFn, options = {})", "source": { "line": 5595, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates several node attributes and returns the network for chaining. `valuesOrFn` may be an object keyed by attribute name, an array of per-attribute scalar values, or a callback returning either an array aligned with `names` or an object keyed by attribute name." }, { "category": "Methods", "examples": [ "net.edgeAttributes(['weight', 'visible'], { weight: [1, 2], visible: true });" ], "kind": "method", "methods": [], "name": "edgeAttributes", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifiers.", "name": "names", "type": "string[]" }, { "attributes": "", "default": "", "description": "Sources for each attribute.", "name": "valuesOrFn", "type": "Object|Array|function(Object, number, number, HeliosNetwork): (Array|Object)" }, { "attributes": "optional", "default": "", "description": "Optional type, dimension, and indexing controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "Use this when edge attributes are loaded from edge-table rows or\ngenerated together. The helper keeps schema definition, value conversion, and\nversion updates in one call.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "edgeAttributes(names, valuesOrFn, options = {})", "source": { "line": 5612, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates several edge attributes and returns the network for chaining." }, { "category": "Methods", "examples": [ "net\n .networkAttribute('title', 'Example graph')\n .networkAttribute('bounds', [0, 1], { type: 'float', dimension: 2 });" ], "kind": "method", "methods": [], "name": "networkAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Scalar, vector, or callback.", "name": "valueOrFn", "type": "*|function(*, number, number, HeliosNetwork): *" }, { "attributes": "optional", "default": "", "description": "Optional type and dimension controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "Network attributes store graph-wide metadata such as titles,\ncoordinate bounds, import provenance, or visualization defaults. They have one\nlogical value and do not iterate over nodes or edges.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "networkAttribute(name, valueOrFn, options = {})", "source": { "line": 5635, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates one network-level attribute and returns the network for chaining. Network attributes store one graph-wide value at id/ordinal `0`. Missing attributes are defined from `options.type` / `options.dimension`, or inferred from the provided value or callback result." }, { "category": "Methods", "examples": [ "net.networkAttributes(['title', 'version'], { title: 'Example', version: 1 });" ], "kind": "method", "methods": [], "name": "networkAttributes", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifiers.", "name": "names", "type": "string[]" }, { "attributes": "", "default": "", "description": "Sources for each attribute.", "name": "valuesOrFn", "type": "Object|Array|function(Object, number, number, HeliosNetwork): (Array|Object)" }, { "attributes": "optional", "default": "", "description": "Optional type and dimension controls.", "name": "options", "type": "AttributeWriteOptions" } ], "remarks": "Use this for compact graph-wide metadata updates, for example when\nloading a saved dataset and setting title, source, units, and bounds together.", "returns": { "description": "This network.", "type": "HeliosNetwork" }, "signature": "networkAttributes(names, valuesOrFn, options = {})", "source": { "line": 5655, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines or updates several network-level attributes and returns the network for chaining. `valuesOrFn` may be an object keyed by attribute name, an array aligned with `names`, or a callback returning either an array aligned with `names` or an object keyed by attribute name." }, { "category": "Methods", "examples": [ "import HeliosNetwork, { AttributeType } from 'helios-network';\nconst net = await HeliosNetwork.create({ initialNodes: 2 });\nnet.defineNodeAttribute('weight', AttributeType.Float);\nnet.withBufferAccess(() => {\n const weightBuffer = net.getNodeAttributeBuffer('weight').view;\n weightBuffer[0] = 1.5;\n});" ], "kind": "method", "methods": [], "name": "defineNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Attribute type constant.", "name": "type", "type": "AttributeType" }, { "attributes": "optional", "default": "1", "description": "Number of elements per node.", "name": "dimension", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "defineNodeAttribute(name, type, dimension = 1)", "source": { "line": 5678, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines a node attribute backed by linear WASM memory." }, { "category": "Methods", "examples": [ "const net = await HeliosNetwork.create();\nnet.addNodes(2);\nnet.defineEdgeAttribute('capacity', AttributeType.Integer);\nconst edges = net.addEdges([[0, 1]]);\nnet.withBufferAccess(() => {\n const capacity = net.getEdgeAttributeBuffer('capacity').view;\n capacity[edges[0]] = 10;\n});" ], "kind": "method", "methods": [], "name": "defineEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Attribute type constant.", "name": "type", "type": "AttributeType" }, { "attributes": "optional", "default": "1", "description": "Number of elements per edge.", "name": "dimension", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "defineEdgeAttribute(name, type, dimension = 1)", "source": { "line": 5700, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines an edge attribute backed by linear WASM memory." }, { "category": "Methods", "examples": [ "const net = await HeliosNetwork.create();\nnet.defineNetworkAttribute('temperature', AttributeType.Float);\nnet.withBufferAccess(() => {\n const networkValues = net.getNetworkAttributeBuffer('temperature').view;\n networkValues[0] = 21.5;\n});" ], "kind": "method", "methods": [], "name": "defineNetworkAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Attribute type constant.", "name": "type", "type": "AttributeType" }, { "attributes": "optional", "default": "1", "description": "Number of elements per network (capacity is always 1).", "name": "dimension", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "defineNetworkAttribute(name, type, dimension = 1)", "source": { "line": 5720, "path": "src/js/HeliosNetwork.js" }, "summary": "Defines a network-level attribute backed by linear WASM memory." }, { "category": "Methods", "examples": [ "const net = await HeliosNetwork.create();\nnet.defineNodeAttribute('flag', AttributeType.Boolean);\nconst nodes = net.addNodes(1);\nnet.withBufferAccess(() => {\n const attribute = net.getNodeAttributeBuffer('flag');\n attribute.view[nodes[0]] = 1;\n});" ], "kind": "method", "methods": [], "name": "getNodeAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "Wrapper providing type information and buffer helpers.", "type": "Object" }, "signature": "getNodeAttributeBuffer(name)", "source": { "line": 6123, "path": "src/js/HeliosNetwork.js" }, "summary": "Retrieves a wrapper around the node attribute buffer." }, { "category": "Methods", "examples": [ "const net = await HeliosNetwork.create();\nnet.addNodes(2);\nnet.defineEdgeAttribute('capacity', AttributeType.Double);\nconst edges = net.addEdges([[0, 1]]);\nnet.withBufferAccess(() => {\n const attribute = net.getEdgeAttributeBuffer('capacity');\n attribute.view[edges[0]] = 12.5;\n});" ], "kind": "method", "methods": [], "name": "getEdgeAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "Wrapper providing type information and buffer helpers.", "type": "Object" }, "signature": "getEdgeAttributeBuffer(name)", "source": { "line": 6143, "path": "src/js/HeliosNetwork.js" }, "summary": "Retrieves a wrapper around the edge attribute buffer." }, { "category": "Methods", "examples": [ "const net = await HeliosNetwork.create();\nnet.defineNetworkAttribute('version', AttributeType.UnsignedInteger);\nnet.withBufferAccess(() => {\n const attribute = net.getNetworkAttributeBuffer('version');\n attribute.view[0] = 1;\n});" ], "kind": "method", "methods": [], "name": "getNetworkAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Attribute identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "Wrapper providing type information and buffer helpers.", "type": "Object" }, "signature": "getNetworkAttributeBuffer(name)", "source": { "line": 6161, "path": "src/js/HeliosNetwork.js" }, "summary": "Retrieves a wrapper around the network attribute buffer." } ], "title": "Helios Network JS/WASM", "version": "0.6.0" }, "helios-network-native-c": { "notes": { "exportedFunctions": 160, "includeDir": "src/native/include/helios" }, "symbols": [ { "category": "Queries", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSelectNodesByQuery", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring query argument.", "name": "const CXString query", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSelectNodesByQuery(CXNetworkRef network, const CXString query, CXNodeSelectorRef selector);", "source": { "line": 213, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Evaluates a query string against the network, populating the provided selector. Returns CXFalse on parse or evaluation errors. Use CXNetworkQueryLastError* to retrieve details about the last failure." }, { "category": "Queries", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSelectEdgesByQuery", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring query argument.", "name": "const CXString query", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSelectEdgesByQuery(CXNetworkRef network, const CXString query, CXEdgeSelectorRef selector);", "source": { "line": 215, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Evaluates a query string against edges, populating the provided edge selector." }, { "category": "Queries", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkQueryLastErrorMessage", "parameters": [ { "attributes": "", "default": "", "description": "Void argument.", "name": "void", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXString CXNetworkQueryLastErrorMessage(void);", "source": { "line": 217, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the most recent query parser/evaluator error message for this thread." }, { "category": "Queries", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkQueryLastErrorOffset", "parameters": [ { "attributes": "", "default": "", "description": "Void argument.", "name": "void", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkQueryLastErrorOffset(void);", "source": { "line": 219, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the byte offset for the most recent query parser/evaluator error." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkVersionString", "parameters": [ { "attributes": "", "default": "", "description": "Void argument.", "name": "void", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const char* CXNetworkVersionString(void);", "source": { "line": 223, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the semantic version string for the compiled library (e.g. \"1.2.3\")." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSerializationLastWarningMessage", "parameters": [ { "attributes": "", "default": "", "description": "Void argument.", "name": "void", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const char* CXNetworkSerializationLastWarningMessage(void);", "source": { "line": 225, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the last non-fatal serialization warning emitted by a save/load helper." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSerializationWarningClear", "parameters": [ { "attributes": "", "default": "", "description": "Void argument.", "name": "void", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXNetworkSerializationWarningClear(void);", "source": { "line": 227, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Clears the shared serialization warning buffer." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSerializationWarningAppend", "parameters": [ { "attributes": "", "default": "", "description": "Const char *fmt argument.", "name": "const char *fmt", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXNetworkSerializationWarningAppend(const char *fmt, ...);", "source": { "line": 229, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Appends a formatted message to the shared serialization warning buffer." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNewNetwork", "parameters": [ { "attributes": "", "default": "", "description": "Cxbool is directed argument.", "name": "CXBool isDirected", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNewNetwork(CXBool isDirected);", "source": { "line": 233, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Allocates a new network with default capacities." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNewNetworkWithCapacity", "parameters": [ { "attributes": "", "default": "", "description": "Cxbool is directed argument.", "name": "CXBool isDirected", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize initial node capacity argument.", "name": "CXSize initialNodeCapacity", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize initial edge capacity argument.", "name": "CXSize initialEdgeCapacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNewNetworkWithCapacity(CXBool isDirected, CXSize initialNodeCapacity, CXSize initialEdgeCapacity);", "source": { "line": 235, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Allocates a new network with explicit node/edge capacities." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXFreeNetwork", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXFreeNetwork(CXNetworkRef network);", "source": { "line": 237, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all resources owned by a network." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNodeCount(CXNetworkRef network);", "source": { "line": 241, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of active nodes currently stored." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkEdgeCount(CXNetworkRef network);", "source": { "line": 243, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of active edges currently stored." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeCapacity", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNodeCapacity(CXNetworkRef network);", "source": { "line": 245, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the allocated node capacity (useful for buffer sizing)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeCapacity", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkEdgeCapacity(CXNetworkRef network);", "source": { "line": 247, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the allocated edge capacity." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeFreeListCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNodeFreeListCount(CXNetworkRef network);", "source": { "line": 249, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the current node free-list size (recycled indices)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeFreeListCapacity", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNodeFreeListCapacity(CXNetworkRef network);", "source": { "line": 251, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the allocated node free-list capacity (reserved slots)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeFreeListCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkEdgeFreeListCount(CXNetworkRef network);", "source": { "line": 253, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the current edge free-list size (recycled indices)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeFreeListCapacity", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkEdgeFreeListCapacity(CXNetworkRef network);", "source": { "line": 255, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the allocated edge free-list capacity (reserved slots)." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkIsDirected", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkIsDirected(CXNetworkRef network);", "source": { "line": 257, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns CXTrue when the network treats edges as directed." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteActiveNodes", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex *dst argument.", "name": "CXIndex *dst", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize capacity argument.", "name": "CXSize capacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkWriteActiveNodes(CXNetworkRef network, CXIndex *dst, CXSize capacity);", "source": { "line": 262, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes active node indices into caller-provided storage. When `capacity` is insufficient the required size is returned and no writes occur." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkActiveNodeIndices", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXIndex* CXNetworkActiveNodeIndices(CXNetworkRef network);", "source": { "line": 264, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a stable buffer of active node indices in native active order." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkActiveNodeIndexCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkActiveNodeIndexCount(CXNetworkRef network);", "source": { "line": 266, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of entries in the stable active node index buffer." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkPromoteActiveNodesToRenderEnd", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed start argument.", "name": "CXSize *changedStart", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed count argument.", "name": "CXSize *changedCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkPromoteActiveNodesToRenderEnd( CXNetworkRef network, const CXIndex *indices, CXSize count, CXSize *changedStart, CXSize *changedCount );", "source": { "line": 274, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Moves active node indices to the end of the native active order, preserving batch order." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteActiveEdges", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex *dst argument.", "name": "CXIndex *dst", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize capacity argument.", "name": "CXSize capacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkWriteActiveEdges(CXNetworkRef network, CXIndex *dst, CXSize capacity);", "source": { "line": 279, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes active edge indices into caller-provided storage. When `capacity` is insufficient the required size is returned and no writes occur." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkActiveEdgeIndices", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXIndex* CXNetworkActiveEdgeIndices(CXNetworkRef network);", "source": { "line": 281, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a stable buffer of active edge indices in native active order." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkActiveEdgeIndexCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkActiveEdgeIndexCount(CXNetworkRef network);", "source": { "line": 283, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of entries in the stable active edge index buffer." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkPromoteActiveEdgesToRenderEnd", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed start argument.", "name": "CXSize *changedStart", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed count argument.", "name": "CXSize *changedCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkPromoteActiveEdgesToRenderEnd( CXNetworkRef network, const CXIndex *indices, CXSize count, CXSize *changedStart, CXSize *changedCount );", "source": { "line": 291, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Moves active edge indices to the end of the native active order, preserving batch order." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkPromoteActiveEdgesForNodesToRenderEnd", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *node indices argument.", "name": "const CXIndex *nodeIndices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed start argument.", "name": "CXSize *changedStart", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *changed count argument.", "name": "CXSize *changedCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkPromoteActiveEdgesForNodesToRenderEnd( CXNetworkRef network, const CXIndex *nodeIndices, CXSize nodeCount, CXNeighborDirection direction, CXSize *changedStart, CXSize *changedCount );", "source": { "line": 300, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Moves active edges incident to the supplied active nodes to the end of the native active edge order." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteActiveEdgeSegments", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const float *positions argument.", "name": "const float *positions", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize components per node argument.", "name": "CXSize componentsPerNode", "type": "" }, { "attributes": "", "default": "", "description": "Float *dst segments argument.", "name": "float *dstSegments", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize dst capacity edges argument.", "name": "CXSize dstCapacityEdges", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkWriteActiveEdgeSegments( CXNetworkRef network, const float *positions, CXSize componentsPerNode, float *dstSegments, CXSize dstCapacityEdges );", "source": { "line": 314, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes two position vectors per active edge directly into the provided buffer. `componentsPerNode` describes how many floats to copy per endpoint (commonly 4 for vec4 data). Returns the number of edges that would be written; when `dstCapacityEdges` is too small, the required count is returned and no writes occur." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteActiveEdgeNodeAttributes", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const uint8 t *node attributes argument.", "name": "const uint8_t *nodeAttributes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize components per node argument.", "name": "CXSize componentsPerNode", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize component size bytes argument.", "name": "CXSize componentSizeBytes", "type": "" }, { "attributes": "", "default": "", "description": "Uint8 t *dst argument.", "name": "uint8_t *dst", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize dst capacity edges argument.", "name": "CXSize dstCapacityEdges", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkWriteActiveEdgeNodeAttributes( CXNetworkRef network, const uint8_t *nodeAttributes, CXSize componentsPerNode, CXSize componentSizeBytes, uint8_t *dst, CXSize dstCapacityEdges );", "source": { "line": 331, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes `componentsPerNode` values for each endpoint of active edges from the provided node attribute buffer into a caller-managed destination. Values are copied verbatim; the caller controls element width (`componentSizeBytes`) and must ensure the typed views line up with the provided byte offsets. Returns the number of edges that would be written; when `dstCapacityEdges` is too small, the required count is returned and no writes occur." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCopyNodeAttributesToEdgeAttributes", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const uint8 t *node attributes argument.", "name": "const uint8_t *nodeAttributes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize node stride bytes argument.", "name": "CXSize nodeStrideBytes", "type": "" }, { "attributes": "", "default": "", "description": "Uint8 t *edge attributes argument.", "name": "uint8_t *edgeAttributes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize edge stride bytes argument.", "name": "CXSize edgeStrideBytes", "type": "" }, { "attributes": "", "default": "", "description": "Int endpoint mode argument.", "name": "int endpointMode", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool duplicate single endpoint argument.", "name": "CXBool duplicateSingleEndpoint", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkCopyNodeAttributesToEdgeAttributes( CXNetworkRef network, const uint8_t *nodeAttributes, CXSize nodeStrideBytes, uint8_t *edgeAttributes, CXSize edgeStrideBytes, int endpointMode, CXBool duplicateSingleEndpoint );", "source": { "line": 347, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Copies node attributes into an edge attribute buffer using the network's topology. `endpointMode` controls which endpoint is copied: -1 = both, 0 = source only, 1 = destination only. When copying a single endpoint and `duplicateSingleEndpoint` is true, the chosen endpoint is written twice sequentially (for double-width edge attributes)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkAddNodes", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex *out indices argument.", "name": "CXIndex *outIndices", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkAddNodes(CXNetworkRef network, CXSize count, CXIndex *outIndices);", "source": { "line": 354, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Appends `count` new nodes to the network. When `outIndices` is non-null it receives the indices assigned to the created nodes." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkRemoveNodes", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkRemoveNodes(CXNetworkRef network, const CXIndex *indices, CXSize count);", "source": { "line": 356, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes the supplied nodes, reclaiming their indices for future use." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkIsNodeActive", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex node argument.", "name": "CXIndex node", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkIsNodeActive(CXNetworkRef network, CXIndex node);", "source": { "line": 358, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns CXTrue if the given node index is currently active." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeActivityBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXBool* CXNetworkNodeActivityBuffer(CXNetworkRef network);", "source": { "line": 360, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Provides a pointer to the node activity bitmap in linear memory." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkAddEdges", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxedge *edges argument.", "name": "const CXEdge *edges", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex *out indices argument.", "name": "CXIndex *outIndices", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkAddEdges(CXNetworkRef network, const CXEdge *edges, CXSize count, CXIndex *outIndices);", "source": { "line": 367, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Inserts the provided edges, writing the new indices to `outIndices` when supplied. Edges are expressed as contiguous (from,to) pairs." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkRemoveEdges", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkRemoveEdges(CXNetworkRef network, const CXIndex *indices, CXSize count);", "source": { "line": 369, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes the supplied edges from the network." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkIsEdgeActive", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex edge argument.", "name": "CXIndex edge", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkIsEdgeActive(CXNetworkRef network, CXIndex edge);", "source": { "line": 371, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns CXTrue if the edge index is active." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeActivityBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXBool* CXNetworkEdgeActivityBuffer(CXNetworkRef network);", "source": { "line": 373, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Provides a pointer to the edge activity bitmap." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgesBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXEdge* CXNetworkEdgesBuffer(CXNetworkRef network);", "source": { "line": 375, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the flattened edge buffer `[from, to, ...]`." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateStochasticBlockModel", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize block count argument.", "name": "CXSize blockCount", "type": "" }, { "attributes": "", "default": "", "description": "Const cxsize *block sizes argument.", "name": "const CXSize *blockSizes", "type": "" }, { "attributes": "", "default": "", "description": "Const double *probabilities argument.", "name": "const double *probabilities", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateStochasticBlockModel( CXSize blockCount, const CXSize *blockSizes, const double *probabilities, CXBool directed, uint32_t seed );", "source": { "line": 388, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a stochastic block model graph from block sizes and a flattened block-to-block probability matrix." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateBarabasiAlbert", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize edges per new node argument.", "name": "CXSize edgesPerNewNode", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize initial clique size argument.", "name": "CXSize initialCliqueSize", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateBarabasiAlbert(CXSize nodeCount, CXSize edgesPerNewNode, CXSize initialCliqueSize, CXBool directed, uint32_t seed);", "source": { "line": 390, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a Barabasi-Albert preferential-attachment graph." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateWattsStrogatz", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize neighbor level argument.", "name": "CXSize neighborLevel", "type": "" }, { "attributes": "", "default": "", "description": "Double rewiring probability argument.", "name": "double rewiringProbability", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateWattsStrogatz(CXSize nodeCount, CXSize neighborLevel, double rewiringProbability, CXBool directed, uint32_t seed);", "source": { "line": 392, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a Watts-Strogatz small-world graph." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateRandomGeometric", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Double radius argument.", "name": "double radius", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateRandomGeometric(CXSize nodeCount, double radius, CXBool directed, uint32_t seed);", "source": { "line": 394, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a random geometric graph using random 2D positions and a radius cutoff." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateWaxman", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Double alpha argument.", "name": "double alpha", "type": "" }, { "attributes": "", "default": "", "description": "Double beta argument.", "name": "double beta", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateWaxman(CXSize nodeCount, double alpha, double beta, CXBool directed, uint32_t seed);", "source": { "line": 396, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a Waxman random graph using distance-weighted edge probabilities." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateConfigurationModel", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Const cxsize *degrees argument.", "name": "const CXSize *degrees", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool allow self loops argument.", "name": "CXBool allowSelfLoops", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool allow multi edges argument.", "name": "CXBool allowMultiEdges", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateConfigurationModel( CXSize nodeCount, const CXSize *degrees, CXBool directed, CXBool allowSelfLoops, CXBool allowMultiEdges, uint32_t seed );", "source": { "line": 408, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a graph with the requested degree sequence using the configuration model." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGenerateLattice2D", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize rows argument.", "name": "CXSize rows", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize columns argument.", "name": "CXSize columns", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize neighbor level argument.", "name": "CXSize neighborLevel", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool periodic argument.", "name": "CXBool periodic", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool directed argument.", "name": "CXBool directed", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNetworkRef CXNetworkGenerateLattice2D(CXSize rows, CXSize columns, CXSize neighborLevel, CXBool periodic, CXBool directed);", "source": { "line": 410, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a two-dimensional lattice graph." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkOutNeighbors", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex node argument.", "name": "CXIndex node", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNeighborContainer* CXNetworkOutNeighbors(CXNetworkRef network, CXIndex node);", "source": { "line": 414, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the outbound neighbor container for the given node." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkInNeighbors", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex node argument.", "name": "CXIndex node", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNeighborContainer* CXNetworkInNeighbors(CXNetworkRef network, CXIndex node);", "source": { "line": 416, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the inbound neighbor container for the given node." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCollectNeighbors", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *source nodes argument.", "name": "const CXIndex *sourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize source count argument.", "name": "CXSize sourceCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool include source nodes argument.", "name": "CXBool includeSourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref out node selector argument.", "name": "CXNodeSelectorRef outNodeSelector", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref out edge selector argument.", "name": "CXEdgeSelectorRef outEdgeSelector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkCollectNeighbors( CXNetworkRef network, const CXIndex *sourceNodes, CXSize sourceCount, CXNeighborDirection direction, CXBool includeSourceNodes, CXNodeSelectorRef outNodeSelector, CXEdgeSelectorRef outEdgeSelector );", "source": { "line": 433, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Collects unique one-hop neighbors for one or more source nodes. - `sourceNodes` can contain any node ids; inactive/out-of-range entries are ignored. - `direction` controls traversal for directed graphs (`out`, `in`, `both`). - `includeSourceNodes` controls whether source nodes can appear in `outNodeSelector`. - `outEdgeSelector` is optional; pass NULL to skip edge collection." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCollectNeighborsAtLevel", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *source nodes argument.", "name": "const CXIndex *sourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize source count argument.", "name": "CXSize sourceCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize level argument.", "name": "CXSize level", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool include source nodes argument.", "name": "CXBool includeSourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref out node selector argument.", "name": "CXNodeSelectorRef outNodeSelector", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref out edge selector argument.", "name": "CXEdgeSelectorRef outEdgeSelector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkCollectNeighborsAtLevel( CXNetworkRef network, const CXIndex *sourceNodes, CXSize sourceCount, CXNeighborDirection direction, CXSize level, CXBool includeSourceNodes, CXNodeSelectorRef outNodeSelector, CXEdgeSelectorRef outEdgeSelector );", "source": { "line": 450, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Collects neighbors at exactly the given concentric level (shortest-path hop distance). - `level == 0` refers to the source set itself. - `includeSourceNodes` only affects whether level-0 source nodes are included. - `outEdgeSelector` is optional; pass NULL to skip edge collection." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCollectNeighborsUpToLevel", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *source nodes argument.", "name": "const CXIndex *sourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize source count argument.", "name": "CXSize sourceCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max level argument.", "name": "CXSize maxLevel", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool include source nodes argument.", "name": "CXBool includeSourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref out node selector argument.", "name": "CXNodeSelectorRef outNodeSelector", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref out edge selector argument.", "name": "CXEdgeSelectorRef outEdgeSelector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkCollectNeighborsUpToLevel( CXNetworkRef network, const CXIndex *sourceNodes, CXSize sourceCount, CXNeighborDirection direction, CXSize maxLevel, CXBool includeSourceNodes, CXNodeSelectorRef outNodeSelector, CXEdgeSelectorRef outEdgeSelector );", "source": { "line": 466, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Collects neighbors up to (and including) the given concentric level. - `maxLevel == 0` returns only the source set when `includeSourceNodes` is true. - `outEdgeSelector` is optional; pass NULL to skip edge collection." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkDefineNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute type type argument.", "name": "CXAttributeType type", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize dimension argument.", "name": "CXSize dimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkDefineNodeAttribute(CXNetworkRef network, const CXString name, CXAttributeType type, CXSize dimension);", "source": { "line": 470, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Declares a node attribute backing buffer. Dimension defaults to 1." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkDefineEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute type type argument.", "name": "CXAttributeType type", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize dimension argument.", "name": "CXSize dimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkDefineEdgeAttribute(CXNetworkRef network, const CXString name, CXAttributeType type, CXSize dimension);", "source": { "line": 472, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Declares an edge attribute backing buffer." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkDefineNetworkAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute type type argument.", "name": "CXAttributeType type", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize dimension argument.", "name": "CXSize dimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkDefineNetworkAttribute(CXNetworkRef network, const CXString name, CXAttributeType type, CXSize dimension);", "source": { "line": 474, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Declares a network-level attribute backing buffer." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXAttributeRef CXNetworkGetNodeAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 477, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Fetches a node attribute descriptor by name." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXAttributeRef CXNetworkGetEdgeAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 479, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Fetches an edge attribute descriptor by name." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetNetworkAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXAttributeRef CXNetworkGetNetworkAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 481, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Fetches a network attribute descriptor by name." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeAttributeCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNodeAttributeCount(CXNetworkRef network);", "source": { "line": 483, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of node attributes currently defined on the network." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeAttributeCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkEdgeAttributeCount(CXNetworkRef network);", "source": { "line": 485, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of edge attributes currently defined on the network." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNetworkAttributeCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkNetworkAttributeCount(CXNetworkRef network);", "source": { "line": 487, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of network attributes currently defined on the network." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeAttributeNameAt", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize index argument.", "name": "CXSize index", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXString CXNetworkNodeAttributeNameAt(CXNetworkRef network, CXSize index);", "source": { "line": 492, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the node attribute name at `index` in the internal dictionary iteration order, or NULL when out of range." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeAttributeNameAt", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize index argument.", "name": "CXSize index", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXString CXNetworkEdgeAttributeNameAt(CXNetworkRef network, CXSize index);", "source": { "line": 494, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the edge attribute name at `index`, or NULL when out of range." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNetworkAttributeNameAt", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize index argument.", "name": "CXSize index", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN const CXString CXNetworkNetworkAttributeNameAt(CXNetworkRef network, CXSize index);", "source": { "line": 496, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the network attribute name at `index`, or NULL when out of range." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetAttributeCategoryDictionary", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXStringDictionaryRef CXNetworkGetAttributeCategoryDictionary(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 499, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the category dictionary for a categorical attribute, or NULL when unavailable." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetAttributeCategoryDictionaryCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkGetAttributeCategoryDictionaryCount(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 501, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns how many category entries are defined for a categorical attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetAttributeCategoryDictionaryEntries", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Int32 t *out ids argument.", "name": "int32_t *outIds", "type": "" }, { "attributes": "", "default": "", "description": "Cxstring *out labels argument.", "name": "CXString *outLabels", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize capacity argument.", "name": "CXSize capacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkGetAttributeCategoryDictionaryEntries( CXNetworkRef network, CXAttributeScope scope, const CXString name, int32_t *outIds, CXString *outLabels, CXSize capacity );", "source": { "line": 510, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Copies category ids and labels into caller-provided arrays." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSetAttributeCategoryDictionary", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring *labels argument.", "name": "const CXString *labels", "type": "" }, { "attributes": "", "default": "", "description": "Const int32 t *ids argument.", "name": "const int32_t *ids", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool remap existing argument.", "name": "CXBool remapExisting", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSetAttributeCategoryDictionary( CXNetworkRef network, CXAttributeScope scope, const CXString name, const CXString *labels, const int32_t *ids, CXSize count, CXBool remapExisting );", "source": { "line": 520, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Replaces or remaps the category dictionary for a categorical attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCategorizeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxcategory sort order sort order argument.", "name": "CXCategorySortOrder sortOrder", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring missing label argument.", "name": "const CXString missingLabel", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkCategorizeAttribute(CXNetworkRef network, CXAttributeScope scope, const CXString name, CXCategorySortOrder sortOrder, const CXString missingLabel);", "source": { "line": 522, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Converts a string attribute into category ids using the requested sort policy." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkDecategorizeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring missing label argument.", "name": "const CXString missingLabel", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkDecategorizeAttribute(CXNetworkRef network, CXAttributeScope scope, const CXString name, const CXString missingLabel);", "source": { "line": 524, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Converts category ids back to string labels for the named attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkDefineMultiCategoryAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool has weights argument.", "name": "CXBool hasWeights", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkDefineMultiCategoryAttribute(CXNetworkRef network, CXAttributeScope scope, const CXString name, CXBool hasWeights);", "source": { "line": 528, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Defines a multi-category attribute with optional per-entry weights." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSetMultiCategoryEntry", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex index argument.", "name": "CXIndex index", "type": "" }, { "attributes": "", "default": "", "description": "Const uint32 t *ids argument.", "name": "const uint32_t *ids", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Const float *weights argument.", "name": "const float *weights", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSetMultiCategoryEntry( CXNetworkRef network, CXAttributeScope scope, const CXString name, CXIndex index, const uint32_t *ids, CXSize count, const float *weights );", "source": { "line": 538, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes one entry of a multi-category attribute using category ids." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSetMultiCategoryEntryByLabels", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex index argument.", "name": "CXIndex index", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring *labels argument.", "name": "const CXString *labels", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" }, { "attributes": "", "default": "", "description": "Const float *weights argument.", "name": "const float *weights", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSetMultiCategoryEntryByLabels( CXNetworkRef network, CXAttributeScope scope, const CXString name, CXIndex index, const CXString *labels, CXSize count, const float *weights );", "source": { "line": 548, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Writes one entry of a multi-category attribute using category labels." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkClearMultiCategoryEntry", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex index argument.", "name": "CXIndex index", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkClearMultiCategoryEntry(CXNetworkRef network, CXAttributeScope scope, const CXString name, CXIndex index);", "source": { "line": 550, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Clears all category ids and weights for one multi-category entry." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkSetMultiCategoryBuffers", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Const uint32 t *offsets argument.", "name": "const uint32_t *offsets", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize offset count argument.", "name": "CXSize offsetCount", "type": "" }, { "attributes": "", "default": "", "description": "Const uint32 t *ids argument.", "name": "const uint32_t *ids", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize id count argument.", "name": "CXSize idCount", "type": "" }, { "attributes": "", "default": "", "description": "Const float *weights argument.", "name": "const float *weights", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkSetMultiCategoryBuffers( CXNetworkRef network, CXAttributeScope scope, const CXString name, const uint32_t *offsets, CXSize offsetCount, const uint32_t *ids, CXSize idCount, const float *weights );", "source": { "line": 561, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Replaces the packed offset/id/weight buffers for a multi-category attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryEntryRange", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex index argument.", "name": "CXIndex index", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out start argument.", "name": "CXSize *outStart", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out end argument.", "name": "CXSize *outEnd", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkGetMultiCategoryEntryRange( CXNetworkRef network, CXAttributeScope scope, const CXString name, CXIndex index, CXSize *outStart, CXSize *outEnd );", "source": { "line": 570, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the [start,end) range for one entry inside the packed multi-category buffers." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryOffsets", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint32_t* CXNetworkGetMultiCategoryOffsets(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 572, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the packed offsets buffer for a multi-category attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryIds", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint32_t* CXNetworkGetMultiCategoryIds(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 574, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the packed category id buffer for a multi-category attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryWeights", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN float* CXNetworkGetMultiCategoryWeights(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 576, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the packed weight buffer, or NULL when the attribute is unweighted." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryOffsetCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkGetMultiCategoryOffsetCount(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 578, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of offsets stored for a multi-category attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetMultiCategoryEntryCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkGetMultiCategoryEntryCount(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 580, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the number of category entries stored for a multi-category attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMultiCategoryHasWeights", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxattribute scope scope argument.", "name": "CXAttributeScope scope", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMultiCategoryHasWeights(CXNetworkRef network, CXAttributeScope scope, const CXString name);", "source": { "line": 582, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns CXTrue when the multi-category attribute stores per-entry weights." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetNodeAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void* CXNetworkGetNodeAttributeBuffer(CXNetworkRef network, const CXString name);", "source": { "line": 585, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the raw node attribute buffer for the named attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetEdgeAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void* CXNetworkGetEdgeAttributeBuffer(CXNetworkRef network, const CXString name);", "source": { "line": 587, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the raw edge attribute buffer for the named attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetNetworkAttributeBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void* CXNetworkGetNetworkAttributeBuffer(CXNetworkRef network, const CXString name);", "source": { "line": 589, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the raw network attribute buffer for the named attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXAttributeStride", "parameters": [ { "attributes": "", "default": "", "description": "Cxattribute ref attribute argument.", "name": "CXAttributeRef attribute", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXAttributeStride(CXAttributeRef attribute);", "source": { "line": 592, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the byte stride between consecutive entries of an attribute." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXAttributeData", "parameters": [ { "attributes": "", "default": "", "description": "Cxattribute ref attribute argument.", "name": "CXAttributeRef attribute", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void* CXAttributeData(CXAttributeRef attribute);", "source": { "line": 594, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the raw backing buffer for an attribute (or NULL when missing)." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXAttributeInterpolateFloatBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Cxattribute ref attribute argument.", "name": "CXAttributeRef attribute", "type": "" }, { "attributes": "", "default": "", "description": "Const float *target argument.", "name": "const float *target", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize target count argument.", "name": "CXSize targetCount", "type": "" }, { "attributes": "", "default": "", "description": "Float elapsed ms argument.", "name": "float elapsedMs", "type": "" }, { "attributes": "", "default": "", "description": "Float layout elapsed ms argument.", "name": "float layoutElapsedMs", "type": "" }, { "attributes": "", "default": "", "description": "Float smoothing argument.", "name": "float smoothing", "type": "" }, { "attributes": "", "default": "", "description": "Float min displacement ratio argument.", "name": "float minDisplacementRatio", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXAttributeInterpolateFloatBuffer( CXAttributeRef attribute, const float *target, CXSize targetCount, float elapsedMs, float layoutElapsedMs, float smoothing, float minDisplacementRatio );", "source": { "line": 609, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Interpolates a float attribute buffer toward target values and bumps the attribute version. Returns CXTrue when further interpolation steps are recommended based on minDisplacementRatio." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkCompact", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring node original index attr argument.", "name": "const CXString nodeOriginalIndexAttr", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge original index attr argument.", "name": "const CXString edgeOriginalIndexAttr", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkCompact( CXNetworkRef network, const CXString nodeOriginalIndexAttr, const CXString edgeOriginalIndexAttr );", "source": { "line": 623, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Compacts the network so that node and edge indices become contiguous starting at zero and capacities shrink to match the number of active elements. When `nodeOriginalIndexAttr` or `edgeOriginalIndexAttr` are provided, the function records the previous indices in attributes of type `CXUnsignedIntegerAttributeType`. Returns CXFalse on allocation failure or when incompatible attributes are encountered." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureDegree", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Float *out node degree argument.", "name": "float *outNodeDegree", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureDegree( CXNetworkRef network, CXNeighborDirection direction, float *outNodeDegree );", "source": { "line": 635, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Measures node degree for every node index (inactive nodes receive 0). Output buffer length must be at least `CXNetworkNodeCapacity(network)`." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureStrength", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxstrength measure measure argument.", "name": "CXStrengthMeasure measure", "type": "" }, { "attributes": "", "default": "", "description": "Float *out node strength argument.", "name": "float *outNodeStrength", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureStrength( CXNetworkRef network, const CXString edgeWeightAttribute, CXNeighborDirection direction, CXStrengthMeasure measure, float *outNodeStrength );", "source": { "line": 649, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Measures node strength from an edge weight attribute (or unit weights when `edgeWeightAttribute` is NULL/empty). Output buffer length must be at least `CXNetworkNodeCapacity(network)`." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureLocalClusteringCoefficient", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxclustering coefficient variant variant argument.", "name": "CXClusteringCoefficientVariant variant", "type": "" }, { "attributes": "", "default": "", "description": "Float *out node coefficient argument.", "name": "float *outNodeCoefficient", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureLocalClusteringCoefficient( CXNetworkRef network, const CXString edgeWeightAttribute, CXNeighborDirection direction, CXClusteringCoefficientVariant variant, float *outNodeCoefficient );", "source": { "line": 665, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Measures local clustering coefficients for all node indices. - `variant` selects the unweighted or weighted formulation. - Weighted variants read `edgeWeightAttribute` (unit weights when omitted). Output buffer length must be at least `CXNetworkNodeCapacity(network)`." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureEigenvectorCentrality", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxmeasurement execution mode execution mode argument.", "name": "CXMeasurementExecutionMode executionMode", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max iterations argument.", "name": "CXSize maxIterations", "type": "" }, { "attributes": "", "default": "", "description": "Double tolerance argument.", "name": "double tolerance", "type": "" }, { "attributes": "", "default": "", "description": "Const float *initial node centrality argument.", "name": "const float *initialNodeCentrality", "type": "" }, { "attributes": "", "default": "", "description": "Float *out node centrality argument.", "name": "float *outNodeCentrality", "type": "" }, { "attributes": "", "default": "", "description": "Double *out eigenvalue argument.", "name": "double *outEigenvalue", "type": "" }, { "attributes": "", "default": "", "description": "Double *out delta argument.", "name": "double *outDelta", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out iterations argument.", "name": "CXSize *outIterations", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool *out converged argument.", "name": "CXBool *outConverged", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureEigenvectorCentrality( CXNetworkRef network, const CXString edgeWeightAttribute, CXNeighborDirection direction, CXMeasurementExecutionMode executionMode, CXSize maxIterations, double tolerance, const float *initialNodeCentrality, float *outNodeCentrality, double *outEigenvalue, double *outDelta, CXSize *outIterations, CXBool *outConverged );", "source": { "line": 688, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Runs power-iteration eigenvector centrality. - `initialNodeCentrality`, when non-null, must have one value per node capacity index and is used as the initial vector. - `outNodeCentrality` must have one value per node capacity index. - `executionMode` allows callers to force single-thread or parallel mode." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureBetweennessCentrality", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Cxmeasurement execution mode execution mode argument.", "name": "CXMeasurementExecutionMode executionMode", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *source nodes argument.", "name": "const CXIndex *sourceNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize source count argument.", "name": "CXSize sourceCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool normalize argument.", "name": "CXBool normalize", "type": "" }, { "attributes": "", "default": "", "description": "Cxbool accumulate argument.", "name": "CXBool accumulate", "type": "" }, { "attributes": "", "default": "", "description": "Float *in out node betweenness argument.", "name": "float *inOutNodeBetweenness", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkMeasureBetweennessCentrality( CXNetworkRef network, const CXString edgeWeightAttribute, CXMeasurementExecutionMode executionMode, const CXIndex *sourceNodes, CXSize sourceCount, CXBool normalize, CXBool accumulate, float *inOutNodeBetweenness );", "source": { "line": 711, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Runs Brandes betweenness centrality (weighted when an edge weight attribute is provided, unweighted otherwise). - `sourceNodes` can restrict the set of source nodes used by the algorithm. When NULL/empty, all active nodes are used. - Set `accumulate` to CXTrue to add into `inOutNodeBetweenness` instead of clearing it first (useful for chunked stepping). - Output buffer length must be at least `CXNetworkNodeCapacity(network)`. Returns the number of source nodes actually processed." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureCoreness", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxmeasurement execution mode execution mode argument.", "name": "CXMeasurementExecutionMode executionMode", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out node coreness argument.", "name": "uint32_t *outNodeCoreness", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out max core argument.", "name": "uint32_t *outMaxCore", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureCoreness( CXNetworkRef network, CXNeighborDirection direction, CXMeasurementExecutionMode executionMode, uint32_t *outNodeCoreness, uint32_t *outMaxCore );", "source": { "line": 732, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Measures node coreness (k-core index) for all node capacity indices. - Uses iterative peeling over the chosen degree policy (`direction`). - For directed graphs: - `Out` uses outgoing degree. - `In` uses incoming degree. - `Both` uses incoming + outgoing degree. - For undirected graphs, direction is normalized to undirected degree. Output buffer length must be at least `CXNetworkNodeCapacity(network)`. Inactive nodes receive coreness 0." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXCorenessSessionCreate", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxneighbor direction direction argument.", "name": "CXNeighborDirection direction", "type": "" }, { "attributes": "", "default": "", "description": "Cxmeasurement execution mode execution mode argument.", "name": "CXMeasurementExecutionMode executionMode", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXCorenessSessionRef CXCorenessSessionCreate( CXNetworkRef network, CXNeighborDirection direction, CXMeasurementExecutionMode executionMode );", "source": { "line": 751, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a steppable coreness session." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXCorenessSessionDestroy", "parameters": [ { "attributes": "", "default": "", "description": "Cxcoreness session ref session argument.", "name": "CXCorenessSessionRef session", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXCorenessSessionDestroy(CXCorenessSessionRef session);", "source": { "line": 753, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all resources held by a coreness session." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXCorenessSessionStep", "parameters": [ { "attributes": "", "default": "", "description": "Cxcoreness session ref session argument.", "name": "CXCorenessSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize budget argument.", "name": "CXSize budget", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXCorenessPhase CXCorenessSessionStep( CXCorenessSessionRef session, CXSize budget );", "source": { "line": 758, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Advances the session by at most `budget` peeled nodes (best effort)." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXCorenessSessionGetProgress", "parameters": [ { "attributes": "", "default": "", "description": "Cxcoreness session ref session argument.", "name": "CXCorenessSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress current argument.", "name": "double *outProgressCurrent", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress total argument.", "name": "double *outProgressTotal", "type": "" }, { "attributes": "", "default": "", "description": "Cxcoreness phase *out phase argument.", "name": "CXCorenessPhase *outPhase", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out peeled nodes argument.", "name": "CXSize *outPeeledNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out active nodes argument.", "name": "CXSize *outActiveNodes", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out current core argument.", "name": "uint32_t *outCurrentCore", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out max core argument.", "name": "uint32_t *outMaxCore", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXCorenessSessionGetProgress( CXCorenessSessionRef session, double *outProgressCurrent, double *outProgressTotal, CXCorenessPhase *outPhase, CXSize *outPeeledNodes, CXSize *outActiveNodes, uint32_t *outCurrentCore, uint32_t *outMaxCore );", "source": { "line": 769, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns current progress metrics. Any output pointer may be NULL." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXCorenessSessionFinalize", "parameters": [ { "attributes": "", "default": "", "description": "Cxcoreness session ref session argument.", "name": "CXCorenessSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out node coreness argument.", "name": "uint32_t *outNodeCoreness", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize out node coreness count argument.", "name": "CXSize outNodeCorenessCount", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out max core argument.", "name": "uint32_t *outMaxCore", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXCorenessSessionFinalize( CXCorenessSessionRef session, uint32_t *outNodeCoreness, CXSize outNodeCorenessCount, uint32_t *outMaxCore );", "source": { "line": 779, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Finalizes a completed session, copying per-node coreness values into `outNodeCoreness` (length >= nodeCapacity)." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureConnectedComponents", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxconnected components mode mode argument.", "name": "CXConnectedComponentsMode mode", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out node component argument.", "name": "uint32_t *outNodeComponent", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out largest component size argument.", "name": "uint32_t *outLargestComponentSize", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkMeasureConnectedComponents( CXNetworkRef network, CXConnectedComponentsMode mode, uint32_t *outNodeComponent, uint32_t *outLargestComponentSize );", "source": { "line": 803, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Measures connected components. - Weak mode treats directed edges as undirected (weakly-connected components). - Strong mode computes strongly-connected components on directed graphs. Undirected graphs behave like weak mode. Component ids are written into `outNodeComponent` (length must be at least `CXNetworkNodeCapacity(network)`). Inactive nodes receive id `0`. Returns the number of detected components." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXConnectedComponentsSessionCreate", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxconnected components mode mode argument.", "name": "CXConnectedComponentsMode mode", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXConnectedComponentsSessionRef CXConnectedComponentsSessionCreate( CXNetworkRef network, CXConnectedComponentsMode mode );", "source": { "line": 823, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a steppable connected-components session." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXConnectedComponentsSessionDestroy", "parameters": [ { "attributes": "", "default": "", "description": "Cxconnected components session ref session argument.", "name": "CXConnectedComponentsSessionRef session", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXConnectedComponentsSessionDestroy(CXConnectedComponentsSessionRef session);", "source": { "line": 825, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all resources held by a connected-components session." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXConnectedComponentsSessionStep", "parameters": [ { "attributes": "", "default": "", "description": "Cxconnected components session ref session argument.", "name": "CXConnectedComponentsSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize budget argument.", "name": "CXSize budget", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXConnectedComponentsPhase CXConnectedComponentsSessionStep( CXConnectedComponentsSessionRef session, CXSize budget );", "source": { "line": 830, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Advances the session by at most `budget` node-visits (best effort)." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXConnectedComponentsSessionGetProgress", "parameters": [ { "attributes": "", "default": "", "description": "Cxconnected components session ref session argument.", "name": "CXConnectedComponentsSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress current argument.", "name": "double *outProgressCurrent", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress total argument.", "name": "double *outProgressTotal", "type": "" }, { "attributes": "", "default": "", "description": "Cxconnected components phase *out phase argument.", "name": "CXConnectedComponentsPhase *outPhase", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out visited nodes argument.", "name": "CXSize *outVisitedNodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out active nodes argument.", "name": "CXSize *outActiveNodes", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out component count argument.", "name": "uint32_t *outComponentCount", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out largest component size argument.", "name": "uint32_t *outLargestComponentSize", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXConnectedComponentsSessionGetProgress( CXConnectedComponentsSessionRef session, double *outProgressCurrent, double *outProgressTotal, CXConnectedComponentsPhase *outPhase, CXSize *outVisitedNodes, CXSize *outActiveNodes, uint32_t *outComponentCount, uint32_t *outLargestComponentSize );", "source": { "line": 841, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns current progress metrics. Any output pointer may be NULL." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXConnectedComponentsSessionFinalize", "parameters": [ { "attributes": "", "default": "", "description": "Cxconnected components session ref session argument.", "name": "CXConnectedComponentsSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out node component argument.", "name": "uint32_t *outNodeComponent", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize out node component count argument.", "name": "CXSize outNodeComponentCount", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out component count argument.", "name": "uint32_t *outComponentCount", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out largest component size argument.", "name": "uint32_t *outLargestComponentSize", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXConnectedComponentsSessionFinalize( CXConnectedComponentsSessionRef session, uint32_t *outNodeComponent, CXSize outNodeComponentCount, uint32_t *outComponentCount, uint32_t *outLargestComponentSize );", "source": { "line": 852, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Finalizes a completed session, copying per-node component ids into `outNodeComponent` (length >= nodeCapacity)." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureNodeDimension", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxindex node argument.", "name": "CXIndex node", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max level argument.", "name": "CXSize maxLevel", "type": "" }, { "attributes": "", "default": "", "description": "Cxdimension difference method method argument.", "name": "CXDimensionDifferenceMethod method", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize order argument.", "name": "CXSize order", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out capacity argument.", "name": "uint32_t *outCapacity", "type": "" }, { "attributes": "", "default": "", "description": "Float *out dimension argument.", "name": "float *outDimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkMeasureNodeDimension( CXNetworkRef network, CXIndex node, CXSize maxLevel, CXDimensionDifferenceMethod method, CXSize order, uint32_t *outCapacity, float *outDimension );", "source": { "line": 873, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Computes local multiscale capacity and dimension for a single node. - `maxLevel` controls the largest geodesic radius r evaluated. - `method` and `order` select the derivative estimator (FW/BK/CE/LS). - `outCapacity` and `outDimension`, when non-null, must point to buffers of length `maxLevel + 1`. Returns CXFalse when the node is invalid/inactive or on allocation failure." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkMeasureDimension", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *nodes argument.", "name": "const CXIndex *nodes", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize node count argument.", "name": "CXSize nodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max level argument.", "name": "CXSize maxLevel", "type": "" }, { "attributes": "", "default": "", "description": "Cxdimension difference method method argument.", "name": "CXDimensionDifferenceMethod method", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize order argument.", "name": "CXSize order", "type": "" }, { "attributes": "", "default": "", "description": "Float *out average capacity argument.", "name": "float *outAverageCapacity", "type": "" }, { "attributes": "", "default": "", "description": "Float *out global dimension argument.", "name": "float *outGlobalDimension", "type": "" }, { "attributes": "", "default": "", "description": "Float *out average node dimension argument.", "name": "float *outAverageNodeDimension", "type": "" }, { "attributes": "", "default": "", "description": "Float *out node dimension stddev argument.", "name": "float *outNodeDimensionStddev", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkMeasureDimension( CXNetworkRef network, const CXIndex *nodes, CXSize nodeCount, CXSize maxLevel, CXDimensionDifferenceMethod method, CXSize order, float *outAverageCapacity, float *outGlobalDimension, float *outAverageNodeDimension, float *outNodeDimensionStddev );", "source": { "line": 895, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Computes global multiscale dimension statistics over a node set. - If `nodes` is NULL or `nodeCount` is 0, all active nodes are used. - Invalid/inactive node ids in `nodes` are ignored. - Output buffers, when non-null, must each have length `maxLevel + 1`. Returns the number of nodes actually measured." }, { "category": "Measurements", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkLeidenModularity", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Double resolution argument.", "name": "double resolution", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max levels argument.", "name": "CXSize maxLevels", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max passes argument.", "name": "CXSize maxPasses", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring out node community attribute argument.", "name": "const CXString outNodeCommunityAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Double *out modularity argument.", "name": "double *outModularity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNetworkLeidenModularity( CXNetworkRef network, const CXString edgeWeightAttribute, double resolution, uint32_t seed, CXSize maxLevels, CXSize maxPasses, const CXString outNodeCommunityAttribute, double *outModularity );", "source": { "line": 920, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Runs Leiden community detection optimizing (weighted) modularity. - For undirected graphs, uses the standard modularity objective. - For directed graphs, uses the directed modularity formulation. - `resolution` corresponds to the modularity resolution parameter (gamma). - When `edgeWeightAttribute` is NULL/empty, every edge has weight 1. Writes the resulting community id into a node attribute (created when missing) of type `CXUnsignedIntegerAttributeType` and dimension 1. Returns the number of detected communities, or 0 on failure." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXLeidenSessionCreate", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring edge weight attribute argument.", "name": "const CXString edgeWeightAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Double resolution argument.", "name": "double resolution", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t seed argument.", "name": "uint32_t seed", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max levels argument.", "name": "CXSize maxLevels", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize max passes argument.", "name": "CXSize maxPasses", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXLeidenSessionRef CXLeidenSessionCreate( CXNetworkRef network, const CXString edgeWeightAttribute, double resolution, uint32_t seed, CXSize maxLevels, CXSize maxPasses );", "source": { "line": 949, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a steppable Leiden session. The network topology and relevant edge weight attribute must not change while the session is active. Returns NULL on failure." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXLeidenSessionDestroy", "parameters": [ { "attributes": "", "default": "", "description": "Cxleiden session ref session argument.", "name": "CXLeidenSessionRef session", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXLeidenSessionDestroy(CXLeidenSessionRef session);", "source": { "line": 952, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all resources held by a Leiden session." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXLeidenSessionStep", "parameters": [ { "attributes": "", "default": "", "description": "Cxleiden session ref session argument.", "name": "CXLeidenSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize budget argument.", "name": "CXSize budget", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXLeidenPhase CXLeidenSessionStep(CXLeidenSessionRef session, CXSize budget);", "source": { "line": 958, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Advances the session by at most `budget` node-visits (best effort). Returns the current phase after stepping." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXLeidenSessionGetProgress", "parameters": [ { "attributes": "", "default": "", "description": "Cxleiden session ref session argument.", "name": "CXLeidenSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress current argument.", "name": "double *outProgressCurrent", "type": "" }, { "attributes": "", "default": "", "description": "Double *out progress total argument.", "name": "double *outProgressTotal", "type": "" }, { "attributes": "", "default": "", "description": "Cxleiden phase *out phase argument.", "name": "CXLeidenPhase *outPhase", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out level argument.", "name": "CXSize *outLevel", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out max levels argument.", "name": "CXSize *outMaxLevels", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out pass argument.", "name": "CXSize *outPass", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out max passes argument.", "name": "CXSize *outMaxPasses", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out visited this pass argument.", "name": "CXSize *outVisitedThisPass", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *out node count argument.", "name": "CXSize *outNodeCount", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out community count argument.", "name": "uint32_t *outCommunityCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXLeidenSessionGetProgress( CXLeidenSessionRef session, double *outProgressCurrent, double *outProgressTotal, CXLeidenPhase *outPhase, CXSize *outLevel, CXSize *outMaxLevels, CXSize *outPass, CXSize *outMaxPasses, CXSize *outVisitedThisPass, CXSize *outNodeCount, uint32_t *outCommunityCount );", "source": { "line": 977, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns current progress metrics. Any output pointer may be NULL. `outProgressCurrent` and `outProgressTotal` are best-effort and may change as the algorithm advances (i.e. the total may be revised)." }, { "category": "Measurement Sessions", "examples": [], "kind": "function", "methods": [], "name": "CXLeidenSessionFinalize", "parameters": [ { "attributes": "", "default": "", "description": "Cxleiden session ref session argument.", "name": "CXLeidenSessionRef session", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring out node community attribute argument.", "name": "const CXString outNodeCommunityAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Double *out modularity argument.", "name": "double *outModularity", "type": "" }, { "attributes": "", "default": "", "description": "Uint32 t *out community count argument.", "name": "uint32_t *outCommunityCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXLeidenSessionFinalize( CXLeidenSessionRef session, const CXString outNodeCommunityAttribute, double *outModularity, uint32_t *outCommunityCount );", "source": { "line": 990, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Finalizes a completed session, writing the resulting community ids into a node attribute of type `CXUnsignedIntegerAttributeType` (dimension 1). Returns CXFalse if the session has not completed or on failure." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkRemoveNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkRemoveNodeAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 993, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes a sparse node attribute and its storage." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkRemoveEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkRemoveEdgeAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 995, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes a sparse edge attribute and its storage." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkRemoveNetworkAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkRemoveNetworkAttribute(CXNetworkRef network, const CXString name);", "source": { "line": 997, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes a sparse network attribute and its storage." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXAttributeVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxattribute ref attribute argument.", "name": "CXAttributeRef attribute", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXAttributeVersion(CXAttributeRef attribute);", "source": { "line": 999, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the version counter for an attribute descriptor." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkNodeTopologyVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXNetworkNodeTopologyVersion(CXNetworkRef network);", "source": { "line": 1001, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the node topology version (increments on topology edits and repacks)." }, { "category": "Buffers And Versions", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkEdgeTopologyVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXNetworkEdgeTopologyVersion(CXNetworkRef network);", "source": { "line": 1003, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the edge topology version." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkBumpNodeAttributeVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXNetworkBumpNodeAttributeVersion(CXNetworkRef network, const CXString name);", "source": { "line": 1005, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Manually bumps a node attribute version and returns the new value." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkBumpEdgeAttributeVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXNetworkBumpEdgeAttributeVersion(CXNetworkRef network, const CXString name);", "source": { "line": 1007, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Manually bumps an edge attribute version and returns the new value." }, { "category": "Attributes", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkBumpNetworkAttributeVersion", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Const cxstring name argument.", "name": "const CXString name", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN uint64_t CXNetworkBumpNetworkAttributeVersion(CXNetworkRef network, const CXString name);", "source": { "line": 1009, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Manually bumps a network attribute version and returns the new value." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetNodeValidRange", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *start argument.", "name": "CXSize *start", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *end argument.", "name": "CXSize *end", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkGetNodeValidRange(CXNetworkRef network, CXSize *start, CXSize *end);", "source": { "line": 1011, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the min/max active node indices as [start,end)." }, { "category": "Topology", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkGetEdgeValidRange", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *start argument.", "name": "CXSize *start", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize *end argument.", "name": "CXSize *end", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkGetEdgeValidRange(CXNetworkRef network, CXSize *start, CXSize *end);", "source": { "line": 1013, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns the min/max active edge indices as [start,end)." }, { "category": "Network Lifecycle", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkBuildFilteredSubgraph", "parameters": [ { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref node filter argument.", "name": "CXNodeSelectorRef nodeFilter", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref edge filter argument.", "name": "CXEdgeSelectorRef edgeFilter", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref out node selector argument.", "name": "CXNodeSelectorRef outNodeSelector", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref out edge selector argument.", "name": "CXEdgeSelectorRef outEdgeSelector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkBuildFilteredSubgraph( CXNetworkRef network, CXNodeSelectorRef nodeFilter, CXEdgeSelectorRef edgeFilter, CXNodeSelectorRef outNodeSelector, CXEdgeSelectorRef outEdgeSelector );", "source": { "line": 1030, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Builds an induced filtered subgraph from optional node/edge filters. - `nodeFilter` / `edgeFilter` may be NULL to indicate \"all active\". - Node output is always active-only. - Edge output is always active-only and induced by the resulting node set (edges with at least one endpoint outside `outNodeSelector` are removed). - Output order follows native active index order." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorCreate", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize initial capacity argument.", "name": "CXSize initialCapacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXNodeSelectorRef CXNodeSelectorCreate(CXSize initialCapacity);", "source": { "line": 1034, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a selector object for nodes with an optional initial capacity." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorDestroy", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXNodeSelectorDestroy(CXNodeSelectorRef selector);", "source": { "line": 1036, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all heap memory associated with a node selector." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorClear", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNodeSelectorClear(CXNodeSelectorRef selector);", "source": { "line": 1038, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Clears all indices from a node selector without releasing its capacity." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorFillAll", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNodeSelectorFillAll(CXNodeSelectorRef selector, CXNetworkRef network);", "source": { "line": 1040, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Populates the selector with every active node." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorFillFromArray", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNodeSelectorFillFromArray(CXNodeSelectorRef selector, const CXIndex *indices, CXSize count);", "source": { "line": 1042, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Fills the selector with the provided node indices." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorFilterActive", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNodeSelectorFilterActive(CXNodeSelectorRef selector, CXNetworkRef network);", "source": { "line": 1044, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes invalid/inactive indices in-place from a node selector." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorIntersect", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref other argument.", "name": "CXNodeSelectorRef other", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNodeSelectorIntersect(CXNodeSelectorRef selector, CXNodeSelectorRef other, CXNetworkRef network);", "source": { "line": 1046, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Intersects a node selector in-place with another selector (active indices only)." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorData", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXIndex* CXNodeSelectorData(CXNodeSelectorRef selector);", "source": { "line": 1048, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the selector's contiguous index data." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXNodeSelectorCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxnode selector ref selector argument.", "name": "CXNodeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXNodeSelectorCount(CXNodeSelectorRef selector);", "source": { "line": 1050, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns how many indices are currently stored in the selector." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorCreate", "parameters": [ { "attributes": "", "default": "", "description": "Cxsize initial capacity argument.", "name": "CXSize initialCapacity", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXEdgeSelectorRef CXEdgeSelectorCreate(CXSize initialCapacity);", "source": { "line": 1053, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Creates a selector object for edges." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorDestroy", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN void CXEdgeSelectorDestroy(CXEdgeSelectorRef selector);", "source": { "line": 1055, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Releases all heap memory associated with an edge selector." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorClear", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorClear(CXEdgeSelectorRef selector);", "source": { "line": 1057, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Clears all indices from an edge selector without releasing its capacity." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorFillAll", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorFillAll(CXEdgeSelectorRef selector, CXNetworkRef network);", "source": { "line": 1059, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Populates the selector with every active edge." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorFillFromArray", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Const cxindex *indices argument.", "name": "const CXIndex *indices", "type": "" }, { "attributes": "", "default": "", "description": "Cxsize count argument.", "name": "CXSize count", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorFillFromArray(CXEdgeSelectorRef selector, const CXIndex *indices, CXSize count);", "source": { "line": 1061, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Fills the selector with the provided edge indices." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorFilterActive", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorFilterActive(CXEdgeSelectorRef selector, CXNetworkRef network);", "source": { "line": 1063, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Removes invalid/inactive indices in-place from an edge selector." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorIntersect", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxedge selector ref other argument.", "name": "CXEdgeSelectorRef other", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorIntersect(CXEdgeSelectorRef selector, CXEdgeSelectorRef other, CXNetworkRef network);", "source": { "line": 1065, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Intersects an edge selector in-place with another selector (active indices only)." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorFilterByNodes", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" }, { "attributes": "", "default": "", "description": "Cxnetwork ref network argument.", "name": "CXNetworkRef network", "type": "" }, { "attributes": "", "default": "", "description": "Cxnode selector ref node selector argument.", "name": "CXNodeSelectorRef nodeSelector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXEdgeSelectorFilterByNodes(CXEdgeSelectorRef selector, CXNetworkRef network, CXNodeSelectorRef nodeSelector);", "source": { "line": 1067, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Keeps only active edges whose endpoints are both present in `nodeSelector`." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorData", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXIndex* CXEdgeSelectorData(CXEdgeSelectorRef selector);", "source": { "line": 1069, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns a pointer to the selector's index data." }, { "category": "Selectors", "examples": [], "kind": "function", "methods": [], "name": "CXEdgeSelectorCount", "parameters": [ { "attributes": "", "default": "", "description": "Cxedge selector ref selector argument.", "name": "CXEdgeSelectorRef selector", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXSize CXEdgeSelectorCount(CXEdgeSelectorRef selector);", "source": { "line": 1071, "path": "src/native/include/helios/CXNetwork.h" }, "summary": "Returns how many indices are currently stored in the selector." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteBXNet", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteBXNet(struct CXNetwork *network, const char *path);", "source": { "line": 76, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Writes an uncompressed binary BXNet file to disk." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteZXNet", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" }, { "attributes": "", "default": "", "description": "Int compression level argument.", "name": "int compressionLevel", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteZXNet(struct CXNetwork *network, const char *path, int compressionLevel);", "source": { "line": 78, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Writes a BGZF-compressed ZXNet file to disk." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteBXNetFiltered", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node allow argument.", "name": "const char **nodeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t node allow count argument.", "name": "size_t nodeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node ignore argument.", "name": "const char **nodeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t node ignore count argument.", "name": "size_t nodeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge allow argument.", "name": "const char **edgeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge allow count argument.", "name": "size_t edgeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge ignore argument.", "name": "const char **edgeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge ignore count argument.", "name": "size_t edgeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **network allow argument.", "name": "const char **networkAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t network allow count argument.", "name": "size_t networkAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **network ignore argument.", "name": "const char **networkIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t network ignore count argument.", "name": "size_t networkIgnoreCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteBXNetFiltered(struct CXNetwork *network, const char *path, const char **nodeAllow, size_t nodeAllowCount, const char **nodeIgnore, size_t nodeIgnoreCount, const char **edgeAllow, size_t edgeAllowCount, const char **edgeIgnore, size_t edgeIgnoreCount, const char **networkAllow, size_t networkAllowCount, const char **networkIgnore, size_t networkIgnoreCount);", "source": { "line": 93, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Writes a BXNet file while allowing or ignoring selected attributes by scope." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteZXNetFiltered", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" }, { "attributes": "", "default": "", "description": "Int compression level argument.", "name": "int compressionLevel", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node allow argument.", "name": "const char **nodeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t node allow count argument.", "name": "size_t nodeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node ignore argument.", "name": "const char **nodeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t node ignore count argument.", "name": "size_t nodeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge allow argument.", "name": "const char **edgeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge allow count argument.", "name": "size_t edgeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge ignore argument.", "name": "const char **edgeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge ignore count argument.", "name": "size_t edgeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **network allow argument.", "name": "const char **networkAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t network allow count argument.", "name": "size_t networkAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **network ignore argument.", "name": "const char **networkIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t network ignore count argument.", "name": "size_t networkIgnoreCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteZXNetFiltered(struct CXNetwork *network, const char *path, int compressionLevel, const char **nodeAllow, size_t nodeAllowCount, const char **nodeIgnore, size_t nodeIgnoreCount, const char **edgeAllow, size_t edgeAllowCount, const char **edgeIgnore, size_t edgeIgnoreCount, const char **networkAllow, size_t networkAllowCount, const char **networkIgnore, size_t networkIgnoreCount);", "source": { "line": 109, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Writes a ZXNet file while allowing or ignoring selected attributes by scope." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkReadBXNet", "parameters": [ { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN struct CXNetwork* CXNetworkReadBXNet(const char *path);", "source": { "line": 111, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Reads an uncompressed BXNet file from disk." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkReadZXNet", "parameters": [ { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN struct CXNetwork* CXNetworkReadZXNet(const char *path);", "source": { "line": 113, "path": "src/native/include/helios/CXNetworkBXNet.h" }, "summary": "Reads a BGZF-compressed ZXNet file from disk." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkReadGML", "parameters": [ { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN struct CXNetwork* CXNetworkReadGML(const char *path);", "source": { "line": 21, "path": "src/native/include/helios/CXNetworkGML.h" }, "summary": "Reads a graph from a GML file. Accepts standard GML and a looser dialect that tolerates quoted keys and unquoted scalar strings. @param path Path to the `.gml` file on disk. @return Newly allocated network when successful, otherwise NULL." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteGML", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteGML(struct CXNetwork *network, const char *path);", "source": { "line": 33, "path": "src/native/include/helios/CXNetworkGML.h" }, "summary": "Serializes a network as GML. Lossy cases (for example unsupported attribute payloads or renamed keys) are reported via `CXNetworkSerializationLastWarningMessage()`. @param network Network to serialize. @param path Output path for the `.gml` file. @return CXTrue on success, CXFalse on failure." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkReadGT", "parameters": [ { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN struct CXNetwork* CXNetworkReadGT(const char *path);", "source": { "line": 23, "path": "src/native/include/helios/CXNetworkGT.h" }, "summary": "Reads a graph-tool `.gt` binary graph file. Supports the v1 graph-tool wire format, including endian-aware topology loading and the scalar/vector property-map types that map cleanly to Helios attributes. Unsupported or lossy property maps are skipped and reported via `CXNetworkSerializationLastWarningMessage()`. @param path Path to the `.gt` file on disk. @return Newly allocated network when successful, otherwise NULL." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteGT", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteGT(struct CXNetwork *network, const char *path);", "source": { "line": 36, "path": "src/native/include/helios/CXNetworkGT.h" }, "summary": "Serializes a network as a graph-tool `.gt` binary graph file. `.gt` is an interoperability format. Helios-specific state and unsupported attributes may be skipped or converted, with warnings reported via `CXNetworkSerializationLastWarningMessage()`. @param network Network to serialize. @param path Output path for the `.gt` file. @return CXTrue on success, CXFalse on failure." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteNodeLinkJSON", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteNodeLinkJSON(struct CXNetwork *network, const char *path);", "source": { "line": 22, "path": "src/native/include/helios/CXNetworkNodeLinkJSON.h" }, "summary": "Serializes a network as node-link JSON compatible with common D3/NetworkX style payloads. Lossy cases are reported via `CXNetworkSerializationLastWarningMessage()`. @param network Network to serialize. @param path Output path for the `.json` file. @return CXTrue on success, CXFalse on failure." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkReadXNet", "parameters": [ { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN struct CXNetwork* CXNetworkReadXNet(const char *path);", "source": { "line": 18, "path": "src/native/include/helios/CXNetworkXNet.h" }, "summary": "Reads a graph from an `.xnet` (XNET 1.0.0 or legacy) container. @param path Path to the XNET file on disk. @return Newly allocated network when successful, otherwise NULL." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteXNet", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteXNet(struct CXNetwork *network, const char *path);", "source": { "line": 31, "path": "src/native/include/helios/CXNetworkXNet.h" }, "summary": "Serializes a network using the XNET 1.0.0 human-readable container. Performs compaction to ensure contiguous node and edge indices before writing. Adds the `_original_ids_` vertex attribute to preserve the original node identifiers. @param network Network to serialize. @param path Output path for the `.xnet` file. @return CXTrue on success, CXFalse on failure." }, { "category": "Serialization", "examples": [], "kind": "function", "methods": [], "name": "CXNetworkWriteXNetFiltered", "parameters": [ { "attributes": "", "default": "", "description": "Struct cxnetwork *network argument.", "name": "struct CXNetwork *network", "type": "" }, { "attributes": "", "default": "", "description": "Const char *path argument.", "name": "const char *path", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node allow argument.", "name": "const char **nodeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t node allow count argument.", "name": "size_t nodeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **node ignore argument.", "name": "const char **nodeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t node ignore count argument.", "name": "size_t nodeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge allow argument.", "name": "const char **edgeAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge allow count argument.", "name": "size_t edgeAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **edge ignore argument.", "name": "const char **edgeIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t edge ignore count argument.", "name": "size_t edgeIgnoreCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **graph allow argument.", "name": "const char **graphAllow", "type": "" }, { "attributes": "", "default": "", "description": "Size t graph allow count argument.", "name": "size_t graphAllowCount", "type": "" }, { "attributes": "", "default": "", "description": "Const char **graph ignore argument.", "name": "const char **graphIgnore", "type": "" }, { "attributes": "", "default": "", "description": "Size t graph ignore count argument.", "name": "size_t graphIgnoreCount", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "CX_EXTERN CXBool CXNetworkWriteXNetFiltered(struct CXNetwork *network, const char *path, const char **nodeAllow, size_t nodeAllowCount, const char **nodeIgnore, size_t nodeIgnoreCount, const char **edgeAllow, size_t edgeAllowCount, const char **edgeIgnore, size_t edgeIgnoreCount, const char **graphAllow, size_t graphAllowCount, const char **graphIgnore, size_t graphIgnoreCount);", "source": { "line": 54, "path": "src/native/include/helios/CXNetworkXNet.h" }, "summary": "Serializes an XNET file while allowing or ignoring selected attributes. Attribute filters are split by node, edge, and graph/network scope. @param network Network to serialize. @param path Output path for the `.xnet` file. @return CXTrue on success, CXFalse on failure." } ], "title": "Helios Network Native C", "version": "native" }, "helios-network-python": { "notes": { "publicPackage": "python/src/helios_network" }, "symbols": [ { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "AttributeType", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 11, "path": "python/src/helios_network/__init__.py" }, "summary": "Attribute storage types supported by the Helios native core." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "AttributeScope", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 29, "path": "python/src/helios_network/__init__.py" }, "summary": "Scopes where attributes can be attached: nodes, edges, or graph-level metadata." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "CategorySortOrder", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 37, "path": "python/src/helios_network/__init__.py" }, "summary": "Ordering policies for category dictionaries derived from string attributes." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "DimensionMethod", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 46, "path": "python/src/helios_network/__init__.py" }, "summary": "Finite-difference method used by multiscale dimension measurements." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "NeighborDirection", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 55, "path": "python/src/helios_network/__init__.py" }, "summary": "Traversal direction for neighbor queries and directed graph measurements." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "StrengthMeasure", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 63, "path": "python/src/helios_network/__init__.py" }, "summary": "Edge-weight aggregation used by strength measurements." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "ClusteringVariant", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 72, "path": "python/src/helios_network/__init__.py" }, "summary": "Formula selector for local clustering coefficient measurements." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "MeasurementExecutionMode", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 80, "path": "python/src/helios_network/__init__.py" }, "summary": "Execution policy for native measurements that support serial or parallel kernels." }, { "category": "Enums And Models", "examples": [], "kind": "class", "methods": [], "name": "ConnectedComponentsMode", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 87, "path": "python/src/helios_network/__init__.py" }, "summary": "Weak or strong connected-component mode." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_bxnet", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 94, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a binary `.bxnet` file into a `Network`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_zxnet", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 100, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a compressed `.zxnet` file into a `Network`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_xnet", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 106, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a text `.xnet` file into a `Network`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_gml", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 111, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a GML graph file into a `Network`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_gt", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 117, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a graph-tool `.gt` file into a `Network`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "read_node_link_json", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 123, "path": "python/src/helios_network/__init__.py" }, "summary": "Read a D3/NetworkX-style node-link JSON file into a `Network`." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_stochastic_block_model", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 142, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a stochastic block model network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_barabasi_albert", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 150, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a Barabasi-Albert preferential attachment network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_watts_strogatz", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 168, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a Watts-Strogatz small-world network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_small_world", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 186, "path": "python/src/helios_network/__init__.py" }, "summary": "Alias for `generate_watts_strogatz`." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_random_geometric", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 192, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a random geometric unit-disk network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_waxman", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 203, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a Waxman geometric network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_configuration_model", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 215, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a configuration model network from a degree sequence." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "generate_lattice_2d", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 233, "path": "python/src/helios_network/__init__.py" }, "summary": "Generate a 2D lattice network." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "to_networkx", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 57, "path": "python/src/helios_network/_conversions.py" }, "summary": "Convert a Helios `Network` to a NetworkX graph with compatible attributes." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "from_networkx", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 88, "path": "python/src/helios_network/_conversions.py" }, "summary": "Create a Helios `Network` from a NetworkX `Graph` or `DiGraph`." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "to_igraph", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 114, "path": "python/src/helios_network/_conversions.py" }, "summary": "Convert a Helios `Network` to an igraph `Graph` with compatible attributes." }, { "category": "Import And Conversion", "examples": [], "kind": "function", "methods": [], "name": "from_igraph", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 151, "path": "python/src/helios_network/_conversions.py" }, "summary": "Create a Helios `Network` from an igraph `Graph`." }, { "category": "Network", "examples": [], "kind": "class", "methods": [], "name": "Network", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 51, "path": "python/src/helios_network/_wrapper.py" }, "summary": "Python convenience wrapper around the Helios C core network." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "mutation_events_to_text_batch", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 2204, "path": "python/src/helios_network/_wrapper.py" }, "summary": "Convert mutation events to the text batch format understood by JS." }, { "category": "Enums And Models", "examples": [], "kind": "function", "methods": [], "name": "encode_binary_batch", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 2249, "path": "python/src/helios_network/_wrapper.py" }, "summary": "Encode mutation events into the Helios network binary batch protocol." }, { "category": "UMAP", "examples": [], "kind": "class", "methods": [], "name": "NetworkExportResult", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 212, "path": "python/src/helios_network/umap.py" }, "summary": "Result record returned by UMAP graph export helpers." }, { "category": "UMAP", "examples": [], "kind": "class", "methods": [], "name": "HeliosUMAP", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "", "source": { "line": 219, "path": "python/src/helios_network/umap.py" }, "summary": "Build UMAP embeddings with umap-learn while exporting the fuzzy graph and\noptional kNN graph as Helios networks." } ], "title": "Helios Network Python", "version": "0.6.0" }, "helios-web": { "notes": { "exportedSymbols": 97, "sourceEntry": "src/index.js" }, "symbols": [ { "category": "Constants", "examples": [ "helios.on(EVENTS.NODE_HOVER, (event) => {\n console.log(event.detail?.index);\n});" ], "kind": "symbol", "methods": [], "name": "EVENTS", "parameters": [], "remarks": "Event payloads are delivered through `CustomEvent.detail` where the\nbrowser supports `CustomEvent`. Use these constants instead of string\nliterals when wiring app behavior to render, layout, camera, picking, mapper,\nfilter, or network replacement changes.", "returns": { "description": "", "type": "" }, "signature": "export const EVENTS = Object.freeze({", "source": { "line": 2070, "path": "src/Helios.js" }, "summary": "Stable event names emitted by `Helios` instances." }, { "category": "Core", "examples": [ "const helios = new Helios(network, {\n container: document.querySelector('#app'),\n layout: { type: 'gpu-force', options: { mode: '2d' } },\n behaviors: { labels: { enabled: true, source: 'label' } },\n});\nawait helios.ready;" ], "kind": "class", "methods": [ { "category": "Static Properties", "examples": [], "kind": "property", "methods": [], "name": "STATES", "parameters": [], "remarks": "", "returns": { "description": "State bit constants for filtered, selected, and highlighted items.", "type": "Object" }, "signature": "static STATES = Object.freeze({", "source": { "line": 2244, "path": "src/Helios.js" }, "summary": "Built-in bit flags used by node and edge interaction state." }, { "category": "Static Properties", "examples": [], "kind": "property", "methods": [], "name": "STATE_BITS", "parameters": [], "remarks": "", "returns": { "description": "State bit constants.", "type": "Object" }, "signature": "static STATE_BITS = Helios.STATES;", "source": { "line": 2257, "path": "src/Helios.js" }, "summary": "Alias for `STATES` kept for compatibility with earlier public APIs." }, { "category": "Static Properties", "examples": [], "kind": "property", "methods": [], "name": "UI_BINDINGS", "parameters": [], "remarks": "", "returns": { "description": "UI binding descriptors keyed by Helios setting name.", "type": "Object" }, "signature": "static UI_BINDINGS = Object.freeze({", "source": { "line": 2266, "path": "src/Helios.js" }, "summary": "Metadata describing settings that can be bound to controls in the UI." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "uiBindingInfo", "parameters": [ { "attributes": "", "default": "", "description": "UI binding name such as `nodeSizeScale` or `labelsEnabled`.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "Binding descriptor, or `null` when the name is unknown.", "type": "Object|null" }, "signature": "uiBindingInfo(name)", "source": { "line": 2733, "path": "src/Helios.js" }, "summary": "Return the UI control metadata registered for one Helios setting." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, options = {})", "source": { "line": 2819, "path": "src/Helios.js" }, "summary": "" }, { "category": "Behaviors", "examples": [], "kind": "method", "methods": [], "name": "hasBehavior", "parameters": [ { "attributes": "", "default": "", "description": "Behavior id.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "True when the behavior is active or available in the registry.", "type": "boolean" }, "signature": "hasBehavior(name)", "source": { "line": 3858, "path": "src/Helios.js" }, "summary": "Check whether a behavior is active or registered." }, { "category": "Behaviors", "examples": [], "kind": "method", "methods": [], "name": "getBehavior", "parameters": [ { "attributes": "", "default": "", "description": "Behavior id.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "Active behavior instance, or `null` when unavailable.", "type": "Behavior|null" }, "signature": "getBehavior(name)", "source": { "line": 3872, "path": "src/Helios.js" }, "summary": "Return an active behavior, lazily creating registered built-ins when needed." }, { "category": "Behaviors", "examples": [], "kind": "method", "methods": [], "name": "registerBehavior", "parameters": [ { "attributes": "", "default": "", "description": "Behavior id.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Constructor or factory that creates a behavior.", "name": "behaviorCtor", "type": "Function" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "registerBehavior(name, behaviorCtor)", "source": { "line": 3890, "path": "src/Helios.js" }, "summary": "Register a behavior constructor or factory for later activation." }, { "category": "Behaviors", "examples": [ "const selection = helios.useBehavior('selection', { multiple: true });" ], "kind": "method", "methods": [], "name": "useBehavior", "parameters": [ { "attributes": "", "default": "", "description": "Behavior id.", "name": "name", "type": "string" }, { "attributes": "optional", "default": "", "description": "Behavior instance,\nbehavior options, or `true` to activate with defaults.", "name": "behaviorOrOptions", "type": "Behavior|Object|boolean" } ], "remarks": "", "returns": { "description": "Active behavior instance.", "type": "Behavior" }, "signature": "useBehavior(name, behaviorOrOptions)", "source": { "line": 3907, "path": "src/Helios.js" }, "summary": "Activate a behavior, update an existing behavior, or return the active one." }, { "category": "Filtering And State", "examples": [ "const state = helios.getGraphFilter();\nif (state.enabled) console.log(state.nodeCount, state.edgeCount);" ], "kind": "method", "methods": [], "name": "getGraphFilter", "parameters": [], "remarks": "", "returns": { "description": "Filter state with `enabled`, `scope`, normalized\n`options`, filtered/base node and edge counts, and the last filter error.", "type": "Object" }, "signature": "getGraphFilter()", "source": { "line": 6446, "path": "src/Helios.js" }, "summary": "Return the active graph filter state and filtered graph sizes." }, { "category": "Filtering And State", "examples": [ "helios.graphFilter({\n nodeRules: [{ attribute: 'degree', operator: '>=', value: 3 }],\n scope: 'render',\n});" ], "kind": "method", "methods": [], "name": "graphFilter", "parameters": [ { "attributes": "optional", "default": "", "description": "Filter options, `false`, or `null`.\nOmit the argument to read the current state.", "name": "options", "type": "Object|false|null" } ], "remarks": "", "returns": { "description": "Current filter state when called without\narguments, otherwise this Helios instance for chaining.", "type": "Object|Helios" }, "signature": "graphFilter(options)", "source": { "line": 6479, "path": "src/Helios.js" }, "summary": "Read or replace the active graph filter." }, { "category": "Filtering And State", "examples": [ "helios.setGraphFilter({\n nodeRules: [{ attribute: 'group', operator: '==', value: 'core' }],\n scope: 'render+layout',\n});" ], "kind": "method", "methods": [], "name": "setGraphFilter", "parameters": [ { "attributes": "", "default": "", "description": "Filter rule set or reusable\n`HeliosFilter` instance.", "name": "options", "type": "Object|HeliosFilter" }, { "attributes": "optional", "default": "", "description": "Node rules to apply.", "name": "options.nodeRules", "type": "Array." }, { "attributes": "optional", "default": "", "description": "Edge rules to apply.", "name": "options.edgeRules", "type": "Array." }, { "attributes": "optional", "default": "", "description": "Filter scope.", "name": "options.scope", "type": "'render'|'render+layout'" } ], "remarks": "`render` hides filtered items without changing dynamic layout\nforces. `render+layout` also feeds the filtered graph to the active layout.", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "setGraphFilter(options = {})", "source": { "line": 6508, "path": "src/Helios.js" }, "summary": "Apply a render or render-and-layout graph filter." }, { "category": "Filtering And State", "examples": [ "const filter = new HeliosFilter({ nodeRules: [{ attribute: 'kind', value: 'paper' }] });\nhelios.activateHeliosFilter(filter);" ], "kind": "method", "methods": [], "name": "activateHeliosFilter", "parameters": [ { "attributes": "", "default": "", "description": "Filter instance to activate, or\n`null`/`false` to clear filtering.", "name": "filter", "type": "HeliosFilter|null|false" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "activateHeliosFilter(filter)", "source": { "line": 6560, "path": "src/Helios.js" }, "summary": "Activate a reusable `HeliosFilter` instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getActiveHeliosFilter", "parameters": [], "remarks": "", "returns": { "description": "Active reusable filter, if one was supplied.", "type": "HeliosFilter|null" }, "signature": "getActiveHeliosFilter()", "source": { "line": 6578, "path": "src/Helios.js" }, "summary": "Return the reusable filter currently attached to this view." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "reapplyActiveHeliosFilter", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "reapplyActiveHeliosFilter()", "source": { "line": 6589, "path": "src/Helios.js" }, "summary": "Re-run the active reusable filter after its rules or source data changed." }, { "category": "Filtering And State", "examples": [ "helios.clearGraphFilter();" ], "kind": "method", "methods": [], "name": "clearGraphFilter", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "clearGraphFilter()", "source": { "line": 6603, "path": "src/Helios.js" }, "summary": "Remove the active graph filter and restore the base graph view." }, { "category": "Network And Persistence", "examples": [ "await helios.replaceNetwork(nextNetwork, { keepCamera: false });" ], "kind": "method", "methods": [], "name": "replaceNetwork", "parameters": [ { "attributes": "", "default": "", "description": "Replacement graph.", "name": "nextNetwork", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "", "description": "Replacement behavior options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Dispose the previous network.", "name": "options.disposeOld", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Preserve the current camera.", "name": "options.keepCamera", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Preserve mapper settings.", "name": "options.keepMappers", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Mark persistence network data dirty after replacement.", "name": "options.markNetworkDirty", "type": "boolean" } ], "remarks": "", "returns": { "description": "This Helios instance after the renderer and\nlayout are rebound to the new graph.", "type": "Promise" }, "signature": "async replaceNetwork(nextNetwork, options = {})", "source": { "line": 6642, "path": "src/Helios.js" }, "summary": "Replace the graph store while preserving visualization state by default." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "requestFrameNetwork", "parameters": [ { "attributes": "optional", "default": "", "description": "Camera fit options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "25", "description": "Maximum geometry ticks to retry.", "name": "options.maxAttempts", "type": "number" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "requestFrameNetwork(options = {})", "source": { "line": 6829, "path": "src/Helios.js" }, "summary": "Queue a camera fit once the renderer and graph bounds are ready." }, { "category": "Camera And View", "examples": [ "helios.frameNetwork({ animate: true, paddingRatio: 0.08 });" ], "kind": "method", "methods": [], "name": "frameNetwork", "parameters": [ { "attributes": "optional", "default": "", "description": "Camera fit options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Node indices to frame.", "name": "options.nodeIndices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "false", "description": "Animate the transition.", "name": "options.animate", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Extra viewport padding ratio.", "name": "options.paddingRatio", "type": "number" } ], "remarks": "", "returns": { "description": "True when a camera pose was applied.", "type": "boolean" }, "signature": "frameNetwork(options = {})", "source": { "line": 6863, "path": "src/Helios.js" }, "summary": "Fit the camera to the current visible graph or selected node set." }, { "category": "Network And Persistence", "examples": [ "const network = await helios.loadNetwork(file, { format: 'bxnet' });" ], "kind": "method", "methods": [], "name": "loadNetwork", "parameters": [ { "attributes": "", "default": "", "description": "Network payload or file-like object.", "name": "source", "type": "Blob|ArrayBuffer|string|File" }, { "attributes": "optional", "default": "", "description": "Load and replacement options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Input format when it\ncannot be inferred from `source.name`.", "name": "options.format", "type": "'xnet'|'zxnet'|'bxnet'|'gml'|'gt'" } ], "remarks": "", "returns": { "description": "Loaded network instance.", "type": "Promise" }, "signature": "async loadNetwork(source, options = {})", "source": { "line": 6908, "path": "src/Helios.js" }, "summary": "Load a serialized network and replace the active graph." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "saveNetwork", "parameters": [ { "attributes": "optional", "default": "'bxnet'", "description": "Output format.", "name": "format", "type": "'xnet'|'zxnet'|'bxnet'|'gml'|'gt'" }, { "attributes": "optional", "default": "", "description": "Save options forwarded to the network serializer.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Serialized network payload.", "type": "Promise" }, "signature": "async saveNetwork(format = 'bxnet', options = {})", "source": { "line": 6985, "path": "src/Helios.js" }, "summary": "Serialize the active graph in a Helios Network format." }, { "category": "Behaviors", "examples": [], "kind": "method", "methods": [], "name": "serializeBehaviorState", "parameters": [], "remarks": "", "returns": { "description": "Behavior state keyed by behavior id.", "type": "Object" }, "signature": "serializeBehaviorState()", "source": { "line": 7023, "path": "src/Helios.js" }, "summary": "Serialize state held by active behaviors." }, { "category": "Behaviors", "examples": [], "kind": "method", "methods": [], "name": "restoreBehaviorState", "parameters": [ { "attributes": "optional", "default": "", "description": "Behavior state keyed by behavior id.", "name": "snapshot", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "restoreBehaviorState(snapshot = {})", "source": { "line": 7035, "path": "src/Helios.js" }, "summary": "Restore state for active behaviors." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeVisualizationState", "parameters": [ { "attributes": "optional", "default": "", "description": "Serialization options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Visualization-state envelope containing UI, behavior,\ncamera, and network-source state.", "type": "Object" }, "signature": "serializeVisualizationState(options = {})", "source": { "line": 7084, "path": "src/Helios.js" }, "summary": "Build a portable visualization-state envelope." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeVisualizationStateAsync", "parameters": [ { "attributes": "optional", "default": "", "description": "Serialization options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Visualization-state envelope containing UI,\nbehavior, camera, network-source, storage, and async layout runtime state.", "type": "Promise" }, "signature": "async serializeVisualizationStateAsync(options = {})", "source": { "line": 7111, "path": "src/Helios.js" }, "summary": "Build a portable visualization-state envelope and await async layout snapshots." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "importVisualizationState", "parameters": [ { "attributes": "", "default": "", "description": "Visualization-state envelope or JSON payload.", "name": "source", "type": "Object|string|Blob" }, { "attributes": "optional", "default": "", "description": "Restore options forwarded to behaviors.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Parsed persistence envelope.", "type": "Promise" }, "signature": "async importVisualizationState(source, options = {})", "source": { "line": 7137, "path": "src/Helios.js" }, "summary": "Import a visualization-state envelope and apply it to this view." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreVisualizationState", "parameters": [ { "attributes": "", "default": "", "description": "Visualization-state envelope or JSON payload.", "name": "source", "type": "Object|string|Blob" }, { "attributes": "optional", "default": "", "description": "Restore options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Parsed persistence envelope.", "type": "Promise" }, "signature": "async restoreVisualizationState(source, options = {})", "source": { "line": 7214, "path": "src/Helios.js" }, "summary": "Alias for `importVisualizationState`." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "exportVisualizationState", "parameters": [ { "attributes": "optional", "default": "", "description": "Export options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'object'", "description": "Output shape.", "name": "options.format", "type": "'Object'|'string'|'blob'" } ], "remarks": "", "returns": { "description": "Visualization-state payload.", "type": "Object|string|Blob" }, "signature": "exportVisualizationState(options = {})", "source": { "line": 7227, "path": "src/Helios.js" }, "summary": "Export visualization state as an object, JSON string, or Blob." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeTrackedVisualizationState", "parameters": [ { "attributes": "optional", "default": "", "description": "Serialization options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Include layout runtime state.", "name": "options.includeLayoutRuntime", "type": "boolean" } ], "remarks": "", "returns": { "description": "Sparse visualization-state envelope suitable for portable state attachment.", "type": "Object" }, "signature": "serializeTrackedVisualizationState(options = {})", "source": { "line": 7246, "path": "src/Helios.js" }, "summary": "Build a sparse visualization-state envelope from tracked state overrides." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeTrackedVisualizationStateAsync", "parameters": [ { "attributes": "optional", "default": "", "description": "Serialization options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Include layout runtime state.", "name": "options.includeLayoutRuntime", "type": "boolean" } ], "remarks": "", "returns": { "description": "Sparse visualization-state envelope suitable for portable state attachment.", "type": "Promise" }, "signature": "async serializeTrackedVisualizationStateAsync(options = {})", "source": { "line": 7275, "path": "src/Helios.js" }, "summary": "Build a sparse visualization-state envelope and await async layout snapshots." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "getAttachedVisualizationState", "parameters": [ { "attributes": "optional", "default": "this.network", "description": "Network to inspect.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "", "description": "Attribute lookup options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Parsed envelope, or `null` when no valid state is attached.", "type": "Object|null" }, "signature": "getAttachedVisualizationState(network = this.network, options = {})", "source": { "line": 7304, "path": "src/Helios.js" }, "summary": "Read a visualization-state envelope stored on a network attribute." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attachVisualizationStateToNetwork", "parameters": [ { "attributes": "optional", "default": "null", "description": "Existing envelope, or `null` to capture current state.", "name": "snapshot", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Attachment options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "attachVisualizationStateToNetwork(snapshot = null, options = {})", "source": { "line": 7325, "path": "src/Helios.js" }, "summary": "Store visualization state on a network string attribute." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "clearAttachedVisualizationState", "parameters": [ { "attributes": "optional", "default": "", "description": "Attribute removal options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "clearAttachedVisualizationState(options = {})", "source": { "line": 7345, "path": "src/Helios.js" }, "summary": "Remove visualization state attached to the active network." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "savePortableNetwork", "parameters": [ { "attributes": "optional", "default": "'bxnet'", "description": "Output network format.", "name": "format", "type": "'xnet'|'zxnet'|'bxnet'|'gml'|'gt'" }, { "attributes": "optional", "default": "", "description": "Portable save options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "false", "description": "Attach current\nvisualization state before saving.", "name": "options.includeVisualization", "type": "boolean" } ], "remarks": "", "returns": { "description": "Serialized network payload.", "type": "Promise" }, "signature": "async savePortableNetwork(format = 'bxnet', options = {})", "source": { "line": 7364, "path": "src/Helios.js" }, "summary": "Save the graph with optional embedded visualization state." }, { "category": "Figure Export", "examples": [], "kind": "method", "methods": [], "name": "getFigureExportCapabilities", "parameters": [ { "attributes": "optional", "default": "", "description": "Supersampling request\nused when computing max safe output dimensions.", "name": "options", "type": "{supersampling?: number|string}" } ], "remarks": "WebGL and WebGPU expose different maximum texture dimensions, so\nthis method should be called after `await helios.ready` and whenever\nsupersampling changes.", "returns": { "description": "Export capability record for the current renderer and viewport.", "type": "{maxBitmapDimension:number,maxFigureDimension:number,defaultPreset:string,presets:Array.}" }, "signature": "getFigureExportCapabilities(options = {})", "source": { "line": 7552, "path": "src/Helios.js" }, "summary": "Return renderer-aware figure export limits and preset availability." }, { "category": "Figure Export", "examples": [ "const blob = await helios.exportFigureBlob({\n format: 'png',\n width: 1920,\n height: 1080,\n includeLabels: true,\n includeLegends: true,\n});" ], "kind": "method", "methods": [], "name": "exportFigureBlob", "parameters": [ { "attributes": "optional", "default": "", "description": "Figure export options including `format`,\n`preset`, `width`, `height`, `supersampling`, `includeLabels`,\n`includeLegends`, `includeInterface`, `transparentBackground`, and\n`legendScale`.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Image blob for the requested figure.", "type": "Promise" }, "signature": "async exportFigureBlob(options = {})", "source": { "line": 7973, "path": "src/Helios.js" }, "summary": "Capture the current visualization as a PNG or SVG `Blob`." }, { "category": "Figure Export", "examples": [], "kind": "method", "methods": [], "name": "exportFigurePreviewBlob", "parameters": [ { "attributes": "optional", "default": "", "description": "Full export options that should be previewed.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Preview output constraints.", "name": "previewOptions", "type": "{maxWidth?:number,maxHeight?:number,supersampling?:number|string}" } ], "remarks": "Preview capture keeps the full export's framing and overlay intent\nwhile using smaller raster dimensions for UI previews.", "returns": { "description": "PNG preview blob.", "type": "Promise" }, "signature": "async exportFigurePreviewBlob(options = {}, previewOptions = {})", "source": { "line": 8013, "path": "src/Helios.js" }, "summary": "Capture a scaled PNG preview for a full-size figure export request." }, { "category": "Figure Export", "examples": [], "kind": "method", "methods": [], "name": "exportFigure", "parameters": [ { "attributes": "optional", "default": "", "description": "Download filename or figure\nexport options.", "name": "filenameOrOptions", "type": "string|Object" }, { "attributes": "optional", "default": "", "description": "Figure export options when the first\nargument is a filename.", "name": "maybeOptions", "type": "Object" } ], "remarks": "In non-browser runtimes the method still creates the figure blob\nand returns metadata, but no download link is clicked.", "returns": { "description": "Download metadata containing `blob`, `filename`,\n`format`, logical dimensions, bitmap dimensions, and supersampling.", "type": "Promise" }, "signature": "async exportFigure(filenameOrOptions, maybeOptions = {})", "source": { "line": 8066, "path": "src/Helios.js" }, "summary": "Capture and download the current visualization." }, { "category": "Events", "examples": [ "const unsubscribe = helios.on(EVENTS.NODE_CLICK, (event) => {\n console.log(event.detail.index);\n});" ], "kind": "method", "methods": [], "name": "on", "parameters": [ { "attributes": "", "default": "", "description": "Event type, usually one of the `EVENTS` constants.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Listener function.", "name": "handler", "type": "Function" }, { "attributes": "optional", "default": "", "description": "DOM `addEventListener` options.", "name": "options", "type": "Object|boolean" } ], "remarks": "", "returns": { "description": "Function that removes the listener.", "type": "Function" }, "signature": "on(type, handler, options)", "source": { "line": 8109, "path": "src/Helios.js" }, "summary": "Add an event listener and receive an unsubscribe function." }, { "category": "Events", "examples": [ "helios.listen(`${EVENTS.NODE_HOVER}.tooltip`, ({ detail }) => {\n updateTooltip(detail);\n});" ], "kind": "method", "methods": [], "name": "listen", "parameters": [ { "attributes": "", "default": "", "description": "Event type, optionally followed by\n`.namespace` for replacement/removal.", "name": "typeWithNamespace", "type": "string" }, { "attributes": "", "default": "", "description": "Listener function, or `null` to remove.", "name": "handler", "type": "Function|null" }, { "attributes": "optional", "default": "", "description": "DOM listener options.", "name": "options", "type": "Object|boolean" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "listen(typeWithNamespace, handler, options)", "source": { "line": 8137, "path": "src/Helios.js" }, "summary": "Add or replace a namespaced event listener." }, { "category": "Events", "examples": [], "kind": "method", "methods": [], "name": "off", "parameters": [ { "attributes": "", "default": "", "description": "Event type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Listener function originally registered.", "name": "handler", "type": "Function" }, { "attributes": "optional", "default": "", "description": "DOM listener options.", "name": "options", "type": "Object|boolean" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "off(type, handler, options)", "source": { "line": 8195, "path": "src/Helios.js" }, "summary": "Remove an event listener." }, { "category": "Events", "examples": [], "kind": "method", "methods": [], "name": "onAny", "parameters": [ { "attributes": "", "default": "", "description": "Listener receiving `{ type, detail, event, target }`.", "name": "handler", "type": "Function" }, { "attributes": "optional", "default": "", "description": "Listener options, including `signal`.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Function that removes the listener.", "type": "Function" }, "signature": "onAny(handler, options)", "source": { "line": 8208, "path": "src/Helios.js" }, "summary": "Observe every event emitted through Helios." }, { "category": "Events", "examples": [], "kind": "method", "methods": [], "name": "emit", "parameters": [ { "attributes": "", "default": "", "description": "Event type.", "name": "type", "type": "string" }, { "attributes": "optional", "default": "", "description": "Event detail payload.", "name": "detail", "type": "Object" } ], "remarks": "", "returns": { "description": "Dispatched event object.", "type": "CustomEvent" }, "signature": "emit(type, detail)", "source": { "line": 8232, "path": "src/Helios.js" }, "summary": "Dispatch a Helios event." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "The constructor calls this automatically and exposes the promise as\n`helios.ready`; applications usually await `ready` instead of calling this directly.", "returns": { "description": "Resolves when the first renderer and layout setup is complete.", "type": "Promise" }, "signature": "async initialize()", "source": { "line": 8257, "path": "src/Helios.js" }, "summary": "Initialize layout, renderer, picking, attribute tracking, and scheduler state." }, { "category": "State And Persistence", "examples": [], "kind": "method", "methods": [], "name": "snapshotLayoutRuntimeState", "parameters": [ { "attributes": "optional", "default": "", "description": "Snapshot controls.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Include packed node positions when they fit within `maxPositionBytes`.", "name": "options.includePositions", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Maximum encoded position payload size.", "name": "options.maxPositionBytes", "type": "number" } ], "remarks": "", "returns": { "description": "Serializable layout runtime snapshot.", "type": "Object" }, "signature": "snapshotLayoutRuntimeState(options = {})", "source": { "line": 8635, "path": "src/Helios.js" }, "summary": "Capture scheduler, layout, and optional node-position runtime state for persistence." }, { "category": "State And Persistence", "examples": [], "kind": "method", "methods": [], "name": "snapshotLayoutRuntimeStateAsync", "parameters": [ { "attributes": "optional", "default": "", "description": "Snapshot controls and optional delegate override.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Read positions from the active delegate even when network positions are available.", "name": "options.preferDelegate", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Pre-captured packed `x,y,z` positions to encode.", "name": "options.positions", "type": "Float32Array" } ], "remarks": "", "returns": { "description": "Serializable layout runtime snapshot.", "type": "Promise" }, "signature": "async snapshotLayoutRuntimeStateAsync(options = {})", "source": { "line": 8650, "path": "src/Helios.js" }, "summary": "Capture layout runtime state, preferring async delegate readback when active." }, { "category": "State And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreLayoutRuntimeState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Snapshot returned by `snapshotLayoutRuntimeState*`.", "name": "state", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Restore controls.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Diagnostic reason passed to position delegates.", "name": "options.reason", "type": "string" } ], "remarks": "", "returns": { "description": "`true` when any runtime state or positions were restored.", "type": "boolean" }, "signature": "restoreLayoutRuntimeState(state = {}, options = {})", "source": { "line": 8712, "path": "src/Helios.js" }, "summary": "Restore scheduler, layout, and encoded position state from a previous snapshot." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeWidthScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Edge width scale multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeWidthScale(value)", "source": { "line": 10104, "path": "src/Helios.js" }, "summary": "Read or set the multiplier applied to edge width attributes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeWidthBase", "parameters": [ { "attributes": "optional", "default": "", "description": "Base edge width in render units.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeWidthBase(value)", "source": { "line": 10117, "path": "src/Helios.js" }, "summary": "Read or set the constant edge width added before scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeOpacityScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Edge opacity scale multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeOpacityScale(value)", "source": { "line": 10130, "path": "src/Helios.js" }, "summary": "Read or set the multiplier applied to edge opacity attributes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeOpacityBase", "parameters": [ { "attributes": "optional", "default": "", "description": "Base edge opacity.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeOpacityBase(value)", "source": { "line": 10143, "path": "src/Helios.js" }, "summary": "Read or set the constant edge opacity added before scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOpacityScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Node opacity scale multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeOpacityScale(value)", "source": { "line": 10156, "path": "src/Helios.js" }, "summary": "Read or set the multiplier applied to node opacity attributes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOpacityBase", "parameters": [ { "attributes": "optional", "default": "", "description": "Base node opacity.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeOpacityBase(value)", "source": { "line": 10169, "path": "src/Helios.js" }, "summary": "Read or set the constant node opacity added before scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeSizeScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Node size scale multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeSizeScale(value)", "source": { "line": 10182, "path": "src/Helios.js" }, "summary": "Read or set the multiplier applied to node size attributes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeSizeBase", "parameters": [ { "attributes": "optional", "default": "", "description": "Base node radius in render units.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeSizeBase(value)", "source": { "line": 10195, "path": "src/Helios.js" }, "summary": "Read or set the constant node radius added before scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "semanticZoomExponent", "parameters": [ { "attributes": "optional", "default": "", "description": "Exponent controlling how strongly zoom affects apparent size.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "semanticZoomExponent(value)", "source": { "line": 10208, "path": "src/Helios.js" }, "summary": "Read or set semantic zoom compensation for node and label sizing." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOutlineWidthScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Node outline width scale multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeOutlineWidthScale(value)", "source": { "line": 10223, "path": "src/Helios.js" }, "summary": "Read or set the multiplier applied to node outline width attributes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOutlineWidthBase", "parameters": [ { "attributes": "optional", "default": "", "description": "Base node outline width in render units.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "nodeOutlineWidthBase(value)", "source": { "line": 10236, "path": "src/Helios.js" }, "summary": "Read or set the constant node outline width added before scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOutlineColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "nodeOutlineColor(color)", "source": { "line": 10249, "path": "src/Helios.js" }, "summary": "Read or set the default node outline color." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeOutlineUseAttributes", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable outline attribute mapping.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "nodeOutlineUseAttributes(value)", "source": { "line": 10266, "path": "src/Helios.js" }, "summary": "Read or set whether outline attributes participate in node styling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeEndpointTrim", "parameters": [ { "attributes": "optional", "default": "", "description": "Trim amount in node-radius units.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeEndpointTrim(value)", "source": { "line": 10279, "path": "src/Helios.js" }, "summary": "Read or set how far edge geometry is trimmed away from node centers." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeWidthClampToNodeDiameter", "parameters": [ { "attributes": "optional", "default": "", "description": "Clamp thick edges to avoid overpowering small nodes.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeWidthClampToNodeDiameter(value)", "source": { "line": 10292, "path": "src/Helios.js" }, "summary": "Read or set whether rendered edge width is clamped by endpoint node diameter." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "nodeBlendWithEdges", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable node/edge blending.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "nodeBlendWithEdges(value)", "source": { "line": 10308, "path": "src/Helios.js" }, "summary": "Read or set whether node rendering blends visually with adjacent edges." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeDepthWrite", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable depth writes for edges.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeDepthWrite(value)", "source": { "line": 10321, "path": "src/Helios.js" }, "summary": "Read or set whether edge fragments write to the depth buffer." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeFastRendering", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable the fast edge rendering path.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeFastRendering(value)", "source": { "line": 10334, "path": "src/Helios.js" }, "summary": "Read or set the manual fast edge-rendering override." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable lighting-based shading.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "shadedEnabled(value)", "source": { "line": 10347, "path": "src/Helios.js" }, "summary": "Read or set whether shaded rendering is enabled." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedNodes", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable shading for nodes.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "shadedNodes(value)", "source": { "line": 10363, "path": "src/Helios.js" }, "summary": "Read or set whether node geometry receives shaded lighting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedEdges", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable shading for edges.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "shadedEdges(value)", "source": { "line": 10379, "path": "src/Helios.js" }, "summary": "Read or set whether edge geometry receives shaded lighting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedLightDirection", "parameters": [ { "attributes": "optional", "default": "", "description": "Light direction as `[x,y,z]` or direction-like object.", "name": "value", "type": "Array|Object" } ], "remarks": "", "returns": { "description": "Current direction when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "shadedLightDirection(value)", "source": { "line": 10395, "path": "src/Helios.js" }, "summary": "Read or set the directional light vector used by shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedLightDirectionX", "parameters": [ { "attributes": "optional", "default": "", "description": "X component.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedLightDirectionX(value)", "source": { "line": 10410, "path": "src/Helios.js" }, "summary": "Read or set the x component of the shaded light direction." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedLightDirectionY", "parameters": [ { "attributes": "optional", "default": "", "description": "Y component.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedLightDirectionY(value)", "source": { "line": 10425, "path": "src/Helios.js" }, "summary": "Read or set the y component of the shaded light direction." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedLightDirectionZ", "parameters": [ { "attributes": "optional", "default": "", "description": "Z component.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedLightDirectionZ(value)", "source": { "line": 10440, "path": "src/Helios.js" }, "summary": "Read or set the z component of the shaded light direction." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedLightColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "shadedLightColor(color)", "source": { "line": 10455, "path": "src/Helios.js" }, "summary": "Read or set the direct light color used by shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedAmbientTopColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "shadedAmbientTopColor(color)", "source": { "line": 10474, "path": "src/Helios.js" }, "summary": "Read or set the upper hemisphere ambient color for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedAmbientBottomColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "shadedAmbientBottomColor(color)", "source": { "line": 10493, "path": "src/Helios.js" }, "summary": "Read or set the lower hemisphere ambient color for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedDiffuseStrength", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative diffuse strength.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedDiffuseStrength(value)", "source": { "line": 10512, "path": "src/Helios.js" }, "summary": "Read or set diffuse lighting strength for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedAmbientStrength", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative ambient strength.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedAmbientStrength(value)", "source": { "line": 10530, "path": "src/Helios.js" }, "summary": "Read or set ambient lighting strength for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedSpecularColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "shadedSpecularColor(color)", "source": { "line": 10548, "path": "src/Helios.js" }, "summary": "Read or set the specular highlight color for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedSpecularStrength", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative specular strength.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedSpecularStrength(value)", "source": { "line": 10567, "path": "src/Helios.js" }, "summary": "Read or set specular highlight strength for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "shadedShininess", "parameters": [ { "attributes": "optional", "default": "", "description": "Shininess exponent.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "shadedShininess(value)", "source": { "line": 10585, "path": "src/Helios.js" }, "summary": "Read or set specular shininess for shaded rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable ambient occlusion when the renderer supports it.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "ambientOcclusionEnabled(value)", "source": { "line": 10603, "path": "src/Helios.js" }, "summary": "Read or set whether screen-space ambient occlusion is enabled." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionNodes", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable node occlusion.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "ambientOcclusionNodes(value)", "source": { "line": 10619, "path": "src/Helios.js" }, "summary": "Read or set whether ambient occlusion is applied to nodes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionEdges", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable edge occlusion.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "ambientOcclusionEdges(value)", "source": { "line": 10635, "path": "src/Helios.js" }, "summary": "Read or set whether ambient occlusion is applied to edges." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionStrength", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative occlusion strength.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "ambientOcclusionStrength(value)", "source": { "line": 10651, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion strength." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionRadius", "parameters": [ { "attributes": "optional", "default": "", "description": "Radius in screen-space sample units.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "ambientOcclusionRadius(value)", "source": { "line": 10669, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion sampling radius." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionBias", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative depth bias.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "ambientOcclusionBias(value)", "source": { "line": 10687, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion depth bias." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionMode", "parameters": [ { "attributes": "optional", "default": "", "description": "Ambient occlusion mode identifier.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current mode when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "ambientOcclusionMode(value)", "source": { "line": 10705, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion compositing mode." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionIntensityScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative intensity multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "ambientOcclusionIntensityScale(value)", "source": { "line": 10725, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion intensity scaling." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionIntensityShift", "parameters": [ { "attributes": "optional", "default": "", "description": "Non-negative intensity offset.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "ambientOcclusionIntensityShift(value)", "source": { "line": 10743, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion intensity offset." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "ambientOcclusionQuality", "parameters": [ { "attributes": "optional", "default": "", "description": "Ambient occlusion quality preset.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current quality when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "ambientOcclusionQuality(value)", "source": { "line": 10761, "path": "src/Helios.js" }, "summary": "Read or set ambient occlusion quality preset." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQuality", "parameters": [ { "attributes": "optional", "default": "", "description": "Adaptive quality configuration. Omit to read the current configuration and runtime status.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Current policy snapshot when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "edgeAdaptiveQuality(options)", "source": { "line": 10781, "path": "src/Helios.js" }, "summary": "Read or update the adaptive edge-quality policy used to switch fast edge rendering on slow frames." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualityEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable adaptive edge quality.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeAdaptiveQualityEnabled(value)", "source": { "line": 10824, "path": "src/Helios.js" }, "summary": "Read or set whether adaptive edge quality is enabled." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualitySlowFrameThresholdMs", "parameters": [ { "attributes": "optional", "default": "", "description": "Slow-frame threshold in milliseconds.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeAdaptiveQualitySlowFrameThresholdMs(value)", "source": { "line": 10838, "path": "src/Helios.js" }, "summary": "Read or set the frame-time threshold that counts as slow for adaptive edge quality." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualitySlowFrameConsecutiveFrames", "parameters": [ { "attributes": "optional", "default": "", "description": "Frame sample window size.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeAdaptiveQualitySlowFrameConsecutiveFrames(value)", "source": { "line": 10852, "path": "src/Helios.js" }, "summary": "Read or set how many recent frames are averaged before adaptive quality changes." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualityProbeIntervalMs", "parameters": [ { "attributes": "optional", "default": "", "description": "Probe interval in milliseconds.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeAdaptiveQualityProbeIntervalMs(value)", "source": { "line": 10866, "path": "src/Helios.js" }, "summary": "Read or set how often adaptive quality probes full-quality edge rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualityInteractionHoldMs", "parameters": [ { "attributes": "optional", "default": "", "description": "Hold duration in milliseconds.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "edgeAdaptiveQualityInteractionHoldMs(value)", "source": { "line": 10880, "path": "src/Helios.js" }, "summary": "Read or set how long adaptive quality stays fast after interaction." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualityFastDuringCamera", "parameters": [ { "attributes": "optional", "default": "", "description": "Use fast edges while the camera is moving.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeAdaptiveQualityFastDuringCamera(value)", "source": { "line": 10894, "path": "src/Helios.js" }, "summary": "Read or set whether camera interaction forces fast edge rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeAdaptiveQualityFastDuringLayout", "parameters": [ { "attributes": "optional", "default": "", "description": "Use fast edges while layout is running.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "edgeAdaptiveQualityFastDuringLayout(value)", "source": { "line": 10908, "path": "src/Helios.js" }, "summary": "Read or set whether active layout ticks force fast edge rendering." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "background", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "background(color)", "source": { "line": 10922, "path": "src/Helios.js" }, "summary": "Read or set the renderer background color." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "clearColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS hex color or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current RGBA color when omitted; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "clearColor(color)", "source": { "line": 10939, "path": "src/Helios.js" }, "summary": "Alias for `background(color)`." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "supersampling", "parameters": [ { "attributes": "optional", "default": "", "description": "Supersampling preset or legacy boolean.", "name": "value", "type": "'auto'|'on'|'off'|boolean" } ], "remarks": "", "returns": { "description": "Current preset when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "supersampling(value)", "source": { "line": 10952, "path": "src/Helios.js" }, "summary": "Read or set the renderer supersampling preset." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "cameraPose", "parameters": [], "remarks": "", "returns": { "description": "Serializable camera pose, or `null` before a renderer is available.", "type": "Object|null" }, "signature": "cameraPose()", "source": { "line": 10977, "path": "src/Helios.js" }, "summary": "Capture the current camera pose." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "cameraControls", "parameters": [ { "attributes": "optional", "default": "", "description": "Camera-control fields to update. Omit to read the current snapshot.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "State tracking options for persistence-aware writes.", "name": "stateOptions", "type": "Object" } ], "remarks": "", "returns": { "description": "Current camera-control snapshot when called without arguments; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "cameraControls(options, stateOptions = {})", "source": { "line": 10990, "path": "src/Helios.js" }, "summary": "Read or update automatic camera-control policy." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "cameraTargetNodes", "parameters": [ { "attributes": "optional", "default": "", "description": "Node indices to target. Omit to read the current target list.", "name": "nodeIndices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "", "description": "Focus, zoom, animation, and follow options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Current target list when called without arguments; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "cameraTargetNodes(nodeIndices, options = {})", "source": { "line": 11052, "path": "src/Helios.js" }, "summary": "Focus the camera on a set of node indices." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "cameraFollowNodes", "parameters": [ { "attributes": "optional", "default": "", "description": "Node indices to follow. Pass an empty list to disable following.", "name": "nodeIndices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "", "description": "Follow interval, framing, zoom, and animation options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Current followed node list when called without arguments; otherwise this Helios instance.", "type": "Array|Helios" }, "signature": "cameraFollowNodes(nodeIndices, options = {})", "source": { "line": 11107, "path": "src/Helios.js" }, "summary": "Keep the camera centered on moving node indices." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "setCameraPose", "parameters": [ { "attributes": "", "default": "", "description": "Camera pose fields to merge into the current pose.", "name": "pose", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Render, state tracking, and manual-interaction options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "setCameraPose(pose, options = {})", "source": { "line": 11149, "path": "src/Helios.js" }, "summary": "Apply a camera pose immediately." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "transitionCamera", "parameters": [ { "attributes": "", "default": "", "description": "Target camera pose fields.", "name": "pose", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Transition duration, starting pose, render, and interaction options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance after the transition completes.", "type": "Promise" }, "signature": "async transitionCamera(pose, options = {})", "source": { "line": 11211, "path": "src/Helios.js" }, "summary": "Animate the camera from its current pose to a target pose." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "stopCameraTransition", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "stopCameraTransition()", "source": { "line": 11241, "path": "src/Helios.js" }, "summary": "Stop any active camera transition." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "mode", "parameters": [], "remarks": "", "returns": { "description": "Current camera/rendering mode.", "type": "'2d'|'3d'" }, "signature": "mode()", "source": { "line": 11253, "path": "src/Helios.js" }, "summary": "Return the active dimensional rendering mode." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "setMode", "parameters": [ { "attributes": "", "default": "", "description": "Target dimensional mode.", "name": "mode", "type": "'2d'|'3d'" }, { "attributes": "optional", "default": "", "description": "Animation, delegate-sync, and camera framing options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance after the mode switch completes.", "type": "Promise" }, "signature": "async setMode(mode, options = {})", "source": { "line": 11266, "path": "src/Helios.js" }, "summary": "Switch between 2D and 3D rendering modes." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "density", "parameters": [ { "attributes": "optional", "default": "", "description": "Density configuration, or `false`/`null` to disable the overlay.", "name": "options", "type": "Object|false|null" }, { "attributes": "optional", "default": "", "description": "Enable density rendering.", "name": "options.enabled", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Density texture scale relative to the viewport.", "name": "options.qualityScale", "type": "number" }, { "attributes": "optional", "default": "", "description": "Node attribute used as the primary density weight.", "name": "options.property", "type": "string" }, { "attributes": "optional", "default": "", "description": "Optional comparison attribute for diverging/log-ratio density.", "name": "options.compareProperty", "type": "string" }, { "attributes": "optional", "default": "", "description": "Sequential colormap name.", "name": "options.colormap", "type": "string" }, { "attributes": "optional", "default": "", "description": "Diverging colormap name.", "name": "options.divergingColormap", "type": "string" } ], "remarks": "", "returns": { "description": "Current density snapshot when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "density(options)", "source": { "line": 11429, "path": "src/Helios.js" }, "summary": "Read or update the screen-space density overlay configuration." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable density rendering.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "densityEnabled(value)", "source": { "line": 11590, "path": "src/Helios.js" }, "summary": "Read or set whether the density overlay is enabled." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Texture scale relative to the viewport.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "densityScale(value)", "source": { "line": 11603, "path": "src/Helios.js" }, "summary": "Read or set the density overlay quality scale." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityTopographic", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable contour-style rendering.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "densityTopographic(value)", "source": { "line": 11616, "path": "src/Helios.js" }, "summary": "Read or set whether density is rendered with topographic contours." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityScaleWithZoom", "parameters": [ { "attributes": "optional", "default": "", "description": "Scale density evaluation with zoom.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "densityScaleWithZoom(value)", "source": { "line": 11629, "path": "src/Helios.js" }, "summary": "Read or set whether density bandwidth scales with camera zoom." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityBandwidth", "parameters": [ { "attributes": "optional", "default": "", "description": "Positive kernel bandwidth.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "densityBandwidth(value)", "source": { "line": 11642, "path": "src/Helios.js" }, "summary": "Read or set the density kernel bandwidth." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityWeight", "parameters": [ { "attributes": "optional", "default": "", "description": "Density weight multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "densityWeight(value)", "source": { "line": 11655, "path": "src/Helios.js" }, "summary": "Read or set the scalar multiplier applied to density weights." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityProperty", "parameters": [ { "attributes": "optional", "default": "", "description": "Node attribute name.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current attribute name when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "densityProperty(value)", "source": { "line": 11668, "path": "src/Helios.js" }, "summary": "Read or set the node attribute used as the primary density property." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityVsProperty", "parameters": [ { "attributes": "optional", "default": "", "description": "Node attribute name to compare against the primary property.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current comparison attribute when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "densityVsProperty(value)", "source": { "line": 11681, "path": "src/Helios.js" }, "summary": "Read or set the comparison property used for diverging density views." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityNormalizeVs", "parameters": [ { "attributes": "optional", "default": "", "description": "Normalize comparison density.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "densityNormalizeVs(value)", "source": { "line": 11694, "path": "src/Helios.js" }, "summary": "Read or set whether comparison density values are normalized before differencing." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityColormap", "parameters": [ { "attributes": "optional", "default": "", "description": "Colormap name.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current colormap when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "densityColormap(value)", "source": { "line": 11707, "path": "src/Helios.js" }, "summary": "Read or set the sequential colormap used by the density overlay." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "densityDivergingColormap", "parameters": [ { "attributes": "optional", "default": "", "description": "Diverging colormap name.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current colormap when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "densityDivergingColormap(value)", "source": { "line": 11720, "path": "src/Helios.js" }, "summary": "Read or set the diverging colormap used by comparison density overlays." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "updateDensityMap", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "updateDensityMap()", "source": { "line": 11732, "path": "src/Helios.js" }, "summary": "Request a density overlay update on the next render frame." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "redrawDensityMap", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "redrawDensityMap()", "source": { "line": 11744, "path": "src/Helios.js" }, "summary": "Alias for `updateDensityMap()`." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "edgeTransparencyMode", "parameters": [ { "attributes": "optional", "default": "", "description": "Transparency mode supported by the active renderer.", "name": "mode", "type": "string" } ], "remarks": "", "returns": { "description": "Current mode when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "edgeTransparencyMode(mode)", "source": { "line": 11757, "path": "src/Helios.js" }, "summary": "Read or set the edge transparency compositing mode." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labels", "parameters": [ { "attributes": "optional", "default": "", "description": "Label options, or `null` to disable labels.", "name": "options", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Enable ranked or selected labels.", "name": "options.enabled", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Label selection policy.", "name": "options.selectionMode", "type": "'ranked'|'selected-only'" }, { "attributes": "optional", "default": "", "description": "Maximum number of labels to render.", "name": "options.maxVisible", "type": "number" }, { "attributes": "optional", "default": "", "description": "Attribute name or callback used for label text.", "name": "options.source", "type": "string|Function" } ], "remarks": "", "returns": { "description": "Current label configuration when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "labels(options)", "source": { "line": 11779, "path": "src/Helios.js" }, "summary": "Read or update label rendering options." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "legends", "parameters": [ { "attributes": "optional", "default": "", "description": "Legend configuration, or `false`/`null` to disable legends.", "name": "options", "type": "Object|false|null" }, { "attributes": "optional", "default": "", "description": "Enable legend rendering.", "name": "options.enabled", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current legend configuration when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "legends(options)", "source": { "line": 11839, "path": "src/Helios.js" }, "summary": "Read or update legend rendering options." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "legendsEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable legends.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "legendsEnabled(value)", "source": { "line": 11859, "path": "src/Helios.js" }, "summary": "Read or set whether legends are enabled." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "overlayInsets", "parameters": [ { "attributes": "optional", "default": "", "description": "Insets in CSS pixels.", "name": "insets", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Top inset.", "name": "insets.top", "type": "number" }, { "attributes": "optional", "default": "", "description": "Right inset.", "name": "insets.right", "type": "number" }, { "attributes": "optional", "default": "", "description": "Bottom inset.", "name": "insets.bottom", "type": "number" }, { "attributes": "optional", "default": "", "description": "Left inset.", "name": "insets.left", "type": "number" } ], "remarks": "", "returns": { "description": "Current inset object when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "overlayInsets(insets)", "source": { "line": 12344, "path": "src/Helios.js" }, "summary": "Read or set reserved viewport insets for overlays such as labels and legends." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsEnabled", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable labels.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "labelsEnabled(value)", "source": { "line": 12368, "path": "src/Helios.js" }, "summary": "Read or set whether labels are enabled." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsMode", "parameters": [ { "attributes": "optional", "default": "", "description": "Label mode.", "name": "value", "type": "'auto'|'selected-only'|'off'" } ], "remarks": "", "returns": { "description": "Current mode when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "labelsMode(value)", "source": { "line": 12384, "path": "src/Helios.js" }, "summary": "Read or set the label selection mode." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsMaxVisible", "parameters": [ { "attributes": "optional", "default": "", "description": "Maximum label count.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsMaxVisible(value)", "source": { "line": 12414, "path": "src/Helios.js" }, "summary": "Read or set the maximum number of visible labels." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsSelectedOnlySpaceAware", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable collision-aware selected labels.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "labelsSelectedOnlySpaceAware(value)", "source": { "line": 12429, "path": "src/Helios.js" }, "summary": "Read or set whether selected-only labels still avoid spatial collisions." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsFontSizeScale", "parameters": [ { "attributes": "optional", "default": "", "description": "Font-size scale.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsFontSizeScale(value)", "source": { "line": 12442, "path": "src/Helios.js" }, "summary": "Read or set the label font-size multiplier." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsMinScreenRadius", "parameters": [ { "attributes": "optional", "default": "", "description": "Minimum radius in CSS pixels.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsMinScreenRadius(value)", "source": { "line": 12457, "path": "src/Helios.js" }, "summary": "Read or set the minimum on-screen node radius required for label candidates." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsOutlineWidth", "parameters": [ { "attributes": "optional", "default": "", "description": "Outline width in CSS pixels.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsOutlineWidth(value)", "source": { "line": 12472, "path": "src/Helios.js" }, "summary": "Read or set label outline width." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsOffsetRadiusFactor", "parameters": [ { "attributes": "optional", "default": "", "description": "Offset radius multiplier.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsOffsetRadiusFactor(value)", "source": { "line": 12487, "path": "src/Helios.js" }, "summary": "Read or set the radial node-size multiplier used to offset labels." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsOffsetPx", "parameters": [ { "attributes": "optional", "default": "", "description": "Offset in CSS pixels.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsOffsetPx(value)", "source": { "line": 12502, "path": "src/Helios.js" }, "summary": "Read or set the fixed pixel offset added to label placement." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsMaxChars", "parameters": [ { "attributes": "optional", "default": "", "description": "Maximum characters, or zero for no truncation.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsMaxChars(value)", "source": { "line": 12517, "path": "src/Helios.js" }, "summary": "Read or set the maximum number of characters per label row." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelsMaxRows", "parameters": [ { "attributes": "optional", "default": "", "description": "Maximum rows.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "number|Helios" }, "signature": "labelsMaxRows(value)", "source": { "line": 12532, "path": "src/Helios.js" }, "summary": "Read or set the maximum number of rows per wrapped label." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelFill", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS color string or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current color when omitted; otherwise this Helios instance.", "type": "string|Array|Helios|null" }, "signature": "labelFill(color)", "source": { "line": 12547, "path": "src/Helios.js" }, "summary": "Read or set label fill color." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelOutlineColor", "parameters": [ { "attributes": "optional", "default": "", "description": "CSS color string or normalized RGBA tuple.", "name": "color", "type": "string|Array" } ], "remarks": "", "returns": { "description": "Current color when omitted; otherwise this Helios instance.", "type": "string|Array|Helios|null" }, "signature": "labelOutlineColor(color)", "source": { "line": 12563, "path": "src/Helios.js" }, "summary": "Read or set label outline color." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelFontFamily", "parameters": [ { "attributes": "optional", "default": "", "description": "Font family string.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Current font family when omitted; otherwise this Helios instance.", "type": "string|Helios" }, "signature": "labelFontFamily(value)", "source": { "line": 12579, "path": "src/Helios.js" }, "summary": "Read or set the CSS font-family used by labels." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "labelSource", "parameters": [ { "attributes": "optional", "default": "", "description": "Attribute name, callback, or `null` for default labels.", "name": "value", "type": "string|Function|null" } ], "remarks": "", "returns": { "description": "Current source when omitted; otherwise this Helios instance.", "type": "string|Function|null|Helios" }, "signature": "labelSource(value)", "source": { "line": 12593, "path": "src/Helios.js" }, "summary": "Read or set the label text source." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "prewarm", "parameters": [ { "attributes": "optional", "default": "", "description": "Reserved for future prewarm controls.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Resolves when mapper prewarm work has completed.", "type": "Promise" }, "signature": "async prewarm(options = {})", "source": { "line": 12610, "path": "src/Helios.js" }, "summary": "Pre-runs mapper application before first render. Useful for large graphs where the first geometry pass is expensive. Can be awaited before `helios.ready` to shorten time to first render." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "createLayout", "parameters": [ { "attributes": "", "default": "", "description": "Layout instance or descriptor such as `{ type: 'gpu-force' }`.", "name": "layoutOption", "type": "Object|Layout" } ], "remarks": "", "returns": { "description": "Layout instance bound to the current render network.", "type": "Layout" }, "signature": "createLayout(layoutOption)", "source": { "line": 12642, "path": "src/Helios.js" }, "summary": "Create a layout instance from a layout option object or return an existing layout." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "addNodes", "parameters": [ { "attributes": "", "default": "", "description": "Number of nodes to add.", "name": "count", "type": "number" }, { "attributes": "optional", "default": "", "description": "Optional callback receiving created node ids and the visual attribute manager.", "name": "initializer", "type": "Function" } ], "remarks": "", "returns": { "description": "Created node indices.", "type": "Uint32Array" }, "signature": "addNodes(count, initializer)", "source": { "line": 12687, "path": "src/Helios.js" }, "summary": "Add nodes to the backing network and initialize their visual state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "addEdges", "parameters": [ { "attributes": "", "default": "", "description": "Edge pairs to insert.", "name": "edges", "type": "Array>|TypedArray" }, { "attributes": "optional", "default": "", "description": "Optional callback receiving created edge ids and the visual attribute manager.", "name": "initializer", "type": "Function" } ], "remarks": "", "returns": { "description": "Created edge indices.", "type": "Uint32Array" }, "signature": "addEdges(edges, initializer)", "source": { "line": 12716, "path": "src/Helios.js" }, "summary": "Add edges to the backing network and initialize their visual state." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "interactionRenderOrder", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable interaction-aware render-order promotion.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "interactionRenderOrder(value)", "source": { "line": 12796, "path": "src/Helios.js" }, "summary": "Read or set whether selected and highlighted items are promoted later in render order." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "nodeState", "parameters": [ { "attributes": "", "default": "", "description": "Node indices to update.", "name": "indices", "type": "Array|TypedArray|number" }, { "attributes": "", "default": "", "description": "State bitmask or named state such as `SELECTED` or `HIGHLIGHTED`.", "name": "mask", "type": "number|string|Array" }, { "attributes": "optional", "default": "", "description": "State update options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'replace'", "description": "How to combine the mask with the existing state.", "name": "options.mode", "type": "'replace'|'add'|'remove'|'toggle'" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "nodeState(indices, mask, options = {})", "source": { "line": 12867, "path": "src/Helios.js" }, "summary": "Apply a state bitmask to node indices." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "edgeState", "parameters": [ { "attributes": "", "default": "", "description": "Edge indices to update.", "name": "indices", "type": "Array|TypedArray|number" }, { "attributes": "", "default": "", "description": "State bitmask or named state such as `SELECTED` or `HIGHLIGHTED`.", "name": "mask", "type": "number|string|Array" }, { "attributes": "optional", "default": "", "description": "State update options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "'replace'", "description": "How to combine the mask with the existing state.", "name": "options.mode", "type": "'replace'|'add'|'remove'|'toggle'" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "edgeState(indices, mask, options = {})", "source": { "line": 12924, "path": "src/Helios.js" }, "summary": "Apply a state bitmask to edge indices." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "hoverNodeState", "parameters": [ { "attributes": "", "default": "", "description": "Hovered node index, or `null` to clear.", "name": "index", "type": "number|null" }, { "attributes": "optional", "default": "'HOVERED'", "description": "State mask applied while hovered.", "name": "mask", "type": "number|string|Array" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "hoverNodeState(index, mask)", "source": { "line": 12970, "path": "src/Helios.js" }, "summary": "Set transient hover state for a node." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "hoverEdgeState", "parameters": [ { "attributes": "", "default": "", "description": "Hovered edge index, or `null` to clear.", "name": "index", "type": "number|null" }, { "attributes": "optional", "default": "'HOVERED'", "description": "State mask applied while hovered.", "name": "mask", "type": "number|string|Array" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "hoverEdgeState(index, mask)", "source": { "line": 13008, "path": "src/Helios.js" }, "summary": "Set transient hover state for an edge." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "highlightConnectedEdges", "parameters": [ { "attributes": "optional", "default": "", "description": "Enable connected-edge highlighting.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "highlightConnectedEdges(value)", "source": { "line": 13110, "path": "src/Helios.js" }, "summary": "Read or set whether highlighted nodes also highlight their connected edges." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "nodeStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "State slot index or name.", "name": "slot", "type": "number|string" }, { "attributes": "optional", "default": "", "description": "Node state style with scale, opacity, outline, discard, and color fields.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when `style` is omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "nodeStateStyle(slot, style)", "source": { "line": 13130, "path": "src/Helios.js" }, "summary": "Read or set styling for nodes carrying a state bit." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "nodeNoStateStyle", "parameters": [ { "attributes": "optional", "default": "", "description": "Node style applied to unselected/unhighlighted nodes.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "nodeNoStateStyle(style)", "source": { "line": 13174, "path": "src/Helios.js" }, "summary": "Read or set styling for nodes with no active state bits." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "edgeStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "State slot index or name.", "name": "slot", "type": "number|string" }, { "attributes": "optional", "default": "", "description": "Edge state style with width, opacity, discard, and color fields.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when `style` is omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "edgeStateStyle(slot, style)", "source": { "line": 13206, "path": "src/Helios.js" }, "summary": "Read or set styling for edges carrying a state bit." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "edgeNoStateStyle", "parameters": [ { "attributes": "optional", "default": "", "description": "Edge style applied to unselected/unhighlighted edges.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "edgeNoStateStyle(style)", "source": { "line": 13249, "path": "src/Helios.js" }, "summary": "Read or set styling for edges with no active state bits." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "nodeHoverStyle", "parameters": [ { "attributes": "optional", "default": "", "description": "Node hover style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "nodeHoverStyle(style)", "source": { "line": 13279, "path": "src/Helios.js" }, "summary": "Read or set the transient hover style for nodes." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "edgeHoverStyle", "parameters": [ { "attributes": "optional", "default": "", "description": "Edge hover style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Current style when omitted; otherwise this Helios instance.", "type": "Object|null|Helios" }, "signature": "edgeHoverStyle(style)", "source": { "line": 13308, "path": "src/Helios.js" }, "summary": "Read or set the transient hover style for edges." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "hoverStyleFromHighlight", "parameters": [ { "attributes": "optional", "default": "", "description": "Copy highlighted styles into hover styles.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Current value when omitted; otherwise this Helios instance.", "type": "boolean|Helios" }, "signature": "hoverStyleFromHighlight(value)", "source": { "line": 13344, "path": "src/Helios.js" }, "summary": "Read or set whether hover style follows the highlighted-state style." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "resetStateStyles", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "resetStateStyles()", "source": { "line": 13362, "path": "src/Helios.js" }, "summary": "Reset all node and edge state styles to renderer defaults." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "mappers", "parameters": [ { "attributes": "optional", "default": "", "description": "Mapper replacements. Omit to read active mapper collections.", "name": "mappers", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Replacement default node mapper.", "name": "mappers.nodeMapper", "type": "Mapper" }, { "attributes": "optional", "default": "", "description": "Replacement default edge mapper.", "name": "mappers.edgeMapper", "type": "Mapper" }, { "attributes": "", "default": "", "description": "Value passed to `mappers`.", "name": "nodeMapper", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `mappers`.", "name": "edgeMapper", "type": "" } ], "remarks": "", "returns": { "description": "Current mapper collections when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "mappers({ nodeMapper, edgeMapper } = {})", "source": { "line": 13386, "path": "src/Helios.js" }, "summary": "Read, replace, or reset the default node and edge mapper collections." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "layout", "parameters": [ { "attributes": "optional", "default": "", "description": "Layout instance extending the Helios layout base class.", "name": "layout", "type": "Layout" } ], "remarks": "", "returns": { "description": "Current layout when omitted; otherwise this Helios instance.", "type": "Layout|Helios" }, "signature": "layout(layout)", "source": { "line": 13432, "path": "src/Helios.js" }, "summary": "Read or replace the active layout instance." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getLayoutPositionAttributeChoices", "parameters": [ { "attributes": "optional", "default": "", "description": "Choice discovery options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Network to inspect. Defaults to the active network.", "name": "options.network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "", "description": "Mode used to label random seed choices.", "name": "options.mode", "type": "'2d'|'3d'" } ], "remarks": "", "returns": { "description": "Position choices with `value`, `label`, and `dimension` fields.", "type": "Array." }, "signature": "getLayoutPositionAttributeChoices(options = {})", "source": { "line": 13490, "path": "src/Helios.js" }, "summary": "List node attributes that can seed layout positions." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "setLayoutPositionsFromNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Source node attribute name, or the random seed choice value.", "name": "name", "type": "string" }, { "attributes": "optional", "default": "", "description": "Position-copy options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Network to update. Defaults to the active network.", "name": "options.network", "type": "HeliosNetwork" } ], "remarks": "", "returns": { "description": "`true` when positions were written.", "type": "boolean" }, "signature": "setLayoutPositionsFromNodeAttribute(name, options = {})", "source": { "line": 13545, "path": "src/Helios.js" }, "summary": "Copy a numeric node attribute into the canonical layout-position attribute." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "positions", "parameters": [ { "attributes": "optional", "default": "", "description": "Position pipeline options, or `null` to reset to network-backed positions.", "name": "options", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Source for current positions.", "name": "options.source", "type": "'network'|'delegate'" }, { "attributes": "optional", "default": "", "description": "Delegate used when `source` is `delegate`.", "name": "options.delegate", "type": "PositionDelegate" } ], "remarks": "", "returns": { "description": "Current position source when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "positions(options)", "source": { "line": 13680, "path": "src/Helios.js" }, "summary": "Read or update the active position source used for rendering and layout handoff." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotDelegatePositions", "parameters": [ { "attributes": "optional", "default": "", "description": "Delegate readback options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Delegate to read. Defaults to the active delegate.", "name": "options.delegate", "type": "PositionDelegate" } ], "remarks": "", "returns": { "description": "Packed `x,y,z` positions, or `null` when no delegate is available.", "type": "Promise" }, "signature": "async snapshotDelegatePositions(options = {})", "source": { "line": 13711, "path": "src/Helios.js" }, "summary": "Snapshot all node positions from the active or supplied position delegate." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodePositions", "parameters": [ { "attributes": "", "default": "", "description": "Node indices to read.", "name": "nodeIds", "type": "Array|TypedArray|number" }, { "attributes": "optional", "default": "", "description": "Readback options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional output buffer.", "name": "options.out", "type": "Float32Array" }, { "attributes": "optional", "default": "", "description": "Delegate override.", "name": "options.delegate", "type": "PositionDelegate" } ], "remarks": "", "returns": { "description": "Readback result with ids, packed positions, count, version, and source.", "type": "Promise" }, "signature": "async snapshotNodePositions(nodeIds, options = {})", "source": { "line": 13739, "path": "src/Helios.js" }, "summary": "Snapshot selected node positions from the active position source." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodePosition", "parameters": [ { "attributes": "", "default": "", "description": "Node index to read.", "name": "nodeId", "type": "number" }, { "attributes": "optional", "default": "", "description": "Readback options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional output buffer with length at least three.", "name": "options.out", "type": "Float32Array" } ], "remarks": "", "returns": { "description": "Readback result with id, position, version, and source.", "type": "Promise" }, "signature": "async snapshotNodePosition(nodeId, options = {})", "source": { "line": 13816, "path": "src/Helios.js" }, "summary": "Snapshot one node position from the active position source." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodeCentroid", "parameters": [ { "attributes": "", "default": "", "description": "Node indices to include.", "name": "nodeIds", "type": "Array|TypedArray|number" }, { "attributes": "optional", "default": "", "description": "Readback options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional output buffer with length at least three.", "name": "options.out", "type": "Float32Array" } ], "remarks": "", "returns": { "description": "Centroid result with centroid, count, version, and source.", "type": "Promise" }, "signature": "async snapshotNodeCentroid(nodeIds, options = {})", "source": { "line": 13848, "path": "src/Helios.js" }, "summary": "Compute the centroid of selected nodes from the active position source." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "syncDelegatePositionsToNetwork", "parameters": [ { "attributes": "optional", "default": "", "description": "Delegate synchronization options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Delegate to synchronize. Defaults to the active delegate.", "name": "options.delegate", "type": "PositionDelegate" } ], "remarks": "", "returns": { "description": "`true` when network positions were updated.", "type": "Promise" }, "signature": "async syncDelegatePositionsToNetwork(options = {})", "source": { "line": 13885, "path": "src/Helios.js" }, "summary": "Write the active delegate position snapshot back into the network position attribute." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "interpolation", "parameters": [ { "attributes": "optional", "default": "", "description": "Interpolation options, mode string, or `null` to disable interpolation.", "name": "options", "type": "Object|string|null" }, { "attributes": "optional", "default": "", "description": "Enable position interpolation.", "name": "options.enabled", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Duration strategy.", "name": "options.durationMode", "type": "'adaptive'|'fixed'" }, { "attributes": "optional", "default": "", "description": "Fixed interpolation duration in milliseconds.", "name": "options.durationMs", "type": "number" } ], "remarks": "", "returns": { "description": "Current interpolation snapshot when omitted; otherwise this Helios instance.", "type": "Object|Helios" }, "signature": "interpolation(options)", "source": { "line": 13915, "path": "src/Helios.js" }, "summary": "Read or update GPU position interpolation settings." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "setLayout", "parameters": [ { "attributes": "", "default": "", "description": "Replacement layout.", "name": "layout", "type": "Layout" } ], "remarks": "", "returns": { "description": "Result of `layout(layout)`.", "type": "Layout|Helios" }, "signature": "setLayout(layout)", "source": { "line": 14065, "path": "src/Helios.js" }, "summary": "Alias for `layout(layout)`." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "setPositions", "parameters": [ { "attributes": "", "default": "", "description": "Position pipeline options.", "name": "options", "type": "Object|null" } ], "remarks": "", "returns": { "description": "Result of `positions(options)`.", "type": "Object|Helios" }, "signature": "setPositions(options)", "source": { "line": 14074, "path": "src/Helios.js" }, "summary": "Alias for `positions(options)`." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "setInterpolation", "parameters": [ { "attributes": "", "default": "", "description": "Interpolation options.", "name": "options", "type": "Object|string|null" } ], "remarks": "", "returns": { "description": "Result of `interpolation(options)`.", "type": "Object|Helios" }, "signature": "setInterpolation(options)", "source": { "line": 14083, "path": "src/Helios.js" }, "summary": "Alias for `interpolation(options)`." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "setDensity", "parameters": [ { "attributes": "", "default": "", "description": "Density options.", "name": "options", "type": "Object|false|null" } ], "remarks": "", "returns": { "description": "Result of `density(options)`.", "type": "Object|Helios" }, "signature": "setDensity(options)", "source": { "line": 14092, "path": "src/Helios.js" }, "summary": "Alias for `density(options)`." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "setLabels", "parameters": [ { "attributes": "", "default": "", "description": "Label options.", "name": "options", "type": "Object|null" } ], "remarks": "", "returns": { "description": "Result of `labels(options)`.", "type": "Object|Helios" }, "signature": "setLabels(options)", "source": { "line": 14101, "path": "src/Helios.js" }, "summary": "Alias for `labels(options)`." }, { "category": "Density And Labels", "examples": [], "kind": "method", "methods": [], "name": "setLegends", "parameters": [ { "attributes": "", "default": "", "description": "Legend options.", "name": "options", "type": "Object|false|null" } ], "remarks": "", "returns": { "description": "Result of `legends(options)`.", "type": "Object|Helios" }, "signature": "setLegends(options)", "source": { "line": 14110, "path": "src/Helios.js" }, "summary": "Alias for `legends(options)`." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "setMappers", "parameters": [ { "attributes": "", "default": "", "description": "Mapper replacements.", "name": "mappers", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `mappers(mappers)`.", "type": "Object|Helios" }, "signature": "setMappers(mappers)", "source": { "line": 14119, "path": "src/Helios.js" }, "summary": "Alias for `mappers(mappers)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setNodeState", "parameters": [ { "attributes": "", "default": "", "description": "Node indices.", "name": "indices", "type": "Array|TypedArray|number" }, { "attributes": "", "default": "", "description": "State mask.", "name": "mask", "type": "number|string|Array" }, { "attributes": "optional", "default": "", "description": "State options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "setNodeState(indices, mask, options)", "source": { "line": 14130, "path": "src/Helios.js" }, "summary": "Alias for `nodeState(indices, mask, options)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setEdgeState", "parameters": [ { "attributes": "", "default": "", "description": "Edge indices.", "name": "indices", "type": "Array|TypedArray|number" }, { "attributes": "", "default": "", "description": "State mask.", "name": "mask", "type": "number|string|Array" }, { "attributes": "optional", "default": "", "description": "State options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "setEdgeState(indices, mask, options)", "source": { "line": 14141, "path": "src/Helios.js" }, "summary": "Alias for `edgeState(indices, mask, options)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setNodeStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "State slot.", "name": "slot", "type": "number|string" }, { "attributes": "", "default": "", "description": "Node style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `nodeStateStyle(slot, style)`.", "type": "Object|null|Helios" }, "signature": "setNodeStateStyle(slot, style)", "source": { "line": 14151, "path": "src/Helios.js" }, "summary": "Alias for `nodeStateStyle(slot, style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setEdgeStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "State slot.", "name": "slot", "type": "number|string" }, { "attributes": "", "default": "", "description": "Edge style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `edgeStateStyle(slot, style)`.", "type": "Object|null|Helios" }, "signature": "setEdgeStateStyle(slot, style)", "source": { "line": 14161, "path": "src/Helios.js" }, "summary": "Alias for `edgeStateStyle(slot, style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setNodeNoStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "Node style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `nodeNoStateStyle(style)`.", "type": "Object|null|Helios" }, "signature": "setNodeNoStateStyle(style)", "source": { "line": 14170, "path": "src/Helios.js" }, "summary": "Alias for `nodeNoStateStyle(style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setEdgeNoStateStyle", "parameters": [ { "attributes": "", "default": "", "description": "Edge style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `edgeNoStateStyle(style)`.", "type": "Object|null|Helios" }, "signature": "setEdgeNoStateStyle(style)", "source": { "line": 14179, "path": "src/Helios.js" }, "summary": "Alias for `edgeNoStateStyle(style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setNodeHoverStyle", "parameters": [ { "attributes": "", "default": "", "description": "Node hover style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `nodeHoverStyle(style)`.", "type": "Object|null|Helios" }, "signature": "setNodeHoverStyle(style)", "source": { "line": 14188, "path": "src/Helios.js" }, "summary": "Alias for `nodeHoverStyle(style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setEdgeHoverStyle", "parameters": [ { "attributes": "", "default": "", "description": "Edge hover style.", "name": "style", "type": "Object" } ], "remarks": "", "returns": { "description": "Result of `edgeHoverStyle(style)`.", "type": "Object|null|Helios" }, "signature": "setEdgeHoverStyle(style)", "source": { "line": 14197, "path": "src/Helios.js" }, "summary": "Alias for `edgeHoverStyle(style)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setHoverStyleFromHighlight", "parameters": [ { "attributes": "", "default": "", "description": "Enable hover style from highlight.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Result of `hoverStyleFromHighlight(value)`.", "type": "boolean|Helios" }, "signature": "setHoverStyleFromHighlight(value)", "source": { "line": 14206, "path": "src/Helios.js" }, "summary": "Alias for `hoverStyleFromHighlight(value)`." }, { "category": "Interaction", "examples": [], "kind": "method", "methods": [], "name": "setHighlightConnectedEdges", "parameters": [ { "attributes": "", "default": "", "description": "Enable connected-edge highlighting.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "Result of `highlightConnectedEdges(value)`.", "type": "boolean|Helios" }, "signature": "setHighlightConnectedEdges(value)", "source": { "line": 14215, "path": "src/Helios.js" }, "summary": "Alias for `highlightConnectedEdges(value)`." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "startLayout", "parameters": [ { "attributes": "optional", "default": "null", "description": "Optional layout type or parameter object.", "name": "algo", "type": "string|Object|null" }, { "attributes": "optional", "default": "null", "description": "Optional parameters when `algo` is a string.", "name": "params", "type": "Object|null" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "startLayout(algo = null, params = null)", "source": { "line": 14226, "path": "src/Helios.js" }, "summary": "Enable layout execution and optionally request a layout algorithm or parameters." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "stopLayout", "parameters": [ { "attributes": "optional", "default": "'user'", "description": "Reason recorded for the scheduler state change.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "stopLayout(reason = 'user')", "source": { "line": 14246, "path": "src/Helios.js" }, "summary": "Disable layout execution." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "requestRender", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "requestRender()", "source": { "line": 14258, "path": "src/Helios.js" }, "summary": "Schedule a render frame." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "performRendering", "parameters": [], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "performRendering()", "source": { "line": 14270, "path": "src/Helios.js" }, "summary": "Render one frame immediately when manual rendering is enabled." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "enableAttributeTracking", "parameters": [ { "attributes": "optional", "default": "'$index'", "description": "Node attribute to encode into the tracking target.", "name": "nodeAttribute", "type": "string" }, { "attributes": "optional", "default": "null", "description": "Edge attribute to encode into the tracking target.", "name": "edgeAttribute", "type": "string|null" }, { "attributes": "optional", "default": "", "description": "Tracking resolution and auto-update options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Attribute tracker instance, or `null` before renderer initialization.", "type": "AttributeTracker|null" }, "signature": "enableAttributeTracking(nodeAttribute = '$index', edgeAttribute = null, options = {})", "source": { "line": 14319, "path": "src/Helios.js" }, "summary": "Enable offscreen attribute tracking for picking." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "disableAttributeTracking", "parameters": [ { "attributes": "optional", "default": "", "description": "Scope to disable. Omit to disable all configured tracking.", "name": "scope", "type": "'node'|'edge'|string" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "disableAttributeTracking(scope)", "source": { "line": 14342, "path": "src/Helios.js" }, "summary": "Disable attribute tracking for a scope or for all scopes." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "renderAttributeTracking", "parameters": [], "remarks": "", "returns": { "description": "Tracking render result, or `null` when tracking is disabled.", "type": "Promise" }, "signature": "async renderAttributeTracking()", "source": { "line": 14353, "path": "src/Helios.js" }, "summary": "Render the attribute-tracking target for the current frame." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "pickAttributesAt", "parameters": [ { "attributes": "", "default": "", "description": "Viewport x coordinate.", "name": "clientX", "type": "number" }, { "attributes": "", "default": "", "description": "Viewport y coordinate.", "name": "clientY", "type": "number" } ], "remarks": "", "returns": { "description": "Picked node and edge ids, or `-1` for misses.", "type": "Promise<{node:number, edge:number}>" }, "signature": "async pickAttributesAt(clientX, clientY)", "source": { "line": 14373, "path": "src/Helios.js" }, "summary": "Pick encoded node and edge attributes at viewport coordinates." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "getFramebufferVersionsByRefMap", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getFramebufferVersionsByRefMap()", "source": { "line": 14386, "path": "src/Helios.js" }, "summary": "Returns a Map of framebuffer/attachment references to monotonically increasing \"version\" counters (wrapping at Number.MAX_SAFE_INTEGER). Keys are live object references (e.g. RenderTarget instances, WebGLFramebuffer, GPUTexture) so they can be used for identity comparisons." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "getFramebufferInformation", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getFramebufferInformation()", "source": { "line": 14428, "path": "src/Helios.js" }, "summary": "Returns framebuffer/attachment information keyed by a meaningful name. Values include the version counter and a minimal shape description. Key format conventions: - `attributes...[.]` - `render.`" }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "getFramebufferVersions", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getFramebufferVersions()", "source": { "line": 14558, "path": "src/Helios.js" }, "summary": "Returns an object keyed by a meaningful framebuffer name, where each value is the version counter. Key format conventions: - `attributes...[.]` - `render.`" }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "getFramebufferVersionsByRef", "parameters": [], "remarks": "", "returns": { "description": "Plain object mapping framebuffer references to version numbers.", "type": "Object" }, "signature": "getFramebufferVersionsByRef()", "source": { "line": 14626, "path": "src/Helios.js" }, "summary": "Return framebuffer resource versions keyed by reference for renderer diagnostics." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "enableNodePicking", "parameters": [ { "attributes": "optional", "default": "", "description": "Picking behavior options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "enableNodePicking(options = {})", "source": { "line": 14638, "path": "src/Helios.js" }, "summary": "Enable pointer picking for nodes." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "enableEdgePicking", "parameters": [ { "attributes": "optional", "default": "", "description": "Picking behavior options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "enableEdgePicking(options = {})", "source": { "line": 14654, "path": "src/Helios.js" }, "summary": "Enable pointer picking for edges." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "disableNodePicking", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "disableNodePicking()", "source": { "line": 14669, "path": "src/Helios.js" }, "summary": "Disable node pointer picking." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "disableEdgePicking", "parameters": [], "remarks": "", "returns": { "description": "This Helios instance.", "type": "Helios" }, "signature": "disableEdgePicking()", "source": { "line": 14682, "path": "src/Helios.js" }, "summary": "Disable edge pointer picking." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "destroy()", "source": { "line": 15281, "path": "src/Helios.js" }, "summary": "Dispose renderer resources, UI bindings, workers, timers, and event listeners owned by this instance." } ], "name": "Helios", "parameters": [ { "attributes": "", "default": "", "description": "WASM-backed graph store\nthat supplies topology, attributes, and serialization.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "", "description": "Renderer, layout, behavior, mapper, interface,\npersistence, touch, camera, and quality options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "document.body", "description": "Element or selector\nthat receives the Helios canvas, SVG overlays, and interaction layers.", "name": "options.container", "type": "Element|string" }, { "attributes": "optional", "default": "'auto'", "description": "Preferred\nrenderer backend. `auto` chooses WebGPU when available and falls back to WebGL2.", "name": "options.renderer", "type": "'auto'|'webgpu'|'webgl'" }, { "attributes": "optional", "default": "'2d'", "description": "Initial dimensional mode.", "name": "options.mode", "type": "'2d'|'3d'" }, { "attributes": "optional", "default": "'perspective'", "description": "Initial\n3D camera projection.", "name": "options.projection", "type": "'perspective'|'orthographic'" }, { "attributes": "optional", "default": "", "description": "Layout configuration or a layout\ninstance to use for graph positions.", "name": "options.layout", "type": "Object|Layout" }, { "attributes": "optional", "default": "'gpu-force'", "description": "Built-in layout key used\nwhen `options.layout` is a configuration object.", "name": "options.layout.type", "type": "string" }, { "attributes": "optional", "default": "", "description": "Layout-specific options passed to\nthe selected layout implementation.", "name": "options.layout.options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "First-frame startup behavior, or\n`false` to disable the loading overlay, canvas hiding, and layout warmup.", "name": "options.startup", "type": "Object|false" }, { "attributes": "optional", "default": "true", "description": "Show a centered\nloading spinner while Helios is preparing the first visible frame.", "name": "options.startup.loadingOverlay", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Keep the\ncanvas hidden until the first intended graph frame is rendered.", "name": "options.startup.hideCanvasUntilFirstFrame", "type": "boolean" }, { "attributes": "optional", "default": "100", "description": "Optional number of\nlayout updates to wait before the first visible graph frame.", "name": "options.startup.layoutIterations", "type": "number" }, { "attributes": "optional", "default": "1000", "description": "Optional layout warmup\ntime to wait before the first visible graph frame. When both layout warmup\nlimits are set, the first one reached releases the frame. Large initial\nnetworks use a 5000 ms default duration unless this option is set.", "name": "options.startup.layoutDurationMs", "type": "number" }, { "attributes": "optional", "default": "", "description": "Built-in behavior options, custom\nbehavior instances, or `false` to disable default behaviors.", "name": "options.behaviors", "type": "Object|false" }, { "attributes": "optional", "default": "", "description": "Initial node and edge mapper\nconfiguration. Pass `null` to skip default mapper setup.", "name": "options.mappers", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Position interpolation\ncontrols used when switching layouts or applying saved positions.", "name": "options.interpolation", "type": "Object|false" }, { "attributes": "optional", "default": "", "description": "Initial label overlay options handled by\n`LabelsBehavior`.", "name": "options.labels", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Initial legend overlay options handled by\n`LegendsBehavior`.", "name": "options.legends", "type": "Object" }, { "attributes": "optional", "default": "false", "description": "Density layer enablement or\ndensity layer options.", "name": "options.density", "type": "boolean|Object" }, { "attributes": "optional", "default": "'weighted'", "description": "Edge\ntransparency mode. The default weighted mode accumulates overlapping edges\nwithout forcing every edge through the same alpha curve.", "name": "options.transparencyModeEdges", "type": "string" }, { "attributes": "optional", "default": "", "description": "Camera framing, controls, and target\ntracking options.", "name": "options.camera", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Start large\ninitial networks from a wider fit and settle toward the normal fit while\nautomatic fitting remains enabled.", "name": "options.camera.largeNetworkStartupFit", "type": "boolean" }, { "attributes": "optional", "default": "1000000", "description": "Node count threshold for wide startup fitting.", "name": "options.camera.largeNetworkStartupNodeThreshold", "type": "number" }, { "attributes": "optional", "default": "1000000", "description": "Edge count threshold for wide startup fitting.", "name": "options.camera.largeNetworkStartupEdgeThreshold", "type": "number" }, { "attributes": "optional", "default": "4", "description": "Multiplier used\nto move the startup fit farther from the graph before settling.", "name": "options.camera.largeNetworkStartupScale", "type": "number" }, { "attributes": "optional", "default": "2200", "description": "Duration of the automatic startup settle animation.", "name": "options.camera.largeNetworkStartupDurationMs", "type": "number" }, { "attributes": "optional", "default": "true", "description": "Compact top-right\nauto-fit, layout pause/run, and zoom controls. Pass `false` to disable all\ncontrols, or disable individual groups with `autoFit`, `layout`, or `zoom`.", "name": "options.quickControls", "type": "boolean|Object" }, { "attributes": "optional", "default": "false", "description": "Optional HeliosUI creation.\nPass `true` to create the standard panel set, or an object with HeliosUI\noptions and `panels` set to a panel name, array of names, `true`, or `false`.", "name": "options.ui", "type": "boolean|Object" }, { "attributes": "optional", "default": "", "description": "Metadata for the active network,\nsuch as `name`, `baseName`, `format`, and provenance fields used by\npersistence and file actions.", "name": "options.networkSource", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "File-drop behavior for\nloading supported network files into the active view.", "name": "options.fileDrop", "type": "boolean|Object" }, { "attributes": "optional", "default": "", "description": "Storage backend configuration.\nPass `false` to disable persistent sessions, `true` for browser storage, or\nan object accepted by `createHeliosStorageManager`.", "name": "options.storage", "type": "boolean|Object" }, { "attributes": "optional", "default": "", "description": "Session persistence\ncontrols or explicit session id used by browser/native storage backends.", "name": "options.session", "type": "boolean|Object|string" }, { "attributes": "optional", "default": "'default'", "description": "Workspace namespace for\npersisted preferences and sessions.", "name": "options.workspaceId", "type": "string" }, { "attributes": "optional", "default": "false", "description": "Persist the network payload\nas part of browser/native session saves.", "name": "options.persistNetwork", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Network payload persistence\npolicy, size limits, and backend-specific options.", "name": "options.networkPersistence", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Separate layout-position\npersistence policy for storage backends that support split payloads.", "name": "options.positionPersistence", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Thumbnail capture policy\nfor saved sessions.", "name": "options.sessionThumbnail", "type": "boolean|Object" }, { "attributes": "optional", "default": "true", "description": "Prevent native\nbrowser pan, zoom, and selection gestures over the visualization.", "name": "options.suppressBrowserGestures", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Destroy this Helios instance when\nits root or container is removed from the DOM.", "name": "options.autoCleanup", "type": "boolean" }, { "attributes": "optional", "default": "true", "description": "Dispose the active\nnetwork when `destroy()` runs.", "name": "options.disposeNetworkOnDestroy", "type": "boolean" }, { "attributes": "optional", "default": "false", "description": "Disable automatic scheduler\nrendering so the host application can request frames explicitly.", "name": "options.manualRendering", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Optional scheduler FPS cap.", "name": "options.maxFps", "type": "number" }, { "attributes": "optional", "default": "'high-performance'", "description": "Preferred GPU class for WebGL and WebGPU initialization.", "name": "options.powerPreference", "type": "'high-performance'|'low-power'" }, { "attributes": "optional", "default": "", "description": "Extra\nWebGL2 context attributes merged over Helios defaults.", "name": "options.webglContextAttributes", "type": "WebGLContextAttributes" }, { "attributes": "optional", "default": "", "description": "Extra\nWebGPU adapter options merged over Helios defaults.", "name": "options.webgpuAdapterOptions", "type": "GPURequestAdapterOptions" }, { "attributes": "optional", "default": "", "description": "Extra\nWebGPU device descriptor options. Explicit `requiredLimits` are merged with\nHelios' graph-oriented limit requests.", "name": "options.webgpuDeviceDescriptor", "type": "GPUDeviceDescriptor" }, { "attributes": "optional", "default": "", "description": "Extra WebGPU canvas configuration values merged over Helios defaults.", "name": "options.webgpuCanvasConfiguration", "type": "Partial" }, { "attributes": "optional", "default": "", "description": "Canvas\nsupersampling mode or scale factor.", "name": "options.supersampling", "type": "boolean|string|number" }, { "attributes": "optional", "default": "", "description": "Initial renderer/UI theme.\nWhen omitted, Helios follows `data-helios-theme`, `data-theme`,\n`data-md-color-scheme`, or the browser color-scheme preference.", "name": "options.theme", "type": "'dark'|'light'|string" }, { "attributes": "optional", "default": "", "description": "Renderer background\ncolor. Takes precedence over theme-derived defaults.", "name": "options.background", "type": "string|Array" }, { "attributes": "optional", "default": "", "description": "Renderer clear color.\nTakes precedence over theme-derived defaults.", "name": "options.clearColor", "type": "string|Array" } ], "remarks": "`options.container` should be an element or selector that already\nhas stable dimensions. `options.renderer` can prefer `webgpu` or `webgl`;\nHelios falls back according to renderer availability. Built-in behaviors are\nattached by default; `options.behaviors` accepts behavior options or custom\nbehavior instances when an app needs to tune or extend them. Set\n`suppressBrowserGestures: true` for touch-first embedded canvases. Helios\nautomatically destroys itself when its root or container is removed from the\nDOM unless `options.autoCleanup` is `false`. Destroying Helios disposes the\ncurrent network by default; pass `disposeNetworkOnDestroy: false` when the\napplication will keep using the same network after unmount.", "returns": { "description": "Visualization controller with a `ready` promise that\nresolves after renderer, scheduler, layers, behaviors, and initial geometry\nare initialized.", "type": "Helios" }, "signature": "export class Helios extends EventTarget {", "source": { "line": 2236, "path": "src/Helios.js" }, "summary": "Main Helios Web visualization controller for one `helios-network` graph." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'appearance';", "source": { "line": 464, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 466, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 473, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 494, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 504, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 510, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 618, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "appearance", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "appearance(options)", "source": { "line": 625, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Read or set the appearance setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "supportsAmbientOcclusion", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "supportsAmbientOcclusion()", "source": { "line": 630, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Configures or reads supports ambient occlusion." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 634, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 638, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Configures or reads emit change." } ], "name": "AppearanceBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Background, node/edge scale and opacity,\nshading, ambient occlusion, and adaptive edge quality options.", "name": "options", "type": "Object" } ], "remarks": "Renderer capability affects some appearance options. Query\n`supportsAmbientOcclusion()` after `await helios.ready` before exposing\nambient-occlusion controls.", "returns": { "description": "Behavior that keeps appearance settings\nserializable and synchronized with UI bindings.", "type": "AppearanceBehavior" }, "signature": "export class AppearanceBehavior extends Behavior {", "source": { "line": 463, "path": "src/behaviors/AppearanceBehavior.js" }, "summary": "Built-in behavior for global visual appearance and render quality." }, { "category": "Behaviors", "examples": [ "class PulseBehavior extends Behavior {\n static id = 'pulse';\n attach(context) {\n super.attach(context);\n const timer = setInterval(() => context.helios.requestRender(), 500);\n this.addCleanup(() => clearInterval(timer));\n return this;\n }\n}" ], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = null;", "source": { "line": 34, "path": "src/behaviors/Behavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 36, "path": "src/behaviors/Behavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 44, "path": "src/behaviors/Behavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "detach", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "detach()", "source": { "line": 49, "path": "src/behaviors/Behavior.js" }, "summary": "Manages detach for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 62, "path": "src/behaviors/Behavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 69, "path": "src/behaviors/Behavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 73, "path": "src/behaviors/Behavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "addCleanup", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `addCleanup`.", "name": "cleanup", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "addCleanup(cleanup)", "source": { "line": 80, "path": "src/behaviors/Behavior.js" }, "summary": "Manages cleanup for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "removeCleanup", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `removeCleanup`.", "name": "cleanup", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "removeCleanup(cleanup)", "source": { "line": 86, "path": "src/behaviors/Behavior.js" }, "summary": "Manages cleanup for the current instance." }, { "category": "Events", "examples": [], "kind": "method", "methods": [], "name": "emit", "parameters": [ { "attributes": "", "default": "", "description": "Attribute value type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emit(type, detail)", "source": { "line": 91, "path": "src/behaviors/Behavior.js" }, "summary": "Configures or reads emit." }, { "category": "Events", "examples": [], "kind": "method", "methods": [], "name": "on", "parameters": [ { "attributes": "", "default": "", "description": "Attribute value type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Callback invoked for the registered event.", "name": "handler", "type": "Function" }, { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "on(type, handler, options)", "source": { "line": 96, "path": "src/behaviors/Behavior.js" }, "summary": "Configures or reads on." } ], "name": "Behavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Serializable configuration owned by the behavior.", "name": "options", "type": "Object" } ], "remarks": "Behaviors attach to a Helios context, own serializable state, emit\nchange events, and register cleanup hooks for listeners, timers, and UI\nbindings. Custom behaviors should override `attach`, `detach`, `serialize`,\nand `restore` only where needed.", "returns": { "description": "Detached behavior instance; Helios attaches it through\n`helios.useBehavior(...)` or `BehaviorManager.use(...)`.", "type": "Behavior" }, "signature": "export class Behavior extends EventTarget {", "source": { "line": 33, "path": "src/behaviors/Behavior.js" }, "summary": "Base class for reusable Helios application behaviors." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "helios", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "registry", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(helios, registry)", "source": { "line": 18, "path": "src/behaviors/BehaviorManager.js" }, "summary": "" }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setUI", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setUI`.", "name": "ui", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setUI(ui)", "source": { "line": 26, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Set the ui setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "has", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `has`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "has(id)", "source": { "line": 31, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Returns the current has value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "get", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `get`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get(id)", "source": { "line": 35, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Returns the current get value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "entries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "entries()", "source": { "line": 39, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Configures or reads entries." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "values", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "values()", "source": { "line": 43, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Configures or reads values." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "use", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `use`.", "name": "idOrBehavior", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "use(idOrBehavior, options = {})", "source": { "line": 47, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Manages use for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "detach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `detach`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "detach(id)", "source": { "line": 68, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Manages detach for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "detachAll", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "detachAll()", "source": { "line": 79, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Manages all for the current instance." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "destroy()", "source": { "line": 92, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Manages destroy for the current instance." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 98, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 107, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Updates the restore state on the current instance." } ], "name": "BehaviorManager", "parameters": [ { "attributes": "", "default": "", "description": "Visualization controller that\nbehaviors will attach to.", "name": "helios", "type": "import('../Helios.js').Helios" }, { "attributes": "", "default": "", "description": "Registry used to instantiate named\nbehaviors.", "name": "registry", "type": "BehaviorRegistry" } ], "remarks": "The manager creates, attaches, detaches, serializes, and restores\nbehavior instances against a shared Helios context. Use the higher-level\n`helios.behavior` namespace for most app code.", "returns": { "description": "Manager with no active behaviors attached.", "type": "BehaviorManager" }, "signature": "export class BehaviorManager {", "source": { "line": 17, "path": "src/behaviors/BehaviorManager.js" }, "summary": "Runtime owner for active behavior instances on a Helios visualization." }, { "category": "Behaviors", "examples": [ "const registry = new BehaviorRegistry().register('custom', CustomBehavior);" ], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor()", "source": { "line": 14, "path": "src/behaviors/BehaviorRegistry.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "register", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `register`.", "name": "id", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `register`.", "name": "behavior", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "register(id, behavior)", "source": { "line": 18, "path": "src/behaviors/BehaviorRegistry.js" }, "summary": "Manages register for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "has", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `has`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "has(id)", "source": { "line": 28, "path": "src/behaviors/BehaviorRegistry.js" }, "summary": "Returns the current has value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "create", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `create`.", "name": "id", "type": "" }, { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "create(id, options)", "source": { "line": 32, "path": "src/behaviors/BehaviorRegistry.js" }, "summary": "Configures or reads create." } ], "name": "BehaviorRegistry", "parameters": [], "remarks": "The registry is the public extension point behind\n`helios.registerBehavior(...)`; created behaviors still attach through\n`BehaviorManager`, so persistence and cleanup flow remains consistent.", "returns": { "description": "Empty registry ready for built-in or custom\nbehavior registration.", "type": "BehaviorRegistry" }, "signature": "export class BehaviorRegistry {", "source": { "line": 13, "path": "src/behaviors/BehaviorRegistry.js" }, "summary": "Registry mapping behavior ids to behavior constructors or factories." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'exporter';", "source": { "line": 154, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 156, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 177, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 197, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 210, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 216, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 223, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 228, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "exporter", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "exporter(options)", "source": { "line": 233, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the exporter setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "baseName", "parameters": [ { "attributes": "", "default": "", "description": "New base name value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "baseName(value)", "source": { "line": 238, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the base name setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "format", "parameters": [ { "attributes": "", "default": "", "description": "New format value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "format(value)", "source": { "line": 243, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the format setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "preset", "parameters": [ { "attributes": "", "default": "", "description": "New preset value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "preset(value)", "source": { "line": 248, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the preset setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "customSize", "parameters": [ { "attributes": "", "default": "", "description": "New custom size value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "customSize(value)", "source": { "line": 253, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the custom size setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "supersampling", "parameters": [ { "attributes": "", "default": "", "description": "New supersampling value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "supersampling(value)", "source": { "line": 263, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the supersampling setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "includeLabels", "parameters": [ { "attributes": "", "default": "", "description": "New include labels value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "includeLabels(value)", "source": { "line": 268, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the include labels setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "includeLegends", "parameters": [ { "attributes": "", "default": "", "description": "New include legends value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "includeLegends(value)", "source": { "line": 273, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the include legends setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "includeInterface", "parameters": [ { "attributes": "", "default": "", "description": "New include interface value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "includeInterface(value)", "source": { "line": 278, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the include interface setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "legendScale", "parameters": [ { "attributes": "", "default": "", "description": "New legend scale value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "legendScale(value)", "source": { "line": 283, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the legend scale setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "transparentBackground", "parameters": [ { "attributes": "", "default": "", "description": "New transparent background value. Omit this argument to read the current value.", "name": "value", "type": "string|Array" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "transparentBackground(value)", "source": { "line": 288, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the transparent background setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "alphaMode", "parameters": [ { "attributes": "", "default": "", "description": "New alpha mode value. Omit this argument to read the current value.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "alphaMode(value)", "source": { "line": 293, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the alpha mode setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "showFrame", "parameters": [ { "attributes": "", "default": "", "description": "New show frame value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "showFrame(value)", "source": { "line": 298, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the show frame setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getCapabilities", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getCapabilities(options = {})", "source": { "line": 303, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the get capabilities setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getResolvedOptions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getResolvedOptions`.", "name": "overrides", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getResolvedOptions(overrides = {})", "source": { "line": 321, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Returns the current resolved options value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "exportBlob", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async exportBlob(options = {})", "source": { "line": 354, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the export blob setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "exportPreviewBlob", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "previewOptions", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async exportPreviewBlob(options = {}, previewOptions = {})", "source": { "line": 363, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Handles preview blob for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "export", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async export(options = {})", "source": { "line": 372, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Read or set the export setting." } ], "name": "ExporterBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Figure filename, format, preset, custom\ndimensions, supersampling, label/legend/interface inclusion, transparency,\nand frame-preview options.", "name": "options", "type": "Object" } ], "remarks": "The actual capture capability depends on the active renderer and\nshould be checked through `capabilities()` after the renderer is ready.", "returns": { "description": "Behavior that stores export settings and calls\n`helios.exportFigureBlob`, `helios.exportFigurePreviewBlob`, or\n`helios.exportFigure`.", "type": "ExporterBehavior" }, "signature": "export class ExporterBehavior extends Behavior {", "source": { "line": 153, "path": "src/behaviors/ExporterBehavior.js" }, "summary": "Built-in behavior for figure export settings and preview capture." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'filters';", "source": { "line": 51, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 53, "path": "src/behaviors/FilterBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 60, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 75, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 92, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 105, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 161, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 175, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 179, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getModel", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getModel()", "source": { "line": 187, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Returns the current model value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "filters", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "filters(options)", "source": { "line": 191, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Read or set the filters setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setScope", "parameters": [ { "attributes": "", "default": "", "description": "Attribute scope: node, edge, or network.", "name": "scope", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setScope(scope)", "source": { "line": 198, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Set the scope setting." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "replaceRules", "parameters": [ { "attributes": "optional", "default": "", "description": "Replacement filter options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Node rules to apply.", "name": "options.nodeRules", "type": "Array." }, { "attributes": "optional", "default": "", "description": "Edge rules to apply.", "name": "options.edgeRules", "type": "Array." }, { "attributes": "optional", "default": "", "description": "Filter scope.", "name": "options.scope", "type": "'render'|'render+layout'" }, { "attributes": "optional", "default": "[]", "description": "Value passed to `replaceRules`.", "name": "nodeRules", "type": "" }, { "attributes": "optional", "default": "[]", "description": "Value passed to `replaceRules`.", "name": "edgeRules", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Attribute scope: node, edge, or network.", "name": "scope", "type": "" } ], "remarks": "`render+layout` changes the graph view consumed by dynamic\nlayouts. Use `render` when hiding items should not change layout forces.", "returns": { "description": "This behavior instance.", "type": "FilterBehavior" }, "signature": "replaceRules({ nodeRules = [], edgeRules = [], scope } = {})", "source": { "line": 217, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Replace all active node and edge filter rules." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "clear", "parameters": [], "remarks": "", "returns": { "description": "This behavior instance.", "type": "FilterBehavior" }, "signature": "clear()", "source": { "line": 234, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Remove the active graph filter and restore the unfiltered render view." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "setFilterModel", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setFilterModel`.", "name": "model", "type": "" }, { "attributes": "optional", "default": "'model'", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "true } = {}", "description": "Value passed to `setFilterModel`.", "name": "trackOverride", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setFilterModel(model, { reason = 'model', trackOverride = true } = {})", "source": { "line": 255, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Set the filter model setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "syncFromHelios", "parameters": [ { "attributes": "optional", "default": "false", "description": "Value passed to `syncFromHelios`.", "name": "preferActiveModel", "type": "" }, { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `syncFromHelios`.", "name": "silent", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "syncFromHelios({ preferActiveModel = false, silent = false } = {})", "source": { "line": 275, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Configures or reads sync from helios." } ], "name": "FilterBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Filter model or rule options for\nnumeric, categorical, string, and query rules.", "name": "options", "type": "Object|HeliosFilter" } ], "remarks": "`scope: \"render\"` keeps the layout topology intact; `scope:\n\"render+layout\"` rebuilds the active graph view used by both rendering and\ndynamic layouts.", "returns": { "description": "Behavior that applies render-only or\nrender-plus-layout filtered graph views.", "type": "FilterBehavior" }, "signature": "export class FilterBehavior extends Behavior {", "source": { "line": 50, "path": "src/behaviors/FilterBehavior.js" }, "summary": "Built-in behavior for graph filtering." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'hover';", "source": { "line": 35, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 37, "path": "src/behaviors/HoverBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 62, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "detach", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "detach()", "source": { "line": 89, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Manages detach for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 102, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 147, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 166, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 175, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 179, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "ensureStateStyleDefaults", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureStateStyleDefaults()", "source": { "line": 183, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads ensure state style defaults." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "applyHoverLabelConfig", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyHoverLabelConfig()", "source": { "line": 187, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the hover label config state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyHoverConnectedEdges", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyHoverConnectedEdges()", "source": { "line": 191, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the hover connected edges state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyHighlightConnectedEdges", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyHighlightConnectedEdges()", "source": { "line": 195, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the highlight connected edges state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyHoverStylePolicy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyHoverStylePolicy()", "source": { "line": 199, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the hover style policy state on the current instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "applyOtherElementsState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyOtherElementsState()", "source": { "line": 203, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Updates the other elements state state on the current instance." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "syncPicking", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "syncPicking()", "source": { "line": 207, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads sync picking." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "resolveHoverLabelValue", "parameters": [ { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "optional", "default": "this.context?.network ?? null", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveHoverLabelValue(index, network = this.context?.network ?? null)", "source": { "line": 211, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads resolve hover label value." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clearNodeHover", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "clearNodeHover(options = {})", "source": { "line": 215, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Read or set the clear node hover setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clearEdgeHover", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "clearEdgeHover(options = {})", "source": { "line": 223, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Read or set the clear edge hover setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleNodeHover", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleNodeHover`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleNodeHover(event)", "source": { "line": 231, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads handle node hover." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleEdgeHover", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleEdgeHover`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleEdgeHover(event)", "source": { "line": 244, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads handle edge hover." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "handleNetworkReplaced", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleNetworkReplaced()", "source": { "line": 257, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads handle network replaced." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleUiBindingChange", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleUiBindingChange`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleUiBindingChange(event)", "source": { "line": 277, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads handle ui binding change." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleHighlightChange", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleHighlightChange()", "source": { "line": 284, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Configures or reads handle highlight change." } ], "name": "HoverBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Hover options including `nodeHover`,\n`edgeHover`, `hoverLabel`, and connected-edge highlighting.", "name": "options", "type": "Object" } ], "remarks": "Hover requires picking to be available on the active renderer. The\nbehavior coordinates with `LabelsBehavior` when transient hover labels are\nenabled.", "returns": { "description": "Behavior that tracks the current hovered node and\nedge.", "type": "HoverBehavior" }, "signature": "export class HoverBehavior extends Behavior {", "source": { "line": 34, "path": "src/behaviors/HoverBehavior.js" }, "summary": "Built-in behavior for hover picking and hover labels." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'interface';", "source": { "line": 79, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 81, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 95, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 103, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bindUI", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `bindUI`.", "name": "ui", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bindUI(ui = null)", "source": { "line": 127, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads bind ui." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "compactBreakpoint", "parameters": [ { "attributes": "", "default": "", "description": "New compact breakpoint value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "compactBreakpoint(value)", "source": { "line": 133, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the compact breakpoint setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "fullscreenBreakpoint", "parameters": [ { "attributes": "", "default": "", "description": "New fullscreen breakpoint value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "fullscreenBreakpoint(value)", "source": { "line": 139, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the fullscreen breakpoint setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dockSide", "parameters": [ { "attributes": "", "default": "", "description": "New dock side value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dockSide(value)", "source": { "line": 145, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the dock side setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "toggleDockSide", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "toggleDockSide()", "source": { "line": 156, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Updates the dock side state on the current instance." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "mode", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "mode()", "source": { "line": 160, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads mode." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "isCompact", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "isCompact()", "source": { "line": 164, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Returns the current compact value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "isFullscreen", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "isFullscreen()", "source": { "line": 168, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Returns the current fullscreen value or state." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "viewportWidth", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "viewportWidth()", "source": { "line": 172, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads viewport width." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "setViewportWidth", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setViewportWidth`.", "name": "width", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setViewportWidth(width, options = {})", "source": { "line": 176, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Set the viewport width setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "recomputeMode", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "recomputeMode(options = {})", "source": { "line": 221, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the recompute mode setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "controlsOpen", "parameters": [ { "attributes": "", "default": "", "description": "New controls open value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "controlsOpen(value)", "source": { "line": 225, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the controls open setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "openControlsSurface", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "openControlsSurface()", "source": { "line": 240, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads open controls surface." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "closeControlsSurface", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "closeControlsSurface()", "source": { "line": 244, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads close controls surface." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "activateControl", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `activateControl`.", "name": "panelId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "activateControl(panelId)", "source": { "line": 248, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Updates the control state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clearActiveControl", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "clearActiveControl()", "source": { "line": 264, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Updates the active control state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "interfaceVisible", "parameters": [ { "attributes": "", "default": "", "description": "New interface visible value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "interfaceVisible(value)", "source": { "line": 276, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the interface visible setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 286, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 301, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "serializeInterfaceState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serializeInterfaceState(options = {})", "source": { "line": 316, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the serialize interface state setting." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "restoreInterfaceState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restoreInterfaceState`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restoreInterfaceState(snapshot = {}, options = {})", "source": { "line": 329, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Updates the interface state state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensurePersistenceReady", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async ensurePersistenceReady()", "source": { "line": 352, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads ensure persistence ready." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "persistResponsivePreferences", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async persistResponsivePreferences(options = {})", "source": { "line": 398, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the persist responsive preferences setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resumePrompt", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resumePrompt()", "source": { "line": 418, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads resume prompt." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resumeSession", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async resumeSession(options = {})", "source": { "line": 422, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the resume session setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "startFresh", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async startFresh(options = {})", "source": { "line": 442, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Read or set the start fresh setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dismissResumePrompt", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dismissResumePrompt()", "source": { "line": 465, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads dismiss resume prompt." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 492, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Configures or reads emit change." } ], "name": "InterfaceBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Compact/fullscreen breakpoints, preferred dock\nside, and restore-prompt behavior.", "name": "options", "type": "Object" } ], "remarks": "Helios Web can render without `HeliosUI`; this behavior stores the\nserializable interface state that an app shell or UI layer can bind to.", "returns": { "description": "Behavior that tracks dock side, viewport class,\nactive panels, controls visibility, and resume-session prompts.", "type": "InterfaceBehavior" }, "signature": "export class InterfaceBehavior extends Behavior {", "source": { "line": 78, "path": "src/behaviors/InterfaceBehavior.js" }, "summary": "Built-in behavior for responsive interface and touch-oriented app state." }, { "category": "Behaviors", "examples": [ "helios.behavior.labels.update({\n enabled: true,\n source: 'label',\n selectionMode: 'ranked',\n maxVisible: 80,\n});" ], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'labels';", "source": { "line": 109, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 111, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 123, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `update`.", "name": "changeOptions", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {}, changeOptions = {})", "source": { "line": 135, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads update." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 153, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 159, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 344, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 351, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 360, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "labels", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "labels(options)", "source": { "line": 364, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the labels setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "enabled", "parameters": [ { "attributes": "", "default": "", "description": "New enabled value. Omit this argument to read the current value.", "name": "value", "type": "boolean" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "enabled(value, options = {})", "source": { "line": 380, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads enabled." }, { "category": "Camera And View", "examples": [], "kind": "method", "methods": [], "name": "mode", "parameters": [ { "attributes": "", "default": "", "description": "New mode value. Omit this argument to read the current value.", "name": "value", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "mode(value, options = {})", "source": { "line": 385, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Configures or reads mode." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "selectedOnlySpaceAware", "parameters": [ { "attributes": "", "default": "", "description": "New selected only space aware value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "selectedOnlySpaceAware(value)", "source": { "line": 398, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the selected only space aware setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "maxVisible", "parameters": [ { "attributes": "", "default": "", "description": "New max visible value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "maxVisible(value)", "source": { "line": 403, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the max visible setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "fontSizeScale", "parameters": [ { "attributes": "", "default": "", "description": "New font size scale value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "fontSizeScale(value)", "source": { "line": 408, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the font size scale setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "minScreenRadius", "parameters": [ { "attributes": "", "default": "", "description": "New min screen radius value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "minScreenRadius(value)", "source": { "line": 415, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the min screen radius setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "outlineWidth", "parameters": [ { "attributes": "", "default": "", "description": "New outline width value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "outlineWidth(value)", "source": { "line": 422, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the outline width setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "offsetRadiusFactor", "parameters": [ { "attributes": "", "default": "", "description": "New offset radius factor value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "offsetRadiusFactor(value)", "source": { "line": 429, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the offset radius factor setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "offsetPx", "parameters": [ { "attributes": "", "default": "", "description": "New offset px value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "offsetPx(value)", "source": { "line": 436, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the offset px setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "maxChars", "parameters": [ { "attributes": "", "default": "", "description": "New max chars value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "maxChars(value)", "source": { "line": 443, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the max chars setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "maxRows", "parameters": [ { "attributes": "", "default": "", "description": "New max rows value. Omit this argument to read the current value.", "name": "value", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "maxRows(value)", "source": { "line": 450, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the max rows setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "fill", "parameters": [ { "attributes": "", "default": "", "description": "New fill value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "fill(value)", "source": { "line": 457, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the fill setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "outlineColor", "parameters": [ { "attributes": "", "default": "", "description": "New outline color value. Omit this argument to read the current value.", "name": "value", "type": "string|Array" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "outlineColor(value)", "source": { "line": 462, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the outline color setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "fontFamily", "parameters": [ { "attributes": "", "default": "", "description": "New font family value. Omit this argument to read the current value.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "fontFamily(value)", "source": { "line": 467, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the font family setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "source", "parameters": [ { "attributes": "", "default": "", "description": "New source value. Omit this argument to read the current value.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "source(value)", "source": { "line": 472, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the source setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applySelectionDefaults", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applySelectionDefaults()", "source": { "line": 479, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Updates the selection defaults state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setHoverPolicy", "parameters": [ { "attributes": "optional", "default": "false", "description": "Value passed to `setHoverPolicy`.", "name": "enabled", "type": "" }, { "attributes": "optional", "default": "null } = {}", "description": "Network or input source used by the operation.", "name": "source", "type": "Blob|ArrayBuffer|string|File" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setHoverPolicy({ enabled = false, source = null } = {})", "source": { "line": 487, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Set the hover policy setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clearHoverPolicy", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "clearHoverPolicy(options = {})", "source": { "line": 497, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Read or set the clear hover policy setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyConfig", "parameters": [ { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `applyConfig`.", "name": "silent", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyConfig({ silent = false } = {})", "source": { "line": 504, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Updates the config state on the current instance." } ], "name": "LabelsBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Label options including `enabled`, `source`,\n`selectionMode`, `maxVisible`, collision settings, font settings, and export\ncompatibility flags.", "name": "options", "type": "Object" } ], "remarks": "Labels can be driven by a node attribute, callback, selection state,\nhover state, and screen-space collision/ranking limits.", "returns": { "description": "Behavior controlling the live label overlay.", "type": "LabelsBehavior" }, "signature": "export class LabelsBehavior extends Behavior {", "source": { "line": 108, "path": "src/behaviors/LabelsBehavior.js" }, "summary": "Built-in behavior for SVG label overlays." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'layout';", "source": { "line": 298, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 300, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 308, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 322, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 345, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 356, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "refreshParameterStateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "refreshParameterStateEntries()", "source": { "line": 433, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads refresh parameter state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 443, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 460, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 465, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "descriptor", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "descriptor()", "source": { "line": 484, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads descriptor." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "choices", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "choices()", "source": { "line": 488, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads choices." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bindings()", "source": { "line": 492, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads bindings." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "runState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "runState()", "source": { "line": 496, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads run state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "isDynamic", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "isDynamic()", "source": { "line": 500, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Returns the current dynamic value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "type", "parameters": [ { "attributes": "", "default": "", "description": "New type value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "type(value, options = {})", "source": { "line": 504, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads type." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "parameter", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `parameter`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "New parameter value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "parameter(key, value, options = {})", "source": { "line": 525, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads parameter." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "parameters", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `parameters`.", "name": "patch", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "parameters(patch = {}, options = {})", "source": { "line": 542, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads parameters." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "positionAttribute", "parameters": [ { "attributes": "", "default": "", "description": "New position attribute value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "positionAttribute(value, options = {})", "source": { "line": 557, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads position attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "positionAttributeChoices", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "positionAttributeChoices()", "source": { "line": 567, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads position attribute choices." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "applyPositionAttribute", "parameters": [ { "attributes": "optional", "default": "this.state.positionAttribute", "description": "New apply position attribute value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyPositionAttribute(value = this.state.positionAttribute, options = {})", "source": { "line": 574, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Updates the position attribute state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "start", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "start()", "source": { "line": 594, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads start." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stop", "parameters": [ { "attributes": "optional", "default": "'behavior:layout'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stop(reason = 'behavior:layout')", "source": { "line": 601, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads stop." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "reheat", "parameters": [ { "attributes": "optional", "default": "'behavior:layout'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reheat(reason = 'behavior:layout')", "source": { "line": 607, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Configures or reads reheat." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "reset", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reset(options = {})", "source": { "line": 618, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Read or set the reset setting." } ], "name": "LayoutBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Layout options such as `layoutType`,\n`positionAttribute`, low-level `parameters`, and `running` state.", "name": "options", "type": "Object" } ], "remarks": "Use this behavior when UI or persistence needs to switch layouts,\ncopy numeric position attributes into current positions, or start/stop a\ndynamic layout without replacing the Helios instance.", "returns": { "description": "Behavior wrapping static, worker, D3 force, and\nGPU force layouts.", "type": "LayoutBehavior" }, "signature": "export class LayoutBehavior extends Behavior {", "source": { "line": 297, "path": "src/behaviors/LayoutBehavior.js" }, "summary": "Built-in behavior for choosing and controlling the active layout." }, { "category": "Behaviors", "examples": [], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'legends';", "source": { "line": 110, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 112, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 122, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `update`.", "name": "changeOptions", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {}, changeOptions = {})", "source": { "line": 144, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Configures or reads update." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 166, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 172, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 262, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 269, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 273, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "legends", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "legends(options)", "source": { "line": 277, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Read or set the legends setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "enabled", "parameters": [ { "attributes": "", "default": "", "description": "New enabled value. Omit this argument to read the current value.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "enabled(value)", "source": { "line": 283, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Read or set the enabled setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "titles", "parameters": [ { "attributes": "", "default": "", "description": "New titles value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "titles(value)", "source": { "line": 288, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Read or set the titles setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "placements", "parameters": [ { "attributes": "", "default": "", "description": "New placements value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "placements(value)", "source": { "line": 293, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Read or set the placements setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "getLegendItems", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getLegendItems(options = {})", "source": { "line": 298, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Read or set the get legend items setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyConfig", "parameters": [ { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `applyConfig`.", "name": "silent", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyConfig({ silent = false } = {})", "source": { "line": 312, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Updates the config state on the current instance." } ], "name": "LegendsBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Legend visibility, placement, typography, scale,\ntitle, and export compatibility options.", "name": "options", "type": "Object" } ], "remarks": "Legends read mapper and density configuration from the live Helios\ninstance and preserve serializable placement, title, and visibility state.", "returns": { "description": "Behavior controlling SVG legends for mapper and\ndensity channels.", "type": "LegendsBehavior" }, "signature": "export class LegendsBehavior extends Behavior {", "source": { "line": 109, "path": "src/behaviors/LegendsBehavior.js" }, "summary": "Built-in behavior for legend overlays." }, { "category": "Behaviors", "examples": [ "helios.behavior.mappers.setChannelConfig('node', 'color', {\n type: 'colormap',\n attributes: 'score',\n colormap: 'interpolateViridis',\n domain: [0, 1],\n});" ], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'mappers';", "source": { "line": 91, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 93, "path": "src/behaviors/MappersBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 99, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 117, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 127, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 133, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 194, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 203, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 207, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "mappers", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "mappers(options)", "source": { "line": 211, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Read or set the mappers setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getChannelConfig", "parameters": [ { "attributes": "", "default": "", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "", "default": "", "description": "Channel for this operation.", "name": "channel", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getChannelConfig(mode, channel)", "source": { "line": 216, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Returns the current channel config value or state." }, { "category": "Mapper Configuration", "examples": [], "kind": "method", "methods": [], "name": "getSerializedChannelConfig", "parameters": [ { "attributes": "", "default": "", "description": "Mapper collection to inspect.", "name": "mode", "type": "'node'|'edge'" }, { "attributes": "", "default": "", "description": "Visual channel name such as `color`, `size`,\n`opacity`, `outline`, or `width`.", "name": "channel", "type": "string" } ], "remarks": "", "returns": { "description": "JSON-safe channel configuration, or `null` when\nthe channel is not registered.", "type": "Object|null" }, "signature": "getSerializedChannelConfig(mode, channel)", "source": { "line": 234, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Return a serializable snapshot for one visual channel." }, { "category": "Mapper Configuration", "examples": [ "helios.behavior.mappers.setChannelConfig('node', 'color', {\n type: 'colormap',\n attributes: 'score',\n colormap: 'interpolateViridis',\n domain: [0, 1],\n});" ], "kind": "method", "methods": [], "name": "setChannelConfig", "parameters": [ { "attributes": "", "default": "", "description": "Mapper collection to update.", "name": "mode", "type": "'node'|'edge'" }, { "attributes": "", "default": "", "description": "Visual channel name.", "name": "channel", "type": "string" }, { "attributes": "", "default": "", "description": "Serializable channel configuration.", "name": "config", "type": "Object" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "This mutates the active default mapper and emits a mapper change\nevent. Persisted configurations should avoid functions.", "returns": { "description": "`true` when the channel was applied.", "type": "boolean" }, "signature": "setChannelConfig(mode, channel, config, options = {})", "source": { "line": 257, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Replace the default mapper configuration for one visual channel." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "replaceDefaultChannels", "parameters": [ { "attributes": "", "default": "", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `replaceDefaultChannels`.", "name": "channels", "type": "" }, { "attributes": "optional", "default": "'channels'", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "true } = {}", "description": "Value passed to `replaceDefaultChannels`.", "name": "trackOverride", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "replaceDefaultChannels(mode, channels = {}, { reason = 'channels', trackOverride = true } = {})", "source": { "line": 278, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Updates the default channels state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setModeSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "", "default": "", "description": "Value passed to `setModeSnapshot`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "'mode'", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "true } = {}", "description": "Value passed to `setModeSnapshot`.", "name": "trackOverride", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setModeSnapshot(mode, snapshot, { reason = 'mode', trackOverride = true } = {})", "source": { "line": 300, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Set the mode snapshot setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "syncFromHelios", "parameters": [ { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `syncFromHelios`.", "name": "silent", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "syncFromHelios({ silent = false } = {})", "source": { "line": 314, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Configures or reads sync from helios." } ], "name": "MappersBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Serializable node/edge mapper snapshots or\nchannel configurations for color, size, opacity, outline, and edge width.", "name": "options", "type": "Object" } ], "remarks": "Mapper channel configs should avoid functions when they need to be\npersisted. Use serializable `constant`, `linear`, `categorical`,\n`colormap`, `nodeToEdge`, and `passthrough` configurations.", "returns": { "description": "Behavior that applies and serializes mapper\nchannel state.", "type": "MappersBehavior" }, "signature": "export class MappersBehavior extends Behavior {", "source": { "line": 90, "path": "src/behaviors/MappersBehavior.js" }, "summary": "Built-in behavior for node and edge visual mappers." }, { "category": "Behaviors", "examples": [ "helios.behavior.selection.selectNodes([0, 2, 4], { mode: 'replace' });" ], "kind": "class", "methods": [ { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "id", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "static id = 'selection';", "source": { "line": 109, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Id exposed by the class." }, { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 111, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "" }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attach", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `attach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attach(context)", "source": { "line": 136, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "detach", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "detach()", "source": { "line": 153, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Manages detach for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "update", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "update(options = {})", "source": { "line": 163, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Read or set the update setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 196, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stateEntries", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stateEntries()", "source": { "line": 215, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads state entries." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {})", "source": { "line": 357, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitChange", "parameters": [ { "attributes": "", "default": "", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Event payload passed to listeners.", "name": "detail", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitChange(reason, detail = {})", "source": { "line": 371, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads emit change." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "getPublicState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPublicState()", "source": { "line": 375, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Returns the current public state value or state." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "ensureStateStyleDefaults", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureStateStyleDefaults()", "source": { "line": 383, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads ensure state style defaults." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "applyOtherElementsState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyOtherElementsState()", "source": { "line": 387, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the other elements state state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applySelectedConnectedEdges", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applySelectedConnectedEdges()", "source": { "line": 391, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the selected connected edges state on the current instance." }, { "category": "Rendering And Picking", "examples": [], "kind": "method", "methods": [], "name": "syncPicking", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "syncPicking()", "source": { "line": 395, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads sync picking." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSelectionBinding", "parameters": [ { "attributes": "optional", "default": "CURRENT_SELECTION_VALUE", "description": "New set selection binding value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setSelectionBinding(value = CURRENT_SELECTION_VALUE)", "source": { "line": 399, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Read or set the set selection binding setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSelectorRules", "parameters": [ { "attributes": "optional", "default": "[]", "description": "Value passed to `setSelectorRules`.", "name": "rules", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setSelectorRules(rules = [], options = {})", "source": { "line": 407, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Set the selector rules setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "applySelectionLabelDefaults", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applySelectionLabelDefaults()", "source": { "line": 416, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the selection label defaults state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setNodeSelected", "parameters": [ { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "", "default": "", "description": "Value passed to `setNodeSelected`.", "name": "selected", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setNodeSelected(index, selected, options = {})", "source": { "line": 431, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Set the node selected setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setEdgeSelected", "parameters": [ { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "", "default": "", "description": "Value passed to `setEdgeSelected`.", "name": "selected", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setEdgeSelected(index, selected, options = {})", "source": { "line": 453, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Set the edge selected setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clearSelection", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "clearSelection(options = {})", "source": { "line": 472, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Read or set the clear selection setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "selectOnly", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `selectOnly`.", "name": "kind", "type": "" }, { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "selectOnly(kind, index, options = {})", "source": { "line": 494, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads select only." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "toggleSelection", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `toggleSelection`.", "name": "kind", "type": "" }, { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "toggleSelection(kind, index, options = {})", "source": { "line": 507, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the selection state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyNodeSelectionSet", "parameters": [ { "attributes": "", "default": "", "description": "Node or edge indices used by the operation.", "name": "indices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "'add'", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyNodeSelectionSet(indices, mode = 'add', options = {})", "source": { "line": 512, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the node selection set state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyEdgeSelectionSet", "parameters": [ { "attributes": "", "default": "", "description": "Node or edge indices used by the operation.", "name": "indices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "'add'", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyEdgeSelectionSet(indices, mode = 'add', options = {})", "source": { "line": 550, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the edge selection set state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "selectNodes", "parameters": [ { "attributes": "", "default": "", "description": "Node or edge indices used by the operation.", "name": "indices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "selectNodes(indices, options = {})", "source": { "line": 588, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads select nodes." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "selectEdges", "parameters": [ { "attributes": "", "default": "", "description": "Node or edge indices used by the operation.", "name": "indices", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "selectEdges(indices, options = {})", "source": { "line": 592, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads select edges." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildNodeSelectionQuery", "parameters": [ { "attributes": "optional", "default": "[]", "description": "Value passed to `buildNodeSelectionQuery`.", "name": "rules", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildNodeSelectionQuery(rules = [])", "source": { "line": 596, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads build node selection query." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyNodeSelectionQuery", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `applyNodeSelectionQuery`.", "name": "rules", "type": "" }, { "attributes": "optional", "default": "'add'", "description": "Mode for this operation.", "name": "mode", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyNodeSelectionQuery(rules, mode = 'add')", "source": { "line": 605, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the node selection query state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "expandSelectionToNeighbors", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "expandSelectionToNeighbors()", "source": { "line": 613, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads expand selection to neighbors." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "centerSelectedNodesOrNetwork", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "centerSelectedNodesOrNetwork(options = {})", "source": { "line": 623, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Read or set the center selected nodes or network setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "collectSavedSelectionAttributes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "collectSavedSelectionAttributes()", "source": { "line": 646, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads collect saved selection attributes." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureBooleanSelectionAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Attribute scope: node, edge, or network.", "name": "scope", "type": "" }, { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureBooleanSelectionAttribute(network, scope, name)", "source": { "line": 662, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads ensure boolean selection attribute." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "saveSelectionToAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "saveSelectionToAttribute(name)", "source": { "line": 682, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Handles selection to attribute for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "collectSelectionAttributeIndices", "parameters": [ { "attributes": "", "default": "", "description": "Attribute scope: node, edge, or network.", "name": "scope", "type": "" }, { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "collectSelectionAttributeIndices(scope, name)", "source": { "line": 705, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads collect selection attribute indices." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreSelectionFromAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restoreSelectionFromAttribute(name)", "source": { "line": 732, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Updates the selection from attribute state on the current instance." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attachNetworkAttributeListeners", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "attachNetworkAttributeListeners()", "source": { "line": 743, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads attach network attribute listeners." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleGraphClick", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleGraphClick`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleGraphClick(event)", "source": { "line": 759, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads handle graph click." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleGraphDoubleClick", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleGraphDoubleClick`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleGraphDoubleClick(event)", "source": { "line": 780, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads handle graph double click." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "handleNetworkReplaced", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleNetworkReplaced()", "source": { "line": 795, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads handle network replaced." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleUiBindingChange", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleUiBindingChange`.", "name": "event", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleUiBindingChange(event)", "source": { "line": 808, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Configures or reads handle ui binding change." } ], "name": "SelectionBehavior", "parameters": [ { "attributes": "optional", "default": "", "description": "Selection options such as `nodeClick`,\n`edgeClick`, `selectedConnectedEdges`, saved-selection attribute names, and\ninactive-item styling.", "name": "options", "type": "Object" } ], "remarks": "Selection state is serializable. The behavior also synchronizes\npicking, labels, and optional connected-edge highlighting.", "returns": { "description": "Behavior that can be attached through\n`helios.useBehavior('selection', options)`.", "type": "SelectionBehavior" }, "signature": "export class SelectionBehavior extends Behavior {", "source": { "line": 108, "path": "src/behaviors/SelectionBehavior.js" }, "summary": "Built-in behavior for node and edge selection state." }, { "category": "Behaviors", "examples": [], "kind": "symbol", "methods": [], "name": "BEHAVIOR_IDS", "parameters": [], "remarks": "The order matches `createDefaultBehaviorRegistry()` registration and\nis stable for UI/persistence code that needs to list built-ins.", "returns": { "description": "", "type": "" }, "signature": "export const BEHAVIOR_IDS = Object.freeze([", "source": { "line": 22, "path": "src/behaviors/index.js" }, "summary": "Ordered ids for the built-in behavior set." }, { "category": "Behaviors", "examples": [ "const registry = createDefaultBehaviorRegistry()\n .register('custom', CustomBehavior);" ], "kind": "function", "methods": [], "name": "createDefaultBehaviorRegistry", "parameters": [], "remarks": "", "returns": { "description": "Registry preloaded with appearance, exporter,\nmappers, filters, interface, layout, legends, labels, hover, and selection.", "type": "BehaviorRegistry" }, "signature": "export function createDefaultBehaviorRegistry() {", "source": { "line": 45, "path": "src/behaviors/index.js" }, "summary": "Create a registry containing all built-in Helios Web behaviors." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "base64ToUint8Array", "parameters": [ { "attributes": "", "default": "", "description": "Base64-encoded byte payload.", "name": "b64", "type": "string" } ], "remarks": "", "returns": { "description": "Decoded bytes.", "type": "Uint8Array" }, "signature": "export function base64ToUint8Array(b64) {", "source": { "line": 38, "path": "src/colors/colormaps.js" }, "summary": "Decode base64-encoded binary colormap data." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "decodeColormapData", "parameters": [ { "attributes": "", "default": "", "description": "Base64-encoded RGB byte payload.", "name": "b64", "type": "string" }, { "attributes": "optional", "default": "", "description": "Expected number of colors.", "name": "expectedN", "type": "number" } ], "remarks": "", "returns": { "description": "RGB colors in byte space.", "type": "Array>" }, "signature": "export function decodeColormapData(b64, expectedN) {", "source": { "line": 54, "path": "src/colors/colormaps.js" }, "summary": "Decode packed RGB colormap bytes into color tuples." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "colormaps", "parameters": [], "remarks": "", "returns": { "description": "D3, CET, cmasher, and Helios colormap collections.", "type": "Object" }, "signature": "export const colormaps = {", "source": { "line": 372, "path": "src/colors/colormaps.js" }, "summary": "Built-in color map registry grouped by source collection." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "DEFAULT_NODE_COLORMAP", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const DEFAULT_NODE_COLORMAP = 'CET_L08-NeonBurst';", "source": { "line": 385, "path": "src/colors/colormaps.js" }, "summary": "Default node colormap used by Helios when no explicit node color mapper is set." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "colormapToInterpolator", "parameters": [ { "attributes": "", "default": "", "description": "Colormap reference.", "name": "input", "type": "string|Function|Object" } ], "remarks": "", "returns": { "description": "Function that maps `0..1` values to colors.", "type": "Function|null" }, "signature": "export function colormapToInterpolator(input) {", "source": { "line": 449, "path": "src/colors/colormaps.js" }, "summary": "Resolve a colormap to an interpolation function." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "colormapToScheme", "parameters": [ { "attributes": "", "default": "", "description": "Colormap reference.", "name": "input", "type": "string|Function|Object" }, { "attributes": "", "default": "", "description": "Number of colors to sample.", "name": "count", "type": "number" } ], "remarks": "", "returns": { "description": "Sampled RGBA colors.", "type": "Array>|null" }, "signature": "export function colormapToScheme(input, count) {", "source": { "line": 464, "path": "src/colors/colormaps.js" }, "summary": "Resolve a colormap to a discrete color scheme." }, { "category": "Internal", "examples": [ "const color = createColormapScale('interpolateViridis', { domain: [0, 1] });" ], "kind": "function", "methods": [], "name": "createColormapScale", "parameters": [ { "attributes": "", "default": "", "description": "Colormap reference.", "name": "colormapInput", "type": "string|Function|Object" }, { "attributes": "optional", "default": "", "description": "Scale options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Numeric input domain.", "name": "options.domain", "type": "Array" }, { "attributes": "optional", "default": "", "description": "Output alpha override.", "name": "options.alpha", "type": "number" } ], "remarks": "", "returns": { "description": "Function that maps values to RGBA colors.", "type": "Function" }, "signature": "export function createColormapScale(colormapInput, options = {}) {", "source": { "line": 483, "path": "src/colors/colormaps.js" }, "summary": "Create a numeric colormap scale." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "createCategoricalColormap", "parameters": [ { "attributes": "", "default": "", "description": "Colormap reference.", "name": "colormapInput", "type": "string|Function|Object" }, { "attributes": "", "default": "", "description": "Number of categories.", "name": "count", "type": "number" } ], "remarks": "", "returns": { "description": "RGBA colors for categories.", "type": "Array>" }, "signature": "export function createCategoricalColormap(colormapInput, count) {", "source": { "line": 529, "path": "src/colors/colormaps.js" }, "summary": "Create a categorical palette from a colormap." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 4709, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "didDetach", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "didDetach()", "source": { "line": 4756, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads did detach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "updateOptions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `updateOptions`.", "name": "next", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "updateOptions(next = {})", "source": { "line": 4760, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads update options." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dispose", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dispose()", "source": { "line": 4815, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads dispose." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "resetDynamicStateFromNetwork", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `resetDynamicStateFromNetwork`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resetDynamicStateFromNetwork(context = {})", "source": { "line": 4840, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Updates the dynamic state from network state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "resetAnnealing", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resetAnnealing()", "source": { "line": 4849, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Updates the annealing state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getCompletedEpochs", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getCompletedEpochs()", "source": { "line": 4860, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Returns the current completed epochs value or state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "captureNetworkVersionSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "captureNetworkVersionSnapshot(network)", "source": { "line": 4899, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads capture network version snapshot." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "synchronizeTopology", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `synchronizeTopology`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "synchronizeTopology(context = {})", "source": { "line": 4963, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads synchronize topology." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "step", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `step`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "step(context = {})", "source": { "line": 5095, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads step." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getNodePositionView", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getNodePositionView`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getNodePositionView(context = {})", "source": { "line": 5305, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Returns the current node position view value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getWebGPUPositionBuffer", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getWebGPUPositionBuffer`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getWebGPUPositionBuffer(context = {})", "source": { "line": 5318, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Returns the current web gpuposition buffer value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getWebGLPositionTexture", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getWebGLPositionTexture`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getWebGLPositionTexture(context = {})", "source": { "line": 5330, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Returns the current web glposition texture value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getGpuPositionResource", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getGpuPositionResource`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getGpuPositionResource(context = {})", "source": { "line": 5343, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Returns the current gpu position resource value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodePositions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `snapshotNodePositions`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async snapshotNodePositions(context = {})", "source": { "line": 5356, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads snapshot node positions." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodePositionsById", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `snapshotNodePositionsById`.", "name": "context", "type": "" }, { "attributes": "optional", "default": "[]", "description": "Node or edge identifiers/indices used by the operation.", "name": "nodeIds", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async snapshotNodePositionsById(context = {}, nodeIds = [], options = {})", "source": { "line": 5370, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads snapshot node positions by id." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "snapshotNodeCentroidById", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `snapshotNodeCentroidById`.", "name": "context", "type": "" }, { "attributes": "optional", "default": "[]", "description": "Node or edge identifiers/indices used by the operation.", "name": "nodeIds", "type": "Array|TypedArray" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async snapshotNodeCentroidById(context = {}, nodeIds = [], options = {})", "source": { "line": 5393, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads snapshot node centroid by id." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "writePositionSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `writePositionSnapshot`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "writePositionSnapshot(snapshot, options = {})", "source": { "line": 5430, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads write position snapshot." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "synchronizeNodePositionsToNetwork", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `synchronizeNodePositionsToNetwork`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async synchronizeNodePositionsToNetwork(context = {})", "source": { "line": 5446, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads synchronize node positions to network." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "flattenNodeDepthToPlane", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `flattenNodeDepthToPlane`.", "name": "context", "type": "" }, { "attributes": "optional", "default": "0", "description": "Value passed to `flattenNodeDepthToPlane`.", "name": "zValue", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async flattenNodeDepthToPlane(context = {}, zValue = 0)", "source": { "line": 5471, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads flatten node depth to plane." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "injectPlanarDepthJitter", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `injectPlanarDepthJitter`.", "name": "context", "type": "" }, { "attributes": "optional", "default": "0", "description": "Value passed to `injectPlanarDepthJitter`.", "name": "amplitude", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async injectPlanarDepthJitter(context = {}, amplitude = 0)", "source": { "line": 5512, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Configures or reads inject planar depth jitter." } ], "name": "GpuForcePositionDelegate", "parameters": [ { "attributes": "optional", "default": "", "description": "GPU force layout delegate options and resource\nhandles.", "name": "options", "type": "Object" } ], "remarks": "This is a low-level extension point. Most applications configure it\nindirectly through `GpuForceLayout` or `LayoutBehavior`.", "returns": { "description": "Delegate that synchronizes graph topology\nto GPU buffers and exposes position snapshots to Helios renderers.", "type": "GpuForcePositionDelegate" }, "signature": "export class GpuForcePositionDelegate extends PositionDelegate {", "source": { "line": 4708, "path": "src/delegates/GpuForcePositionDelegate.js" }, "summary": "Position delegate used by GPU force layouts." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor()", "source": { "line": 35, "path": "src/delegates/PositionDelegate.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "onAttach", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `onAttach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "onAttach(context = {})", "source": { "line": 67, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads on attach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "onDetach", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `onDetach`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "onDetach(context = {})", "source": { "line": 79, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads on detach." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "markTopologyDirty", "parameters": [ { "attributes": "optional", "default": "'manual'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "markTopologyDirty(reason = 'manual')", "source": { "line": 92, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads mark topology dirty." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bumpVersion", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bumpVersion()", "source": { "line": 97, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads bump version." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getVersion", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getVersion`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getVersion(context = {})", "source": { "line": 102, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current version value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getNodePositionView", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getNodePositionView`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getNodePositionView(context = {})", "source": { "line": 107, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current node position view value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getPositionView", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getPositionView`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPositionView(context = {})", "source": { "line": 112, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current position view value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getWebGPUPositionBuffer", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getWebGPUPositionBuffer`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getWebGPUPositionBuffer(context = {})", "source": { "line": 116, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current web gpuposition buffer value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getWebGLPositionTexture", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getWebGLPositionTexture`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getWebGLPositionTexture(context = {})", "source": { "line": 121, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current web glposition texture value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getGpuPositionResource", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getGpuPositionResource`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getGpuPositionResource(context = {})", "source": { "line": 126, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current gpu position resource value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getPositionResource", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `getPositionResource`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPositionResource(context = {})", "source": { "line": 131, "path": "src/delegates/PositionDelegate.js" }, "summary": "Returns the current position resource value or state." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "flattenNodeDepthToPlane", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `flattenNodeDepthToPlane`.", "name": "context", "type": "" }, { "attributes": "optional", "default": "0", "description": "Value passed to `flattenNodeDepthToPlane`.", "name": "zValue", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async flattenNodeDepthToPlane(context = {}, zValue = 0)", "source": { "line": 135, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads flatten node depth to plane." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureSynchronized", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `ensureSynchronized`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureSynchronized(context = {})", "source": { "line": 141, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads ensure synchronized." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "captureNetworkVersionSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "captureNetworkVersionSnapshot(network)", "source": { "line": 183, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads capture network version snapshot." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "synchronizeTopology", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "synchronizeTopology()", "source": { "line": 202, "path": "src/delegates/PositionDelegate.js" }, "summary": "Configures or reads synchronize topology." } ], "name": "PositionDelegate", "parameters": [], "remarks": "Use position delegates when layout state lives in GPU buffers or\nanother external system. Subclasses must implement synchronization hooks and\nbump `version` whenever positions change.", "returns": { "description": "Subclasses provide synchronized topology and\nposition snapshots for renderers.", "type": "PositionDelegate" }, "signature": "export class PositionDelegate {", "source": { "line": 34, "path": "src/delegates/PositionDelegate.js" }, "summary": "Abstract source for layout positions owned outside the network buffers." }, { "category": "Constants", "examples": [], "kind": "symbol", "methods": [], "name": "FIGURE_EXPORT_PRESETS", "parameters": [], "remarks": "Presets include current-window sizes, common video/print raster\nsizes, and a custom target. Availability still depends on renderer texture\nlimits and requested supersampling.", "returns": { "description": "", "type": "" }, "signature": "export const FIGURE_EXPORT_PRESETS = Object.freeze([", "source": { "line": 9, "path": "src/export/figureExport.js" }, "summary": "Built-in figure size presets for Helios exports." }, { "category": "Export", "examples": [], "kind": "function", "methods": [], "name": "getFigureExportCapability", "parameters": [ { "attributes": "", "default": "", "description": "Active Helios renderer.", "name": "renderer", "type": "Object" }, { "attributes": "optional", "default": "1", "description": "Requested supersampling factor.", "name": "supersampling", "type": "number|string" } ], "remarks": "", "returns": { "description": "Export capability for the current WebGL/WebGPU device.", "type": "{supersampling:number,maxBitmapDimension:number,maxFigureDimension:number}" }, "signature": "export function getFigureExportCapability(renderer, supersampling = 1) {", "source": { "line": 180, "path": "src/export/figureExport.js" }, "summary": "Resolve renderer limits that constrain figure export dimensions." }, { "category": "Export", "examples": [], "kind": "function", "methods": [], "name": "resolveFigureExportOptions", "parameters": [ { "attributes": "optional", "default": "", "description": "Requested filename, format, preset, width,\nheight, supersampling, overlay inclusion, transparency, and legend scale.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Renderer, viewport, device pixel ratio, and\ncapability context.", "name": "context", "type": "Object" } ], "remarks": "Callers should check `fitsCapability` before allocating render\ntargets for the result.", "returns": { "description": "Resolved export options including logical dimensions,\nbitmap dimensions, crop rectangle, filename, and capability fit status.", "type": "Object" }, "signature": "export function resolveFigureExportOptions(options = {}, context = {}) {", "source": { "line": 213, "path": "src/export/figureExport.js" }, "summary": "Normalize figure export options into concrete dimensions and capture flags." }, { "category": "Export", "examples": [], "kind": "function", "methods": [], "name": "buildFigureExportPresetList", "parameters": [ { "attributes": "optional", "default": "", "description": "Current logical viewport size.", "name": "windowSize", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Result of `getFigureExportCapability`.", "name": "capability", "type": "Object" }, { "attributes": "optional", "default": "1", "description": "Requested supersampling factor.", "name": "supersampling", "type": "number|string" } ], "remarks": "", "returns": { "description": "Preset records with dimensions and availability.", "type": "Array." }, "signature": "export function buildFigureExportPresetList(windowSize = {}, capability = { maxBitmapDimension: Infinity }, supersampling = 1) {", "source": { "line": 335, "path": "src/export/figureExport.js" }, "summary": "Build export preset metadata for a viewport and renderer capability." }, { "category": "Filters", "examples": [ "const filter = new HeliosFilter({ scope: 'render' })\n .addRule({ type: 'numeric', scope: 'node', attribute: 'score', min: 0.5, max: 1 });" ], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "", "description": "Filter options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Stable filter id.", "name": "options.id", "type": "string" }, { "attributes": "optional", "default": "", "description": "Human-readable filter name.", "name": "options.name", "type": "string" }, { "attributes": "optional", "default": "'render'", "description": "Whether the filter affects rendering only or rendering plus layout.", "name": "options.scope", "type": "'render'|'render+layout'" }, { "attributes": "optional", "default": "", "description": "Initial rule descriptors.", "name": "options.rules", "type": "Array." } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 237, "path": "src/filters/HeliosFilter.js" }, "summary": "Create a filter model from an id, graph scope, and initial rules." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "clone", "parameters": [], "remarks": "", "returns": { "description": "Independent filter with copied rule descriptors.", "type": "HeliosFilter" }, "signature": "clone()", "source": { "line": 255, "path": "src/filters/HeliosFilter.js" }, "summary": "Return a deep copy of this filter model." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setScope", "parameters": [ { "attributes": "", "default": "", "description": "Graph filter scope.", "name": "scope", "type": "'render'|'render+layout'" } ], "remarks": "", "returns": { "description": "This filter.", "type": "HeliosFilter" }, "signature": "setScope(scope)", "source": { "line": 270, "path": "src/filters/HeliosFilter.js" }, "summary": "Set the graph filter scope." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getScope", "parameters": [], "remarks": "", "returns": { "description": "Current graph filter scope.", "type": "'render'|'render+layout'" }, "signature": "getScope()", "source": { "line": 280, "path": "src/filters/HeliosFilter.js" }, "summary": "Return the graph filter scope." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getRules", "parameters": [ { "attributes": "optional", "default": "", "description": "Optional rule scope.", "name": "scope", "type": "'node'|'edge'" } ], "remarks": "", "returns": { "description": "Copied rule descriptors.", "type": "Array." }, "signature": "getRules(scope = null)", "source": { "line": 290, "path": "src/filters/HeliosFilter.js" }, "summary": "Return copied rules, optionally limited to node or edge rules." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "addRule", "parameters": [ { "attributes": "", "default": "", "description": "Rule descriptor.", "name": "rule", "type": "Object" } ], "remarks": "", "returns": { "description": "Normalized copied rule descriptor.", "type": "Object" }, "signature": "addRule(rule)", "source": { "line": 320, "path": "src/filters/HeliosFilter.js" }, "summary": "Add a filter rule." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "updateRule", "parameters": [ { "attributes": "", "default": "", "description": "Rule id to update.", "name": "ruleId", "type": "string" }, { "attributes": "optional", "default": "", "description": "Rule fields to replace.", "name": "patch", "type": "Object" } ], "remarks": "", "returns": { "description": "Normalized copied rule descriptor.", "type": "Object" }, "signature": "updateRule(ruleId, patch = {})", "source": { "line": 334, "path": "src/filters/HeliosFilter.js" }, "summary": "Update an existing rule by id." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "upsertRule", "parameters": [ { "attributes": "", "default": "", "description": "Rule descriptor.", "name": "rule", "type": "Object" } ], "remarks": "", "returns": { "description": "Normalized copied rule descriptor.", "type": "Object" }, "signature": "upsertRule(rule)", "source": { "line": 352, "path": "src/filters/HeliosFilter.js" }, "summary": "Update a rule by id when it exists, otherwise add it." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "removeRule", "parameters": [ { "attributes": "", "default": "", "description": "Rule id to remove.", "name": "ruleId", "type": "string" } ], "remarks": "", "returns": { "description": "True when a rule was removed.", "type": "boolean" }, "signature": "removeRule(ruleId)", "source": { "line": 366, "path": "src/filters/HeliosFilter.js" }, "summary": "Remove a rule by id." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clear", "parameters": [ { "attributes": "optional", "default": "", "description": "Optional rule scope to clear.", "name": "scope", "type": "'node'|'edge'" } ], "remarks": "", "returns": { "description": "This filter.", "type": "HeliosFilter" }, "signature": "clear(scope = null)", "source": { "line": 379, "path": "src/filters/HeliosFilter.js" }, "summary": "Remove all rules, or all rules for one node/edge scope." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "compileScopeQuery", "parameters": [ { "attributes": "", "default": "", "description": "Rule scope to compile.", "name": "scope", "type": "'node'|'edge'" } ], "remarks": "", "returns": { "description": "Query expression, or `null` when no active criteria apply.", "type": "string|null" }, "signature": "compileScopeQuery(scope)", "source": { "line": 397, "path": "src/filters/HeliosFilter.js" }, "summary": "Compile active rules for one node/edge scope into a query string." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "hasCriteria", "parameters": [], "remarks": "", "returns": { "description": "True when at least one rule compiles to a query.", "type": "boolean" }, "signature": "hasCriteria()", "source": { "line": 418, "path": "src/filters/HeliosFilter.js" }, "summary": "Test whether this filter has any active criteria." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "toGraphFilterOptions", "parameters": [], "remarks": "", "returns": { "description": "Graph-filter options with node and edge query strings.", "type": "Object" }, "signature": "toGraphFilterOptions()", "source": { "line": 427, "path": "src/filters/HeliosFilter.js" }, "summary": "Convert this model to the graph-filter options consumed by `Helios`." } ], "name": "HeliosFilter", "parameters": [ { "attributes": "optional", "default": "", "description": "Filter id, display name, graph scope, and initial\nrules.", "name": "options", "type": "Object" } ], "remarks": "Rules compile to Helios Network query expressions. Supported rule\ntypes are `numeric`, `categorical`, `string`, and raw `query`.", "returns": { "description": "Filter model that can be activated through\n`helios.activateHeliosFilter(...)` or `FilterBehavior`.", "type": "HeliosFilter" }, "signature": "export class HeliosFilter {", "source": { "line": 227, "path": "src/filters/HeliosFilter.js" }, "summary": "Builder for reusable graph filter rule sets." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "visuals", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, visuals, options = {})", "source": { "line": 264, "path": "src/layouts/GpuForceLayout.js" }, "summary": "" }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "getPositionDelegate", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPositionDelegate()", "source": { "line": 297, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Returns the current position delegate value or state." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async initialize()", "source": { "line": 301, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads initialize." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "shouldRun", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "shouldRun()", "source": { "line": 305, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads should run." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "step", "parameters": [ { "attributes": "optional", "default": "16", "description": "Value passed to `step`.", "name": "deltaMs", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "step(deltaMs = 16)", "source": { "line": 309, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads step." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resize", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resize`.", "name": "size", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resize(size)", "source": { "line": 330, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads resize." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "syncAutoSettingsForNetwork", "parameters": [ { "attributes": "optional", "default": "this.network", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "false", "description": "Value passed to `syncAutoSettingsForNetwork`.", "name": "reheat", "type": "" }, { "attributes": "optional", "default": "'layout-auto-tune' } = {}", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "syncAutoSettingsForNetwork(network = this.network, { reheat = false, reason = 'layout-auto-tune' } = {})", "source": { "line": 349, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads sync auto settings for network." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSettings", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `setSettings`.", "name": "next", "type": "" }, { "attributes": "optional", "default": "false", "description": "Value passed to `setSettings`.", "name": "reheat", "type": "" }, { "attributes": "optional", "default": "'layout-settings' } = {}", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setSettings(next = {}, { reheat = false, reason = 'layout-settings' } = {})", "source": { "line": 388, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Set the settings setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "reheat", "parameters": [ { "attributes": "optional", "default": "'layout'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reheat(reason = 'layout')", "source": { "line": 437, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads reheat." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "seedFromNetworkPositions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "seedFromNetworkPositions(options = {})", "source": { "line": 443, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Read or set the seed from network positions setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getParameterBindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getParameterBindings()", "source": { "line": 454, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Returns the current parameter bindings value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dispose", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dispose()", "source": { "line": 807, "path": "src/layouts/GpuForceLayout.js" }, "summary": "Configures or reads dispose." } ], "name": "GpuForceLayout", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Visual attribute owner.", "name": "visuals", "type": "import('../pipeline/VisualAttributes.js').VisualAttributes" }, { "attributes": "optional", "default": "", "description": "Force, UMAP-like force, sampling, damping,\nrecentering, and renderer delegate options.", "name": "options", "type": "Object" } ], "remarks": "Renderer support and graph size determine whether WebGPU or WebGL2\nbacking is selected. Position output is written into Helios visual position\nbuffers for rendering.", "returns": { "description": "", "type": "" }, "signature": "export class GpuForceLayout extends Layout {", "source": { "line": 263, "path": "src/layouts/GpuForceLayout.js" }, "summary": "GPU-backed force layout that can run through WebGPU or WebGL2 delegates." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "visuals", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, visuals)", "source": { "line": 35, "path": "src/layouts/Layout.js" }, "summary": "" }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async initialize()", "source": { "line": 44, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads initialize." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "shouldRun", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "shouldRun()", "source": { "line": 46, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads should run." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "requestUpdate", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "requestUpdate()", "source": { "line": 50, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads request update." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "step", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "step()", "source": { "line": 54, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads step." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resize()", "source": { "line": 59, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads resize." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setUpdateListener", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setUpdateListener`.", "name": "listener", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setUpdateListener(listener)", "source": { "line": 61, "path": "src/layouts/Layout.js" }, "summary": "Set the update listener setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "emitUpdate", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `emitUpdate`.", "name": "payload", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "emitUpdate(payload)", "source": { "line": 65, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads emit update." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getParameterBindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getParameterBindings()", "source": { "line": 71, "path": "src/layouts/Layout.js" }, "summary": "Returns the current parameter bindings value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "reheat", "parameters": [ { "attributes": "optional", "default": "'layout'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reheat(reason = 'layout')", "source": { "line": 80, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads reheat." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "isPositionHandoffPending", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "isPositionHandoffPending()", "source": { "line": 86, "path": "src/layouts/Layout.js" }, "summary": "Returns the current position handoff pending value or state." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "beginPositionHandoff", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "beginPositionHandoff()", "source": { "line": 90, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads begin position handoff." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "completePositionHandoff", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `completePositionHandoff`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "completePositionHandoff(snapshot = null, options = {})", "source": { "line": 96, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads complete position handoff." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "seedFromPositionSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `seedFromPositionSnapshot`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "seedFromPositionSnapshot(snapshot, options = {})", "source": { "line": 105, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads seed from position snapshot." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dispose", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dispose()", "source": { "line": 148, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads dispose." } ], "name": "Layout", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Visual attribute owner used by renderers.", "name": "visuals", "type": "import('../pipeline/VisualAttributes.js').VisualAttributes" } ], "remarks": "Concrete implementations override lifecycle hooks to move nodes by\nwriting into `_helios_visuals_position`.", "returns": { "description": "", "type": "" }, "signature": "export class Layout {", "source": { "line": 34, "path": "src/layouts/Layout.js" }, "summary": "Base class for layout algorithms." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "visuals", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, visuals, options = {})", "source": { "line": 165, "path": "src/layouts/Layout.js" }, "summary": "" }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "initialize()", "source": { "line": 170, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads initialize." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getParameterBindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getParameterBindings()", "source": { "line": 200, "path": "src/layouts/Layout.js" }, "summary": "Returns the current parameter bindings value or state." } ], "name": "StaticLayout", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Visual attribute owner.", "name": "visuals", "type": "import('../pipeline/VisualAttributes.js').VisualAttributes" }, { "attributes": "optional", "default": "", "description": "Static bounds and sizing options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class StaticLayout extends Layout {", "source": { "line": 164, "path": "src/layouts/Layout.js" }, "summary": "Layout that keeps existing node positions fixed." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "visuals", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, visuals, options = {})", "source": { "line": 224, "path": "src/layouts/Layout.js" }, "summary": "" }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async initialize()", "source": { "line": 232, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads initialize." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "shouldRun", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "shouldRun()", "source": { "line": 244, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads should run." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "step", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "step()", "source": { "line": 248, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads step." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleMessage", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleMessage`.", "name": "message", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleMessage(message)", "source": { "line": 278, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads handle message." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dispose", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dispose()", "source": { "line": 310, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads dispose." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSettings", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `setSettings`.", "name": "next", "type": "" }, { "attributes": "optional", "default": "false", "description": "Value passed to `setSettings`.", "name": "reheat", "type": "" }, { "attributes": "optional", "default": "'layout-settings' } = {}", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setSettings(next = {}, { reheat = false, reason = 'layout-settings' } = {})", "source": { "line": 317, "path": "src/layouts/Layout.js" }, "summary": "Set the settings setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getParameterBindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getParameterBindings()", "source": { "line": 338, "path": "src/layouts/Layout.js" }, "summary": "Returns the current parameter bindings value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resize", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resize`.", "name": "size", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resize(size)", "source": { "line": 535, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads resize." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildGraphPayload", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildGraphPayload()", "source": { "line": 547, "path": "src/layouts/Layout.js" }, "summary": "Configures or reads build graph payload." } ], "name": "WorkerLayout", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Visual attribute owner.", "name": "visuals", "type": "import('../pipeline/VisualAttributes.js').VisualAttributes" }, { "attributes": "optional", "default": "", "description": "Worker layout options such as layout kind, mode,\nforce constants, and sampling settings.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class WorkerLayout extends Layout {", "source": { "line": 223, "path": "src/layouts/Layout.js" }, "summary": "Worker-backed force or jitter layout." }, { "category": "Layouts", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "visuals", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, visuals, options = {})", "source": { "line": 100, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "" }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "initialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async initialize()", "source": { "line": 165, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads initialize." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "shouldRun", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "shouldRun()", "source": { "line": 178, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads should run." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "step", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "step()", "source": { "line": 182, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads step." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "handleMessage", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `handleMessage`.", "name": "message", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "handleMessage(message)", "source": { "line": 225, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads handle message." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "dispose", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dispose()", "source": { "line": 271, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads dispose." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSettings", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `setSettings`.", "name": "next", "type": "" }, { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `setSettings`.", "name": "reheat", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setSettings(next = {}, { reheat = false } = {})", "source": { "line": 304, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Set the settings setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "reheat", "parameters": [ { "attributes": "optional", "default": "'layout'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reheat(reason = 'layout')", "source": { "line": 357, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads reheat." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "seedFromNetworkPositions", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "seedFromNetworkPositions()", "source": { "line": 364, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads seed from network positions." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "completePositionHandoff", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `completePositionHandoff`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "completePositionHandoff(snapshot = null, options = {})", "source": { "line": 373, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads complete position handoff." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "adoptHandoffState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `adoptHandoffState`.", "name": "state", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "adoptHandoffState(state = {})", "source": { "line": 382, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads adopt handoff state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getParameterBindings", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getParameterBindings()", "source": { "line": 408, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Returns the current parameter bindings value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildGraphPayload", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildGraphPayload()", "source": { "line": 572, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Configures or reads build graph payload." } ], "name": "D3Force3DLayout", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Visual attribute owner.", "name": "visuals", "type": "import('../pipeline/VisualAttributes.js').VisualAttributes" }, { "attributes": "optional", "default": "", "description": "D3 force settings and worker options.", "name": "options", "type": "Object" } ], "remarks": "Use this when CPU worker force layout behavior is preferred over\nGPU force layout, especially for compatibility testing.", "returns": { "description": "", "type": "" }, "signature": "export class D3Force3DLayout extends Layout {", "source": { "line": 99, "path": "src/layouts/d3force3dLayoutWorker.js" }, "summary": "Worker-backed layout adapter for the D3 Force 3D engine." }, { "category": "Layouts", "examples": [], "kind": "symbol", "methods": [], "name": "DEFAULT_LAYOUT_TUNING_MODEL", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const DEFAULT_LAYOUT_TUNING_MODEL = Object.freeze({", "source": { "line": 10, "path": "src/layouts/layoutTuningModel.generated.js" }, "summary": "Default model used to tune GPU force layout options from graph statistics." }, { "category": "Layouts", "examples": [], "kind": "function", "methods": [], "name": "extractLayoutTuningFeatures", "parameters": [ { "attributes": "", "default": "", "description": "Helios network or network-like object.", "name": "network", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional feature overrides such as nodeCount or edgeCount.", "name": "hints", "type": "Object" } ], "remarks": "", "returns": { "description": "Feature record and model input vector.", "type": "Object" }, "signature": "export function extractLayoutTuningFeatures(network, hints = {}) {", "source": { "line": 145, "path": "src/layouts/layoutTuningModel.generated.js" }, "summary": "Extract graph features used by the layout tuning model." }, { "category": "Layouts", "examples": [], "kind": "function", "methods": [], "name": "predictLayoutTuningOptions", "parameters": [ { "attributes": "", "default": "", "description": "Helios network or network-like object.", "name": "network", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Prediction options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Model descriptor, custom predictor, or false to disable.", "name": "options.model", "type": "Object|Function|false|null" }, { "attributes": "optional", "default": "", "description": "Base layout options multiplied by model outputs.", "name": "options.baseOptions", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional feature overrides.", "name": "options.hints", "type": "Object" } ], "remarks": "", "returns": { "description": "Predicted layout options.", "type": "Object" }, "signature": "export function predictLayoutTuningOptions(network, {", "source": { "line": 199, "path": "src/layouts/layoutTuningModel.generated.js" }, "summary": "Predict layout option overrides for a network using the layout tuning model." }, { "category": "Persistence", "examples": [], "kind": "symbol", "methods": [], "name": "PERSISTENCE_SCHEMA_VERSION", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const PERSISTENCE_SCHEMA_VERSION = 1;", "source": { "line": 7, "path": "src/persistence/schema.js" }, "summary": "Current schema version for Helios Web persistence envelopes." }, { "category": "Persistence", "examples": [], "kind": "symbol", "methods": [], "name": "PERSISTENCE_KINDS", "parameters": [], "remarks": "Preferences, visualization snapshots, and full sessions share the\nsame envelope shape but validate different payload structures.", "returns": { "description": "", "type": "" }, "signature": "export const PERSISTENCE_KINDS = Object.freeze({", "source": { "line": 15, "path": "src/persistence/schema.js" }, "summary": "Supported persistence envelope kinds." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createDefaultPreferencesState", "parameters": [ { "attributes": "optional", "default": "", "description": "Partial preferences payload.", "name": "value", "type": "Object" } ], "remarks": "", "returns": { "description": "Preferences state with theme, autosave, and responsive\npreference fields populated.", "type": "Object" }, "signature": "export function createDefaultPreferencesState(value = {}) {", "source": { "line": 136, "path": "src/persistence/schema.js" }, "summary": "Normalize a preferences payload into the current public preference shape." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createDefaultUIState", "parameters": [ { "attributes": "optional", "default": "", "description": "Partial UI state from a session or app shell.", "name": "value", "type": "Object" } ], "remarks": "", "returns": { "description": "UI state with panel, dock-order, and interface records.", "type": "Object" }, "signature": "export function createDefaultUIState(value = {}) {", "source": { "line": 152, "path": "src/persistence/schema.js" }, "summary": "Normalize a UI payload into the current serializable UI state shape." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createDefaultNetworkSource", "parameters": [ { "attributes": "optional", "default": "", "description": "Partial source metadata.", "name": "value", "type": "Object" } ], "remarks": "", "returns": { "description": "Network source metadata including name, format, counts,\nand whether portable visualization state was attached.", "type": "Object" }, "signature": "export function createDefaultNetworkSource(value = {}) {", "source": { "line": 170, "path": "src/persistence/schema.js" }, "summary": "Normalize source-network metadata stored with visualization state." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createPersistenceEnvelope", "parameters": [ { "attributes": "", "default": "", "description": "One of `preferences`, `visualization`, or `session`.", "name": "kind", "type": "string" }, { "attributes": "", "default": "", "description": "Payload to normalize for the selected kind.", "name": "payload", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Caller-owned metadata copied into the envelope.", "name": "metadata", "type": "Object" } ], "remarks": "Envelopes are the boundary used by Helios persistence APIs and by\nportable network visualization attachments. Unknown payload fields are\nnormalized rather than passed through blindly.", "returns": { "description": "Current-schema persistence envelope.", "type": "Object" }, "signature": "export function createPersistenceEnvelope(kind, payload, metadata = {}) {", "source": { "line": 302, "path": "src/persistence/schema.js" }, "summary": "Create a versioned persistence envelope." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "migratePersistenceEnvelope", "parameters": [ { "attributes": "", "default": "", "description": "Existing envelope or partial payload.", "name": "input", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Kind to enforce during migration.", "name": "expectedKind", "type": "string|null" } ], "remarks": "", "returns": { "description": "Current-schema envelope.", "type": "Object" }, "signature": "export function migratePersistenceEnvelope(input, expectedKind = null) {", "source": { "line": 336, "path": "src/persistence/schema.js" }, "summary": "Normalize a partial persistence object into the current envelope." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "flattenVisualizationOverrides", "parameters": [ { "attributes": "", "default": "", "description": "Visualization state to flatten.", "name": "source", "type": "Object" } ], "remarks": "", "returns": { "description": "Dotted-path override map.", "type": "Object" }, "signature": "export function flattenVisualizationOverrides(source) {", "source": { "line": 366, "path": "src/persistence/schema.js" }, "summary": "Flatten visualization state into sparse dotted override paths." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "diffOverrideMaps", "parameters": [ { "attributes": "optional", "default": "", "description": "Baseline dotted-path values.", "name": "base", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Current dotted-path values.", "name": "current", "type": "Object" } ], "remarks": "", "returns": { "description": "Dotted paths whose values differ from the baseline.", "type": "Object" }, "signature": "export function diffOverrideMaps(base = {}, current = {}) {", "source": { "line": 418, "path": "src/persistence/schema.js" }, "summary": "Compute sparse override differences between two flattened override maps." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "applyOverridesToVisualizationState", "parameters": [ { "attributes": "", "default": "", "description": "Base visualization state.", "name": "source", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Dotted-path override map.", "name": "overrides", "type": "Object" } ], "remarks": "", "returns": { "description": "Visualization state with overrides applied.", "type": "Object" }, "signature": "export function applyOverridesToVisualizationState(source, overrides = {}) {", "source": { "line": 438, "path": "src/persistence/schema.js" }, "summary": "Apply sparse dotted-path overrides to a visualization state object." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "serializePersistenceEnvelope", "parameters": [ { "attributes": "", "default": "", "description": "Envelope or partial payload to normalize first.", "name": "envelope", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Whether to emit indented JSON.", "name": "pretty", "type": "boolean" } ], "remarks": "", "returns": { "description": "Stable JSON string.", "type": "string" }, "signature": "export function serializePersistenceEnvelope(envelope, pretty = true) {", "source": { "line": 491, "path": "src/persistence/schema.js" }, "summary": "Serialize a persistence envelope to JSON." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "parsePersistenceEnvelope", "parameters": [ { "attributes": "", "default": "", "description": "JSON string, current envelope, or partial\npayload object.", "name": "source", "type": "string|Object" }, { "attributes": "optional", "default": "", "description": "Optional kind to validate/migrate to.", "name": "expectedKind", "type": "string|null" } ], "remarks": "", "returns": { "description": "Current-schema envelope.", "type": "Object" }, "signature": "export function parsePersistenceEnvelope(source, expectedKind = null) {", "source": { "line": 504, "path": "src/persistence/schema.js" }, "summary": "Parse and migrate persistence input." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 19, "path": "src/persistence/storage.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "unfinishedSessionKeyFor", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `unfinishedSessionKeyFor`.", "name": "workspaceId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "unfinishedSessionKeyFor(workspaceId = null)", "source": { "line": 25, "path": "src/persistence/storage.js" }, "summary": "Configures or reads unfinished session key for." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "read", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async read()", "source": { "line": 30, "path": "src/persistence/storage.js" }, "summary": "Configures or reads read." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "write", "parameters": [ { "attributes": "", "default": "", "description": "New write value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async write(value)", "source": { "line": 36, "path": "src/persistence/storage.js" }, "summary": "Read or set the write setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "clear", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async clear()", "source": { "line": 42, "path": "src/persistence/storage.js" }, "summary": "Updates the clear state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getUnfinishedSessionId", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `getUnfinishedSessionId`.", "name": "workspaceId", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getUnfinishedSessionId(workspaceId = null, options = {})", "source": { "line": 46, "path": "src/persistence/storage.js" }, "summary": "Returns the current unfinished session id value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setUnfinishedSessionId", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setUnfinishedSessionId`.", "name": "id", "type": "" }, { "attributes": "optional", "default": "null", "description": "Value passed to `setUnfinishedSessionId`.", "name": "workspaceId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async setUnfinishedSessionId(id, workspaceId = null)", "source": { "line": 57, "path": "src/persistence/storage.js" }, "summary": "Set the unfinished session id setting." } ], "name": "LocalStoragePreferenceStore", "parameters": [ { "attributes": "optional", "default": "", "description": "Optional storage object, preference key, and\nunfinished-session key.", "name": "options", "type": "Object" } ], "remarks": "Inject `storage` for tests or app shells that need isolated storage.", "returns": { "description": "Async preference store implementation.", "type": "LocalStoragePreferenceStore" }, "signature": "export class LocalStoragePreferenceStore {", "source": { "line": 18, "path": "src/persistence/storage.js" }, "summary": "Preference store backed by the browser `localStorage` API." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 93, "path": "src/persistence/storage.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "put", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `put`.", "name": "record", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async put(record)", "source": { "line": 120, "path": "src/persistence/storage.js" }, "summary": "Configures or reads put." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "get", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `get`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async get(id)", "source": { "line": 130, "path": "src/persistence/storage.js" }, "summary": "Returns the current get value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getAll", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getAll()", "source": { "line": 138, "path": "src/persistence/storage.js" }, "summary": "Returns the current all value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "delete", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `delete`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async delete(id)", "source": { "line": 162, "path": "src/persistence/storage.js" }, "summary": "Configures or reads delete." } ], "name": "IndexedDBSessionStore", "parameters": [ { "attributes": "optional", "default": "", "description": "Optional IndexedDB factory, database name, object\nstore name, and schema version.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Async session store implementation.", "type": "IndexedDBSessionStore" }, "signature": "export class IndexedDBSessionStore {", "source": { "line": 92, "path": "src/persistence/storage.js" }, "summary": "Session store backed by IndexedDB." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createMemoryStorage", "parameters": [], "remarks": "", "returns": { "description": "Minimal Storage implementation for tests and non-browser\nexamples.", "type": "Storage" }, "signature": "export function createMemoryStorage() {", "source": { "line": 179, "path": "src/persistence/storage.js" }, "summary": "Create an in-memory Storage-compatible object." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createMemoryIndexedDBFactory", "parameters": [], "remarks": "", "returns": { "description": "Minimal IndexedDB factory compatible with\n`IndexedDBSessionStore`.", "type": "IDBFactory" }, "signature": "export function createMemoryIndexedDBFactory() {", "source": { "line": 204, "path": "src/persistence/storage.js" }, "summary": "Create an in-memory IndexedDB-like factory for persistence tests." }, { "category": "Mappers", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 842, "path": "src/pipeline/Mapper.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "channel", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "channel(name)", "source": { "line": 849, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads channel." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setChannel", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Value passed to `setChannel`.", "name": "config", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setChannel(name, config)", "source": { "line": 853, "path": "src/pipeline/Mapper.js" }, "summary": "Set the channel setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getChannel", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getChannel(name)", "source": { "line": 865, "path": "src/pipeline/Mapper.js" }, "summary": "Returns the current channel value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "mapItem", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `mapItem`.", "name": "item", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `mapItem`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "mapItem(item, context = {})", "source": { "line": 869, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads map item." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "mapItems", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `mapItems`.", "name": "items", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `mapItems`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "mapItems(items, context = {})", "source": { "line": 878, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads map items." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensurePercentileLookup", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `ensurePercentileLookup`.", "name": "config", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensurePercentileLookup(config)", "source": { "line": 882, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads ensure percentile lookup." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureBuffersForChannel", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `ensureBuffersForChannel`.", "name": "config", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureBuffersForChannel(config)", "source": { "line": 891, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads ensure buffers for channel." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "shouldEnsureChannelBuffer", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `shouldEnsureChannelBuffer`.", "name": "config", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `shouldEnsureChannelBuffer`.", "name": "def", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "shouldEnsureChannelBuffer(config, def)", "source": { "line": 942, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads should ensure channel buffer." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "isNodePassthroughChannel", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `isNodePassthroughChannel`.", "name": "config", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `isNodePassthroughChannel`.", "name": "def", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "isNodePassthroughChannel(config, def)", "source": { "line": 950, "path": "src/pipeline/Mapper.js" }, "summary": "Returns the current node passthrough channel value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveNodeSourceAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolveNodeSourceAttribute`.", "name": "config", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `resolveNodeSourceAttribute`.", "name": "def", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveNodeSourceAttribute(config, def)", "source": { "line": 958, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads resolve node source attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveNodeSourceDimension", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolveNodeSourceDimension`.", "name": "sourceAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `resolveNodeSourceDimension`.", "name": "def", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveNodeSourceDimension(sourceAttribute, def)", "source": { "line": 970, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads resolve node source dimension." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolvePassthroughConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolvePassthroughConfig`.", "name": "config", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `resolvePassthroughConfig`.", "name": "def", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `resolvePassthroughConfig`.", "name": "sourceDimension", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `resolvePassthroughConfig`.", "name": "expectedDimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolvePassthroughConfig(config, def, sourceDimension, expectedDimension)", "source": { "line": 987, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads resolve passthrough config." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureNodeSourceAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `ensureNodeSourceAttribute`.", "name": "sourceAttribute", "type": "" }, { "attributes": "", "default": "", "description": "Attribute value type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Value passed to `ensureNodeSourceAttribute`.", "name": "sourceDimension", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `ensureNodeSourceAttribute`.", "name": "channelName", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureNodeSourceAttribute(sourceAttribute, type, sourceDimension, channelName)", "source": { "line": 1024, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads ensure node source attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "removeEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "removeEdgeAttribute(name)", "source": { "line": 1112, "path": "src/pipeline/Mapper.js" }, "summary": "Manages edge attribute for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "unregisterNodeToEdge", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `unregisterNodeToEdge`.", "name": "attribute", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "unregisterNodeToEdge(attribute)", "source": { "line": 1125, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads unregister node to edge." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "unregisterChannel", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `unregisterChannel`.", "name": "config", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "unregisterChannel(config)", "source": { "line": 1138, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads unregister channel." } ], "name": "Mapper", "parameters": [ { "attributes": "optional", "default": "", "description": "Mapper mode (`node` or `edge`), network, and\noptional bookkeeping dependencies.", "name": "options", "type": "Object" } ], "remarks": "Most applications should use `MapperCollection` or\n`MappersBehavior`. Direct mapper access is still public for custom pipelines\nthat need to build visual attributes programmatically.", "returns": { "description": "Mapper with an initially empty channel set.", "type": "Mapper" }, "signature": "export class Mapper {", "source": { "line": 841, "path": "src/pipeline/Mapper.js" }, "summary": "Low-level mapper for one node or edge visual mode." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "createDefaultMappers", "parameters": [ { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" } ], "remarks": "", "returns": { "description": "Default node and edge\nmappers used when Helios is constructed without custom mappers.", "type": "{nodeMapper:Mapper,edgeMapper:Mapper}" }, "signature": "export function createDefaultMappers(network) {", "source": { "line": 1161, "path": "src/pipeline/Mapper.js" }, "summary": "Create the default node and edge mapper collections for a network." }, { "category": "Mappers", "examples": [], "kind": "symbol", "methods": [], "name": "VISUAL_ATTRIBUTES", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const VISUAL_ATTRIBUTES = VISUAL_ATTRIBUTE_MAP;", "source": { "line": 1189, "path": "src/pipeline/Mapper.js" }, "summary": "Map of public mapper channel names to internal Helios visual attribute names." }, { "category": "Mappers", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Mode for this operation.", "name": "mode", "type": "string" }, { "attributes": "", "default": "", "description": "Network instance to read from or mutate.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "onChange", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "debug", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(mode, network, onChange, debug)", "source": { "line": 1208, "path": "src/pipeline/Mapper.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "channel", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "channel(name)", "source": { "line": 1222, "path": "src/pipeline/Mapper.js" }, "summary": "Returns a ChannelBuilder bound to the default mapper. Calling `.done()` will mark the collection dirty." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "add", "parameters": [ { "attributes": "", "default": "", "description": "", "name": "entry", "type": "Mapper | Object" }, { "attributes": "optional", "default": "", "description": "", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "add(entry, name)", "source": { "line": 1239, "path": "src/pipeline/Mapper.js" }, "summary": "Adds a Mapper instance or a descriptor object describing channels." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setDefault", "parameters": [ { "attributes": "", "default": "", "description": "", "name": "mapper", "type": "Mapper" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setDefault(mapper)", "source": { "line": 1257, "path": "src/pipeline/Mapper.js" }, "summary": "Replaces the default mapper." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "createMapper", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "createMapper(name)", "source": { "line": 1265, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads create mapper." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildFromDescriptor", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildFromDescriptor`.", "name": "descriptor", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildFromDescriptor(descriptor)", "source": { "line": 1271, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads build from descriptor." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "toCombinedMapper", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "toCombinedMapper(options = {})", "source": { "line": 1288, "path": "src/pipeline/Mapper.js" }, "summary": "Merges all registered mappers into a single Mapper (channels override in insertion order)." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "touch", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "touch()", "source": { "line": 1313, "path": "src/pipeline/Mapper.js" }, "summary": "Configures or reads touch." } ], "name": "MapperCollection", "parameters": [ { "attributes": "", "default": "", "description": "Visual target scope.", "name": "mode", "type": "'node'|'edge'" }, { "attributes": "", "default": "", "description": "Source graph.", "name": "network", "type": "HeliosNetwork" }, { "attributes": "optional", "default": "", "description": "Callback invoked when mapper configuration\nchanges.", "name": "onChange", "type": "Function" } ], "remarks": "Collections let apps keep multiple named mapper presets and combine\nthem before applying visual attributes.", "returns": { "description": "Collection with a default mapper.", "type": "MapperCollection" }, "signature": "export class MapperCollection {", "source": { "line": 1207, "path": "src/pipeline/Mapper.js" }, "summary": "Collection of named mappers for either node or edge visuals." }, { "category": "Mappers", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "", "name": "network", "type": "HeliosNetwork" }, { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "debug", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(network, debug)", "source": { "line": 170, "path": "src/pipeline/VisualAttributes.js" }, "summary": "" }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodePositions", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodePositions() {", "source": { "line": 181, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node positions exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodeColors", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodeColors() {", "source": { "line": 185, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node colors exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodeSizes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodeSizes() {", "source": { "line": 189, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node sizes exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodeStates", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodeStates() {", "source": { "line": 193, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node states exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodeOutlineWidths", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodeOutlineWidths() {", "source": { "line": 197, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node outline widths exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "nodeOutlineColors", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get nodeOutlineColors() {", "source": { "line": 201, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Node outline colors exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "edgeColors", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get edgeColors() {", "source": { "line": 205, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Edge colors exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "edgeWidths", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get edgeWidths() {", "source": { "line": 209, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Edge widths exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "edgeOpacities", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get edgeOpacities() {", "source": { "line": 213, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Edge opacities exposed by the class." }, { "category": "Instance Properties", "examples": [], "kind": "property", "methods": [], "name": "edgeStates", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get edgeStates() {", "source": { "line": 217, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Edge states exposed by the class." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getNodeAttributeView", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getNodeAttributeView(name)", "source": { "line": 221, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Returns the current node attribute view value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getEdgeAttributeView", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getEdgeAttributeView(name)", "source": { "line": 226, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Returns the current edge attribute view value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "normalizeLookupName", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "normalizeLookupName(name)", "source": { "line": 231, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads normalize lookup name." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "prepareNodeAttributeLookups", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `prepareNodeAttributeLookups`.", "name": "names", "type": "" }, { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `prepareNodeAttributeLookups`.", "name": "allowMissing", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "prepareNodeAttributeLookups(names, { allowMissing = false } = {})", "source": { "line": 235, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads prepare node attribute lookups." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "prepareEdgeAttributeLookups", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `prepareEdgeAttributeLookups`.", "name": "names", "type": "" }, { "attributes": "optional", "default": "false } = {}", "description": "Value passed to `prepareEdgeAttributeLookups`.", "name": "allowMissing", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "prepareEdgeAttributeLookups(names, { allowMissing = false } = {})", "source": { "line": 256, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads prepare edge attribute lookups." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getPreparedNodeAttributeView", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `getPreparedNodeAttributeView`.", "name": "prepared", "type": "" }, { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPreparedNodeAttributeView(prepared, name)", "source": { "line": 277, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Returns the current prepared node attribute view value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getPreparedEdgeAttributeView", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `getPreparedEdgeAttributeView`.", "name": "prepared", "type": "" }, { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPreparedEdgeAttributeView(prepared, name)", "source": { "line": 286, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Returns the current prepared edge attribute view value or state." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "seedMissingEdgeOpacity", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "seedMissingEdgeOpacity()", "source": { "line": 300, "path": "src/pipeline/VisualAttributes.js" }, "summary": "When networks are populated before Helios is created, edge opacity buffers start at zero which hides edges entirely. Seed a reasonable default for any active edge that still has an uninitialized (zero/invalid) opacity." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "applyMappers", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `applyMappers`.", "name": "nodeMapper", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `applyMappers`.", "name": "edgeMapper", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyMappers({ nodeMapper, edgeMapper } = {})", "source": { "line": 327, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Updates the mappers state on the current instance." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "setNetworkVisualConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setNetworkVisualConfig`.", "name": "config", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setNetworkVisualConfig(config)", "source": { "line": 341, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Set the network visual config setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildVisualConstantConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildVisualConstantConfig`.", "name": "nodeMapper", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `buildVisualConstantConfig`.", "name": "edgeMapper", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildVisualConstantConfig({ nodeMapper, edgeMapper } = {})", "source": { "line": 350, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads build visual constant config." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildNodeConstantConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildNodeConstantConfig`.", "name": "mapper", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildNodeConstantConfig(mapper)", "source": { "line": 358, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads build node constant config." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildEdgeConstantConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildEdgeConstantConfig`.", "name": "mapper", "type": "" }, { "attributes": "optional", "default": "null", "description": "Value passed to `buildEdgeConstantConfig`.", "name": "nodeConfig", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildEdgeConstantConfig(mapper, nodeConfig = null)", "source": { "line": 379, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads build edge constant config." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "augmentEdgeSourceConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `augmentEdgeSourceConfig`.", "name": "edgeConfig", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `augmentEdgeSourceConfig`.", "name": "mapper", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "augmentEdgeSourceConfig(edgeConfig, mapper)", "source": { "line": 422, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads augment edge source config." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "applyNodeMapper", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `applyNodeMapper`.", "name": "mapper", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `applyNodeMapper`.", "name": "visualConfig", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyNodeMapper(mapper, visualConfig)", "source": { "line": 504, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Updates the node mapper state on the current instance." }, { "category": "Mappers", "examples": [], "kind": "method", "methods": [], "name": "applyEdgeMapper", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `applyEdgeMapper`.", "name": "mapper", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `applyEdgeMapper`.", "name": "visualConfig", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyEdgeMapper(mapper, visualConfig)", "source": { "line": 562, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Updates the edge mapper state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureVisualAttributesForConfig", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `ensureVisualAttributesForConfig`.", "name": "nodeMapper", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `ensureVisualAttributesForConfig`.", "name": "edgeMapper", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `ensureVisualAttributesForConfig`.", "name": "visualConfig", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureVisualAttributesForConfig({ nodeMapper, edgeMapper, visualConfig } = {})", "source": { "line": 634, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads ensure visual attributes for config." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureAttributes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureAttributes()", "source": { "line": 683, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads ensure attributes." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bumpNodeAttributes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bumpNodeAttributes(...names)", "source": { "line": 689, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads bump node attributes." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bumpEdgeAttributes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bumpEdgeAttributes(...names)", "source": { "line": 715, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads bump edge attributes." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "markPositionsDirty", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "markPositionsDirty()", "source": { "line": 740, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads mark positions dirty." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyNodeDefaults", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "indices", "type": "Iterable" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyNodeDefaults(indices)", "source": { "line": 748, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Initializes basic node visuals. Can be re-used whenever nodes are added." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "applyEdgeDefaults", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "indices", "type": "Iterable" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "applyEdgeDefaults(indices)", "source": { "line": 805, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Initializes basic edge visuals. Can be re-used whenever edges are added." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "seedMissingPositions", "parameters": [ { "attributes": "optional", "default": "", "description": "", "name": "bounds", "type": "{width?: number, height?: number, depth?: number, mode?: string, center?: number[]}" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "seedMissingPositions(bounds = {})", "source": { "line": 845, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Seeds missing node positions with random values so downstream layouts/renderers always have finite coordinates to start with." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureNodeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Attribute value type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Element width or memory-stride setting.", "name": "dimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureNodeAttribute(name, type, dimension)", "source": { "line": 951, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads ensure node attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "name", "type": "string" }, { "attributes": "", "default": "", "description": "Attribute value type.", "name": "type", "type": "string" }, { "attributes": "", "default": "", "description": "Element width or memory-stride setting.", "name": "dimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureEdgeAttribute(name, type, dimension)", "source": { "line": 1013, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads ensure edge attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "ensureNodeToEdgeAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "sourceName", "type": "" }, { "attributes": "", "default": "", "description": "Attribute or API identifier.", "name": "edgeName", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `ensureNodeToEdgeAttribute`.", "name": "sourceDimension", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "ensureNodeToEdgeAttribute(sourceName, edgeName, sourceDimension)", "source": { "line": 1075, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads ensure node to edge attribute." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "collectAttributeNames", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `collectAttributeNames`.", "name": "mapper", "type": "" }, { "attributes": "", "default": "", "description": "Mode for this operation.", "name": "mode", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "collectAttributeNames(mapper, mode)", "source": { "line": 1133, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads collect attribute names." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveNodeAttributeBuffers", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolveNodeAttributeBuffers`.", "name": "names", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveNodeAttributeBuffers(names)", "source": { "line": 1159, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads resolve node attribute buffers." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveEdgeAttributeBuffers", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolveEdgeAttributeBuffers`.", "name": "names", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveEdgeAttributeBuffers(names)", "source": { "line": 1179, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads resolve edge attribute buffers." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildAttributeObject", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildAttributeObject`.", "name": "buffers", "type": "" }, { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildAttributeObject(buffers, index)", "source": { "line": 1198, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads build attribute object." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "buildEdgeAttributeObject", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `buildEdgeAttributeObject`.", "name": "buffers", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `buildEdgeAttributeObject`.", "name": "edgeId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "buildEdgeAttributeObject(buffers, edgeId)", "source": { "line": 1218, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads build edge attribute object." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "writeNodeVisuals", "parameters": [ { "attributes": "", "default": "", "description": "Node or edge identifiers/indices used by the operation.", "name": "nodeId", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeNodeVisuals`.", "name": "mapped", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeNodeVisuals`.", "name": "visuals", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "writeNodeVisuals(nodeId, mapped, visuals)", "source": { "line": 1222, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads write node visuals." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "writeEdgeVisuals", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `writeEdgeVisuals`.", "name": "edgeId", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeVisuals`.", "name": "mapped", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeVisuals`.", "name": "visuals", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "writeEdgeVisuals(edgeId, mapped, visuals)", "source": { "line": 1255, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads write edge visuals." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "toRgba", "parameters": [ { "attributes": "", "default": "", "description": "New to rgba value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "toRgba(value)", "source": { "line": 1291, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Read or set the to rgba setting." }, { "category": "Appearance", "examples": [], "kind": "method", "methods": [], "name": "resolveEdgeColorPair", "parameters": [ { "attributes": "", "default": "", "description": "New resolve edge color pair value. Omit this argument to read the current value.", "name": "value", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveEdgeColorPair(value)", "source": { "line": 1359, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Read or set the resolve edge color pair setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveEdgeScalarPair", "parameters": [ { "attributes": "", "default": "", "description": "New resolve edge scalar pair value. Omit this argument to read the current value.", "name": "value", "type": "boolean" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveEdgeScalarPair(value)", "source": { "line": 1380, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Read or set the resolve edge scalar pair setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "writeEdgeDefaults", "parameters": [ { "attributes": "", "default": "", "description": "Node, edge, or attribute index.", "name": "index", "type": "number" }, { "attributes": "", "default": "", "description": "New write edge defaults value. Omit this argument to read the current value.", "name": "color", "type": "string|Array" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeDefaults`.", "name": "width", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeDefaults`.", "name": "opacity", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeDefaults`.", "name": "colorView", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeDefaults`.", "name": "widthView", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `writeEdgeDefaults`.", "name": "opacityView", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "writeEdgeDefaults(index, color, width, opacity, colorView, widthView, opacityView)", "source": { "line": 1454, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads write edge defaults." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "withBufferAccess", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `withBufferAccess`.", "name": "fn", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "withBufferAccess(fn)", "source": { "line": 1481, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads with buffer access." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "flushPendingAttributeBumps", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "flushPendingAttributeBumps()", "source": { "line": 1501, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Configures or reads flush pending attribute bumps." } ], "name": "VisualAttributes", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class VisualAttributes {", "source": { "line": 166, "path": "src/pipeline/VisualAttributes.js" }, "summary": "Ensures required visual attributes exist on the Helios network, seeds defaults, and provides helpers to apply mappers into sparse buffers." }, { "category": "Internal", "examples": [ "const rotation = createYawPitchQuaternion(Math.PI / 4, 0);" ], "kind": "function", "methods": [], "name": "createYawPitchQuaternion", "parameters": [ { "attributes": "optional", "default": "0", "description": "Horizontal rotation in radians.", "name": "yawRadians", "type": "number" }, { "attributes": "optional", "default": "0", "description": "Vertical rotation in radians.", "name": "pitchRadians", "type": "number" } ], "remarks": "", "returns": { "description": "Quaternion in `[x, y, z, w]` order.", "type": "Float32Array" }, "signature": "export function createYawPitchQuaternion(yawRadians = 0, pitchRadians = 0) {", "source": { "line": 153, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Build a normalized camera rotation quaternion from yaw and pitch angles." }, { "category": "Internal", "examples": [ "const pose = captureCameraPose(helios.renderer.camera);" ], "kind": "function", "methods": [], "name": "captureCameraPose", "parameters": [ { "attributes": "", "default": "", "description": "Camera object owned by the active renderer.", "name": "camera", "type": "Object" } ], "remarks": "", "returns": { "description": "Pose snapshot, or `null` when no camera is supplied.", "type": "Object|null" }, "signature": "export function captureCameraPose(camera) {", "source": { "line": 171, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Capture a renderer camera into a serializable pose object." }, { "category": "Internal", "examples": [ "const next = mergeCameraPose(currentPose, { zoom: 2 });" ], "kind": "function", "methods": [], "name": "mergeCameraPose", "parameters": [ { "attributes": "", "default": "", "description": "Existing pose to use as defaults.", "name": "basePose", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Pose fields to replace.", "name": "patch", "type": "Object" } ], "remarks": "", "returns": { "description": "Normalized camera pose.", "type": "Object" }, "signature": "export function mergeCameraPose(basePose, patch = {}) {", "source": { "line": 203, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Merge a partial camera pose into an existing pose." }, { "category": "Internal", "examples": [ "applyCameraPose(helios.renderer.camera, pose);" ], "kind": "function", "methods": [], "name": "applyCameraPose", "parameters": [ { "attributes": "", "default": "", "description": "Renderer camera to update.", "name": "camera", "type": "Object" }, { "attributes": "", "default": "", "description": "Pose fields to apply.", "name": "pose", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Application options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "true", "description": "Run the camera update hook after applying values.", "name": "options.update", "type": "boolean" }, { "attributes": "optional", "default": "true } = {}", "description": "Value passed to `applyCameraPose`.", "name": "update", "type": "" } ], "remarks": "", "returns": { "description": "Updated camera, or `null` when no camera is supplied.", "type": "Object|null" }, "signature": "export function applyCameraPose(camera, pose, { update = true } = {}) {", "source": { "line": 257, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Apply a captured or merged pose to a renderer camera." }, { "category": "Internal", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "null } = {}", "description": "Value passed to `constructor`.", "name": "requestRender", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor({ requestRender = null } = {})", "source": { "line": 347, "path": "src/rendering/CameraTransitionController.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "stop", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "stop()", "source": { "line": 353, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Configures or reads stop." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "transition", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `transition`.", "name": "camera", "type": "" }, { "attributes": "", "default": "", "description": "Camera pose fields to apply.", "name": "fromPose", "type": "" }, { "attributes": "", "default": "", "description": "Camera pose fields to apply.", "name": "toPose", "type": "" }, { "attributes": "optional", "default": "320 } = {}", "description": "Value passed to `transition`.", "name": "durationMs", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "transition(camera, { fromPose, toPose, durationMs = 320 } = {})", "source": { "line": 365, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Configures or reads transition." } ], "name": "CameraTransitionController", "parameters": [ { "attributes": "", "default": "", "description": "Controller dependencies.", "name": "options", "type": "Object" }, { "attributes": "", "default": "", "description": "Renderer camera to animate.", "name": "options.camera", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Callback used to schedule a render.", "name": "options.requestRender", "type": "Function" }, { "attributes": "optional", "default": "", "description": "Clock function returning milliseconds.", "name": "options.now", "type": "Function" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class CameraTransitionController {", "source": { "line": 346, "path": "src/rendering/CameraTransitionController.js" }, "summary": "Time-based camera transition controller used by Helios camera animations." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 180, "path": "src/state/HeliosStateManager.js" }, "summary": "" }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setOverrideTrackingReady", "parameters": [ { "attributes": "optional", "default": "true", "description": "Value passed to `setOverrideTrackingReady`.", "name": "ready", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setOverrideTrackingReady(ready = true)", "source": { "line": 201, "path": "src/state/HeliosStateManager.js" }, "summary": "Set the override tracking ready setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "register", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `register`.", "name": "owner", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `register`.", "name": "prefix", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `register`.", "name": "entries", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "register(owner, prefix, entries = {})", "source": { "line": 206, "path": "src/state/HeliosStateManager.js" }, "summary": "Manages register for the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "entry", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `entry`.", "name": "key", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "entry(key)", "source": { "line": 289, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads entry." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "entriesFor", "parameters": [ { "attributes": "optional", "default": "''", "description": "Value passed to `entriesFor`.", "name": "prefix", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "entriesFor(prefix = '')", "source": { "line": 295, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads entries for." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "get", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `get`.", "name": "key", "type": "" }, { "attributes": "optional", "default": "undefined", "description": "Value passed to `get`.", "name": "fallback", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "get(key, fallback = undefined)", "source": { "line": 302, "path": "src/state/HeliosStateManager.js" }, "summary": "Returns the current get value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "set", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `set`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "New set value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "set(key, value, options = {})", "source": { "line": 310, "path": "src/state/HeliosStateManager.js" }, "summary": "Set the set setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setDefault", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setDefault`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "New set default value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setDefault(key, value, options = {})", "source": { "line": 314, "path": "src/state/HeliosStateManager.js" }, "summary": "Set the default setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "reset", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `reset`.", "name": "keyOrPrefix", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reset(keyOrPrefix, options = {})", "source": { "line": 345, "path": "src/state/HeliosStateManager.js" }, "summary": "Updates the reset state on the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "resetToDefault", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resetToDefault`.", "name": "keyOrPrefix", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resetToDefault(keyOrPrefix, options = {})", "source": { "line": 365, "path": "src/state/HeliosStateManager.js" }, "summary": "Updates the to default state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "status", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `status`.", "name": "keyOrPrefix", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "status(keyOrPrefix)", "source": { "line": 369, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads status." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "dirtyState", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "dirtyState()", "source": { "line": 399, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads dirty state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "subscribe", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `subscribe`.", "name": "keyOrPrefix", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `subscribe`.", "name": "callback", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "subscribe(keyOrPrefix, callback, options = {})", "source": { "line": 415, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads subscribe." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "transaction", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "null", "description": "Value passed to `transaction`.", "name": "callback", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "transaction(options = {}, callback = null)", "source": { "line": 433, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads transaction." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restore", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restore`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restore(snapshot = {}, options = {})", "source": { "line": 465, "path": "src/state/HeliosStateManager.js" }, "summary": "Updates the restore state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "snapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "snapshot(options = {})", "source": { "line": 487, "path": "src/state/HeliosStateManager.js" }, "summary": "Read or set the snapshot setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serialize", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serialize()", "source": { "line": 502, "path": "src/state/HeliosStateManager.js" }, "summary": "Handles serialize for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "preferredKey", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `preferredKey`.", "name": "key", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "preferredKey(key)", "source": { "line": 510, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads preferred key." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "overrideKeys", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "overrideKeys()", "source": { "line": 516, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads override keys." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getOverrides", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getOverrides(options = {})", "source": { "line": 520, "path": "src/state/HeliosStateManager.js" }, "summary": "Read or set the get overrides setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resolveKey", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resolveKey`.", "name": "key", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "resolveKey(key)", "source": { "line": 538, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads resolve key." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "debugStats", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "debugStats(options = {})", "source": { "line": 713, "path": "src/state/HeliosStateManager.js" }, "summary": "Read or set the debug stats setting." } ], "name": "HeliosStateManager", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class HeliosStateManager extends EventTarget {", "source": { "line": 179, "path": "src/state/HeliosStateManager.js" }, "summary": "Central live state graph for Helios defaults, bindings, overrides, and reset status." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "manager", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(manager, options = {})", "source": { "line": 800, "path": "src/state/HeliosStateManager.js" }, "summary": "" }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "set", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `set`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "New set value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "set(key, value, options = {})", "source": { "line": 806, "path": "src/state/HeliosStateManager.js" }, "summary": "Set the set setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "reset", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `reset`.", "name": "keyOrPrefix", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "reset(keyOrPrefix, options = {})", "source": { "line": 812, "path": "src/state/HeliosStateManager.js" }, "summary": "Updates the reset state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "result", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "result()", "source": { "line": 816, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads result." } ], "name": "StateTransaction", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class StateTransaction {", "source": { "line": 799, "path": "src/state/HeliosStateManager.js" }, "summary": "Helper passed to `HeliosStateManager.transaction()` for grouped state writes." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `constructor`.", "name": "manager", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(manager)", "source": { "line": 832, "path": "src/state/HeliosStateManager.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "bind", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `bind`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `bind`.", "name": "entry", "type": "" }, { "attributes": "optional", "default": "null", "description": "Value passed to `bind`.", "name": "owner", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "bind(key, entry, owner = null)", "source": { "line": 839, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads bind." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "apply", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `apply`.", "name": "key", "type": "" }, { "attributes": "", "default": "", "description": "New apply value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "apply(key, value, options = {})", "source": { "line": 897, "path": "src/state/HeliosStateManager.js" }, "summary": "Updates the apply state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "unbind", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `unbind`.", "name": "key", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "unbind(key)", "source": { "line": 914, "path": "src/state/HeliosStateManager.js" }, "summary": "Configures or reads unbind." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "destroy()", "source": { "line": 921, "path": "src/state/HeliosStateManager.js" }, "summary": "Manages destroy for the current instance." } ], "name": "StateBindingController", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class StateBindingController {", "source": { "line": 831, "path": "src/state/HeliosStateManager.js" }, "summary": "Binding controller that keeps registered state entries synchronized with runtime owners." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 495, "path": "src/storage/HeliosStorageManager.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "key", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `key`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "key(id)", "source": { "line": 503, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads key." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "networkDataRecordId", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `networkDataRecordId`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "networkDataRecordId(id)", "source": { "line": 507, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads network data record id." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "positionDataRecordId", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `positionDataRecordId`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "positionDataRecordId(id)", "source": { "line": 511, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads position data record id." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "unfinishedSessionKeyFor", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `unfinishedSessionKeyFor`.", "name": "workspaceId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "unfinishedSessionKeyFor(workspaceId = null)", "source": { "line": 515, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads unfinished session key for." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "put", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `put`.", "name": "record", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async put(record)", "source": { "line": 624, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads put." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "get", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `get`.", "name": "id", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async get(id, options = {})", "source": { "line": 641, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current get value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getAll", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getAll()", "source": { "line": 686, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current all value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "delete", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `delete`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async delete(id)", "source": { "line": 708, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads delete." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getUnfinishedSessionId", "parameters": [ { "attributes": "optional", "default": "null", "description": "Value passed to `getUnfinishedSessionId`.", "name": "workspaceId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getUnfinishedSessionId(workspaceId = null)", "source": { "line": 721, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current unfinished session id value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setUnfinishedSessionId", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setUnfinishedSessionId`.", "name": "id", "type": "" }, { "attributes": "optional", "default": "null", "description": "Value passed to `setUnfinishedSessionId`.", "name": "workspaceId", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async setUnfinishedSessionId(id, workspaceId = null)", "source": { "line": 727, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Set the unfinished session id setting." } ], "name": "SessionStore", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class SessionStore {", "source": { "line": 494, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Low-level session record store used by Helios storage managers." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 744, "path": "src/storage/HeliosStorageManager.js" }, "summary": "" }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getUnfinishedSessionId", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getUnfinishedSessionId()", "source": { "line": 825, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current unfinished session id value or state." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setUnfinishedSessionId", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setUnfinishedSessionId`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async setUnfinishedSessionId(id)", "source": { "line": 829, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Set the unfinished session id setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setOverrideTrackingReady", "parameters": [ { "attributes": "optional", "default": "true", "description": "Value passed to `setOverrideTrackingReady`.", "name": "ready", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setOverrideTrackingReady(ready = true)", "source": { "line": 833, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Set the override tracking ready setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "configure", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "configure(options = {})", "source": { "line": 944, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the configure setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getPreferences", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "getPreferences()", "source": { "line": 999, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current preferences value or state." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "loadPreferences", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async loadPreferences()", "source": { "line": 1011, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Handles preferences for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "updatePreferences", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `updatePreferences`.", "name": "patch", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async updatePreferences(patch = {})", "source": { "line": 1015, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads update preferences." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "markNetworkDirty", "parameters": [ { "attributes": "optional", "default": "'network-change'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "markNetworkDirty(reason = 'network-change')", "source": { "line": 1043, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads mark network dirty." }, { "category": "Layout And Positions", "examples": [], "kind": "method", "methods": [], "name": "markPositionsDirty", "parameters": [ { "attributes": "optional", "default": "'positions-change'", "description": "Reason for this operation.", "name": "reason", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "markPositionsDirty(reason = 'positions-change')", "source": { "line": 1067, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads mark positions dirty." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setSessionNickname", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setSessionNickname`.", "name": "nickname", "type": "" }, { "attributes": "optional", "default": "this.sessionId", "description": "Value passed to `setSessionNickname`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async setSessionNickname(nickname, id = this.sessionId)", "source": { "line": 1097, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Set the session nickname setting." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "pendingStateChangeCount", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "pendingStateChangeCount()", "source": { "line": 1550, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads pending state change count." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "hasPendingStateChanges", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "hasPendingStateChanges()", "source": { "line": 1554, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current pending state changes value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "acknowledgeSavedSnapshot", "parameters": [ { "attributes": "optional", "default": "'save-acknowledged'", "description": "Reason for this operation.", "name": "reason", "type": "string" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "acknowledgeSavedSnapshot(reason = 'save-acknowledged', options = {})", "source": { "line": 1558, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads acknowledge saved snapshot." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "debugStats", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "debugStats(options = {})", "source": { "line": 1825, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the debug stats setting." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "recordPortableState", "parameters": [ { "attributes": "", "default": "", "description": "Filesystem path to read from or write to.", "name": "path", "type": "" }, { "attributes": "", "default": "", "description": "New record portable state value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "recordPortableState(path, value, options = {})", "source": { "line": 1883, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads record portable state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "status", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "status()", "source": { "line": 1892, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads status." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "persistenceStatus", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "persistenceStatus()", "source": { "line": 1896, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads persistence status." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "serializeSnapshot(options = {})", "source": { "line": 1932, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the serialize snapshot setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeSessionSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async serializeSessionSnapshot(options = {})", "source": { "line": 2136, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the serialize session snapshot setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "deserializeSessionSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `deserializeSessionSnapshot`.", "name": "snapshot", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "deserializeSessionSnapshot(snapshot = {})", "source": { "line": 2272, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads deserialize session snapshot." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "captureSessionThumbnail", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async captureSessionThumbnail(options = {})", "source": { "line": 2276, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the capture session thumbnail setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "saveSessionSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async saveSessionSnapshot(options = {})", "source": { "line": 2317, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the save session snapshot setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreSessionSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restoreSessionSnapshot`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async restoreSessionSnapshot(snapshot = {}, options = {})", "source": { "line": 2360, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Updates the session snapshot state on the current instance." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "serializeNetworkSnapshot", "parameters": [ { "attributes": "optional", "default": "", "description": "Snapshot options forwarded to Helios.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Visualization-state envelope.", "type": "Promise" }, "signature": "async serializeNetworkSnapshot(options = {})", "source": { "line": 2456, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Serialize a visualization envelope suitable for attachment to a portable network export. The envelope includes the current `storageState` snapshot." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "attachVisualizationStateToNetwork", "parameters": [ { "attributes": "optional", "default": "null", "description": "Existing visualization envelope, or\n`null` to capture one through storage.", "name": "snapshot", "type": "Object|null" }, { "attributes": "optional", "default": "", "description": "Attachment options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "The underlying Helios attachment result.", "type": "Promise" }, "signature": "async attachVisualizationStateToNetwork(snapshot = null, options = {})", "source": { "line": 2492, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Attach a visualization-state envelope to the active network." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "saveNetworkSnapshot", "parameters": [ { "attributes": "optional", "default": "'zxnet'", "description": "Portable network format.", "name": "format", "type": "string" }, { "attributes": "optional", "default": "", "description": "Save options forwarded to Helios.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Serialized network payload.", "type": "Promise" }, "signature": "async saveNetworkSnapshot(format = 'zxnet', options = {})", "source": { "line": 2507, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Save the active network with visualization state attached." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreNetworkSnapshot", "parameters": [ { "attributes": "", "default": "", "description": "Network payload or file-like source.", "name": "source", "type": "unknown" }, { "attributes": "optional", "default": "", "description": "Restore options forwarded to Helios.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Loaded network result.", "type": "Promise" }, "signature": "async restoreNetworkSnapshot(source, options = {})", "source": { "line": 2525, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Restore a portable network snapshot through Helios network loading." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreSnapshot", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Value passed to `restoreSnapshot`.", "name": "snapshot", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "restoreSnapshot(snapshot = {}, options = {})", "source": { "line": 2533, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Updates the snapshot state on the current instance." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "loadSession", "parameters": [ { "attributes": "optional", "default": "this.sessionId", "description": "Value passed to `loadSession`.", "name": "sessionId", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async loadSession(sessionId = this.sessionId, options = {})", "source": { "line": 2551, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Handles session for the current graph or visualization state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "configureSession", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "configureSession(options = {})", "source": { "line": 2583, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the configure session setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreActiveSession", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async restoreActiveSession(options = {})", "source": { "line": 2627, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the restore active session setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "startNewSession", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async startNewSession(options = {})", "source": { "line": 2668, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the start new session setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "flushPreviousSessionForSwitch", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async flushPreviousSessionForSwitch(options = {})", "source": { "line": 2704, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the flush previous session for switch setting." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "saveSession", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async saveSession(options = {})", "source": { "line": 2771, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the save session setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getSession", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `getSession`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getSession(id)", "source": { "line": 2780, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Returns the current session value or state." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "listSessions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async listSessions(options = {})", "source": { "line": 2787, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the list sessions setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "listSessionSummaries", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async listSessionSummaries(options = {})", "source": { "line": 2810, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the list session summaries setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getResumeSessions", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getResumeSessions(options = {})", "source": { "line": 2817, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the get resume sessions setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "getResumePrompt", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async getResumePrompt(options = {})", "source": { "line": 2846, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the get resume prompt setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "resumeSession", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `resumeSession`.", "name": "sessionId", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async resumeSession(sessionId, options = {})", "source": { "line": 2862, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads resume session." }, { "category": "Network And Persistence", "examples": [], "kind": "method", "methods": [], "name": "restoreSession", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `restoreSession`.", "name": "sessionIdOrRecord", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async restoreSession(sessionIdOrRecord, options = {})", "source": { "line": 2867, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Updates the session state on the current instance." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "deleteSession", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `deleteSession`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async deleteSession(id)", "source": { "line": 2874, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads delete session." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "markSessionFinished", "parameters": [ { "attributes": "optional", "default": "this.sessionId", "description": "Value passed to `markSessionFinished`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async markSessionFinished(id = this.sessionId)", "source": { "line": 2885, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Configures or reads mark session finished." }, { "category": "Filtering And State", "examples": [], "kind": "method", "methods": [], "name": "restorePortableStateFromNetwork", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async restorePortableStateFromNetwork(options = {})", "source": { "line": 2899, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the restore portable state from network setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "flush", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async flush(options = {})", "source": { "line": 2910, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the flush setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "sync", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async sync(options = {})", "source": { "line": 2948, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the sync setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "flushAutosync", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "async flushAutosync(options = {})", "source": { "line": 2952, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Read or set the flush autosync setting." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "destroy()", "source": { "line": 2975, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Manages destroy for the current instance." } ], "name": "HeliosStorageManager", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class HeliosStorageManager extends EventTarget {", "source": { "line": 743, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Base storage facade for Helios state snapshots, sessions, and portable network state." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 2996, "path": "src/storage/HeliosStorageManager.js" }, "summary": "" } ], "name": "DummyStorageManager", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class DummyStorageManager extends HeliosStorageManager {", "source": { "line": 2995, "path": "src/storage/HeliosStorageManager.js" }, "summary": "In-memory storage facade used when durable persistence is disabled." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 3015, "path": "src/storage/HeliosStorageManager.js" }, "summary": "" } ], "name": "BrowserStorageManager", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class BrowserStorageManager extends HeliosStorageManager {", "source": { "line": 3014, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Browser storage manager backed by IndexedDB and Web Storage fallbacks." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 3042, "path": "src/storage/HeliosStorageManager.js" }, "summary": "" } ], "name": "RemoteStorageManager", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class RemoteStorageManager extends HeliosStorageManager {", "source": { "line": 3041, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Storage manager that delegates session records to a host-provided client." }, { "category": "Persistence", "examples": [], "kind": "function", "methods": [], "name": "createHeliosStorageManager", "parameters": [ { "attributes": "optional", "default": "undefined", "description": "Value passed to `createHeliosStorageManager`.", "name": "config", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Value passed to `createHeliosStorageManager`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export function createHeliosStorageManager(config = undefined, context = {}) {", "source": { "line": 3073, "path": "src/storage/HeliosStorageManager.js" }, "summary": "Create the storage manager selected by a Helios `storage` constructor option." }, { "category": "Internal", "examples": [ "const ui = new HeliosUI({ helios, theme: 'dark' });" ], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 342, "path": "src/ui/HeliosUI.js" }, "summary": "" }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "registerStateControl", "parameters": [ { "attributes": "", "default": "", "description": "Persistent state path.", "name": "path", "type": "string" }, { "attributes": "optional", "default": "", "description": "State metadata and UI-control hints.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Cleanup function returned by the state manager, or `null` when state tracking is unavailable.", "type": "Function|null" }, "signature": "registerStateControl(path, options = {})", "source": { "line": 482, "path": "src/ui/HeliosUI.js" }, "summary": "Register a UI-owned value with the Helios state manager." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "writeStateControl", "parameters": [ { "attributes": "", "default": "", "description": "Persistent state path.", "name": "path", "type": "string" }, { "attributes": "", "default": "", "description": "Value to store.", "name": "value", "type": "*" }, { "attributes": "optional", "default": "", "description": "Persistence, debounce, source, and override-tracking options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "State-manager write result, or `null` when state tracking is unavailable.", "type": "*|null" }, "signature": "writeStateControl(path, value, options = {})", "source": { "line": 525, "path": "src/ui/HeliosUI.js" }, "summary": "Write a UI control value through the Helios state manager." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createStateIndicator", "parameters": [ { "attributes": "optional", "default": "''", "description": "State path to observe.", "name": "path", "type": "string" }, { "attributes": "optional", "default": "null", "description": "Indicator scope override.", "name": "scope", "type": "string|null" }, { "attributes": "optional", "default": "", "description": "Registration and tooltip options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Indicator element, or `null` when indicators are disabled.", "type": "HTMLElement|null" }, "signature": "createStateIndicator(path = '', scope = null, options = {})", "source": { "line": 563, "path": "src/ui/HeliosUI.js" }, "summary": "Create a dirty/default indicator for a state path or state scope." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "setTheme", "parameters": [ { "attributes": "", "default": "", "description": "Theme name stored on the UI container.", "name": "theme", "type": "'dark'|'light'|string" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "setTheme(theme, options = {})", "source": { "line": 621, "path": "src/ui/HeliosUI.js" }, "summary": "Apply a UI theme." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "toggleTheme", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "toggleTheme(options = {})", "source": { "line": 635, "path": "src/ui/HeliosUI.js" }, "summary": "Toggle between the built-in dark and light themes." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "serializeState", "parameters": [], "remarks": "", "returns": { "description": "Serializable UI state snapshot.", "type": "Object" }, "signature": "serializeState()", "source": { "line": 650, "path": "src/ui/HeliosUI.js" }, "summary": "Serialize UI panel, dock, theme, and responsive-interface state." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "restoreState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Snapshot returned by `serializeState()`.", "name": "state", "type": "Object" } ], "remarks": "", "returns": { "description": "This UI instance.", "type": "HeliosUI" }, "signature": "restoreState(state = {})", "source": { "line": 669, "path": "src/ui/HeliosUI.js" }, "summary": "Restore a UI state snapshot." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "getViewportWidth", "parameters": [], "remarks": "", "returns": { "description": "Width in CSS pixels, or zero when unavailable.", "type": "number" }, "signature": "getViewportWidth()", "source": { "line": 687, "path": "src/ui/HeliosUI.js" }, "summary": "Resolve the best available viewport width for responsive UI behavior." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "applyInterfaceBehaviorState", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Interface behavior snapshot.", "name": "state", "type": "Object" } ], "remarks": "", "returns": { "description": "This UI instance.", "type": "HeliosUI" }, "signature": "applyInterfaceBehaviorState(state = {})", "source": { "line": 711, "path": "src/ui/HeliosUI.js" }, "summary": "Apply responsive interface state to the UI container and panel manager." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "bindHeliosAccessor", "parameters": [ { "attributes": "", "default": "", "description": "Name of the Helios getter/setter method.", "name": "accessorName", "type": "string" }, { "attributes": "optional", "default": "", "description": "Attribute metadata, range, persistence, and labeling options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Attribute wrapper suitable for controls and panels.", "type": "UIAttribute" }, "signature": "bindHeliosAccessor(accessorName, options = {})", "source": { "line": 1350, "path": "src/ui/HeliosUI.js" }, "summary": "Bind a Helios accessor method to a UIAttribute." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "bindBehaviorAccessor", "parameters": [ { "attributes": "", "default": "", "description": "Behavior instance that owns the accessor.", "name": "behavior", "type": "Behavior" }, { "attributes": "", "default": "", "description": "Name of the behavior getter/setter method.", "name": "accessorName", "type": "string" }, { "attributes": "optional", "default": "", "description": "Attribute metadata, range, persistence, and labeling options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Attribute wrapper suitable for controls and panels.", "type": "UIAttribute" }, "signature": "bindBehaviorAccessor(behavior, accessorName, options = {})", "source": { "line": 1419, "path": "src/ui/HeliosUI.js" }, "summary": "Bind a behavior accessor method to a UIAttribute." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createPanel", "parameters": [ { "attributes": "", "default": "", "description": "Panel id, title, placement, content, schema, and persistence options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Panel instance returned by the panel manager.", "type": "Panel" }, "signature": "createPanel(options)", "source": { "line": 1542, "path": "src/ui/HeliosUI.js" }, "summary": "Create a standard Helios UI panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createTabbedPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel and tab options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createTabbedPanel(options = {})", "source": { "line": 1579, "path": "src/ui/HeliosUI.js" }, "summary": "Create a panel whose content is managed by a tabbed panel primitive." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createDemoPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and title options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createDemoPanel(options = {})", "source": { "line": 1607, "path": "src/ui/HeliosUI.js" }, "summary": "Create the default scene/demo controls panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createFilterPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement, throttling, width, and initial filter options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createFilterPanel(options = {})", "source": { "line": 4352, "path": "src/ui/HeliosUI.js" }, "summary": "Create the graph filtering panel with node and edge rule editors." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createMetricsPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and collapsed-state options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createMetricsPanel(options = {})", "source": { "line": 4616, "path": "src/ui/HeliosUI.js" }, "summary": "Create a metrics panel for basic graph and renderer counters." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createDebugPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and refresh-window options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createDebugPanel(options = {})", "source": { "line": 7104, "path": "src/ui/HeliosUI.js" }, "summary": "Create a debug panel for persistence and state-manager counters." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "void" }, "signature": "destroy()", "source": { "line": 7181, "path": "src/ui/HeliosUI.js" }, "summary": "Dispose all UI controls, panels, listeners, timers, and container resources." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createMappersPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and mapper panel options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createMappersPanel(options = {})", "source": { "line": 7206, "path": "src/ui/HeliosUI.js" }, "summary": "Create the visual mapper configuration panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createLayoutPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and layout panel options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createLayoutPanel(options = {})", "source": { "line": 9223, "path": "src/ui/HeliosUI.js" }, "summary": "Create the layout controls panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createLegendsPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and legend panel options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createLegendsPanel(options = {})", "source": { "line": 9235, "path": "src/ui/HeliosUI.js" }, "summary": "Create the legends controls panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createCameraPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and camera panel options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createCameraPanel(options = {})", "source": { "line": 9247, "path": "src/ui/HeliosUI.js" }, "summary": "Create the camera controls panel." }, { "category": "User Interface", "examples": [], "kind": "method", "methods": [], "name": "createSelectionPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel placement and selection panel options.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "Created panel instance.", "type": "Panel" }, "signature": "createSelectionPanel(options = {})", "source": { "line": 9259, "path": "src/ui/HeliosUI.js" }, "summary": "Create the selection and hover controls panel." } ], "name": "HeliosUI", "parameters": [ { "attributes": "optional", "default": "", "description": "UI construction options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Helios instance to inspect and control.", "name": "options.helios", "type": "Helios" }, { "attributes": "optional", "default": "", "description": "Existing UI container. When omitted the UI creates or reuses a layer on the Helios root.", "name": "options.container", "type": "HTMLElement" }, { "attributes": "optional", "default": "'ui'", "description": "Layer name used when the UI attaches to the Helios layer manager.", "name": "options.layerName", "type": "string" }, { "attributes": "optional", "default": "", "description": "Initial UI theme.", "name": "options.theme", "type": "'dark'|'light'" }, { "attributes": "optional", "default": "'default'", "description": "Built-in style preset or external style mode.", "name": "options.styles", "type": "'default'|string" }, { "attributes": "optional", "default": "", "description": "Document used for custom elements and style installation.", "name": "options.document", "type": "Document" }, { "attributes": "optional", "default": "true", "description": "Enable dragging floating panels.", "name": "options.allowDrag", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Optional fixed label-column sizing for generated controls.", "name": "options.labelColumn", "type": "number|string" }, { "attributes": "optional", "default": "", "description": "Show dirty/default markers when persistent storage supports them.", "name": "options.persistenceIndicators", "type": "boolean" }, { "attributes": "optional", "default": "", "description": "Interface behavior options passed to `helios.useBehavior('interface', ...)`.", "name": "options.interface", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Behavior option bag used by built-in UI behaviors.", "name": "options.behaviors", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class HeliosUI {", "source": { "line": 341, "path": "src/ui/HeliosUI.js" }, "summary": "Optional built-in control surface for a Helios visualization." }, { "category": "Internal", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 30, "path": "src/ui/panels/PanelStack.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "add", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "add(options)", "source": { "line": 38, "path": "src/ui/panels/PanelStack.js" }, "summary": "Read or set the add setting." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setStatus", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setStatus`.", "name": "id", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `setStatus`.", "name": "status", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setStatus(id, status)", "source": { "line": 108, "path": "src/ui/panels/PanelStack.js" }, "summary": "Set the status setting." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "destroy()", "source": { "line": 116, "path": "src/ui/panels/PanelStack.js" }, "summary": "Manages destroy for the current instance." } ], "name": "PanelStack", "parameters": [ { "attributes": "optional", "default": "", "description": "Stack options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Initial panel items.", "name": "options.items", "type": "Array." } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class PanelStack {", "source": { "line": 29, "path": "src/ui/panels/PanelStack.js" }, "summary": "Collapsible stack of UI subpanels used by the optional Helios UI." }, { "category": "Internal", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options = {})", "source": { "line": 25, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "addTab", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `addTab`.", "name": "tab", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "addTab(tab)", "source": { "line": 57, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "Manages tab for the current instance." }, { "category": "Configuration", "examples": [], "kind": "method", "methods": [], "name": "setActive", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `setActive`.", "name": "id", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "setActive(id)", "source": { "line": 79, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "Set the active setting." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "activeId", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "activeId()", "source": { "line": 96, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "Configures or reads active id." }, { "category": "Lifecycle", "examples": [], "kind": "method", "methods": [], "name": "destroy", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "destroy()", "source": { "line": 100, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "Manages destroy for the current instance." } ], "name": "TabbedPanel", "parameters": [ { "attributes": "optional", "default": "", "description": "Tab panel options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Initial tabs.", "name": "options.tabs", "type": "Array." }, { "attributes": "optional", "default": "", "description": "Initially active tab id.", "name": "options.activeId", "type": "string" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class TabbedPanel {", "source": { "line": 24, "path": "src/ui/panels/TabbedPanel.js" }, "summary": "Small tabbed panel primitive used by the optional Helios UI." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "humanizeControlLabel", "parameters": [ { "attributes": "", "default": "", "description": "State key, control id, or raw label value.", "name": "value", "type": "string" } ], "remarks": "", "returns": { "description": "Human-readable control label.", "type": "string" }, "signature": "export function humanizeControlLabel(value) {", "source": { "line": 34, "path": "src/ui/panels/panelSchema.js" }, "summary": "Convert a state key or control identifier into a display label." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "resolvePanelItemLabel", "parameters": [ { "attributes": "", "default": "", "description": "Panel schema item descriptor.", "name": "item", "type": "string|Object" }, { "attributes": "optional", "default": "", "description": "Optional state manager for state entry labels.", "name": "stateManager", "type": "HeliosStateManager|null" } ], "remarks": "", "returns": { "description": "Display label for the item.", "type": "string" }, "signature": "export function resolvePanelItemLabel(item, stateManager = null) {", "source": { "line": 92, "path": "src/ui/panels/panelSchema.js" }, "summary": "Resolve the display label for a panel schema item." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "normalizePanelSchema", "parameters": [ { "attributes": "optional", "default": "", "description": "Partial panel schema.", "name": "schema", "type": "Object" } ], "remarks": "", "returns": { "description": "Normalized panel schema.", "type": "Object" }, "signature": "export function normalizePanelSchema(schema = {}) {", "source": { "line": 112, "path": "src/ui/panels/panelSchema.js" }, "summary": "Normalize a panel schema into the canonical shape used by Helios UI panels." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "panelSchemaKeys", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel schema to inspect.", "name": "schema", "type": "Object" } ], "remarks": "", "returns": { "description": "Unique state keys referenced by the schema.", "type": "string[]" }, "signature": "export function panelSchemaKeys(schema = {}) {", "source": { "line": 133, "path": "src/ui/panels/panelSchema.js" }, "summary": "Return all state keys referenced by a panel schema." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "panelSchemaStatus", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel schema to inspect.", "name": "schema", "type": "Object" }, { "attributes": "optional", "default": "", "description": "State manager that tracks override status.", "name": "stateManager", "type": "HeliosStateManager|null" } ], "remarks": "", "returns": { "description": "Panel-level and section-level status values.", "type": "Object" }, "signature": "export function panelSchemaStatus(schema = {}, stateManager = null) {", "source": { "line": 150, "path": "src/ui/panels/panelSchema.js" }, "summary": "Compute the dirty status for a full panel schema." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "panelSchemaSectionKeys", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel schema to inspect.", "name": "schema", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Section id to inspect.", "name": "sectionId", "type": "string" } ], "remarks": "", "returns": { "description": "Unique state keys referenced by the section.", "type": "string[]" }, "signature": "export function panelSchemaSectionKeys(schema = {}, sectionId = '') {", "source": { "line": 187, "path": "src/ui/panels/panelSchema.js" }, "summary": "Return all state keys referenced by one panel schema section." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "panelSchemaSectionStatus", "parameters": [ { "attributes": "optional", "default": "", "description": "Panel schema to inspect.", "name": "schema", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Section id to inspect.", "name": "sectionId", "type": "string" }, { "attributes": "optional", "default": "", "description": "State manager that tracks override status.", "name": "stateManager", "type": "HeliosStateManager|null" } ], "remarks": "", "returns": { "description": "Section status: `default`, `partial`, or `changed`.", "type": "string" }, "signature": "export function panelSchemaSectionStatus(schema = {}, sectionId = '', stateManager = null) {", "source": { "line": 206, "path": "src/ui/panels/panelSchema.js" }, "summary": "Compute the dirty status for one panel schema section." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "createPanelSchemaIndicator", "parameters": [ { "attributes": "optional", "default": "", "description": "Indicator options.", "name": "options", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Helios instance whose state manager is observed.", "name": "options.helios", "type": "Helios" }, { "attributes": "optional", "default": "", "description": "Panel schema to observe.", "name": "options.schema", "type": "Object" }, { "attributes": "optional", "default": "", "description": "Optional section id to observe.", "name": "options.sectionId", "type": "string|null" }, { "attributes": "optional", "default": "", "description": "Optional tooltip hook.", "name": "options.attachTooltip", "type": "Function|null" } ], "remarks": "", "returns": { "description": "Indicator element with a `destroy()` cleanup method.", "type": "HTMLElement" }, "signature": "export function createPanelSchemaIndicator({", "source": { "line": 223, "path": "src/ui/panels/panelSchema.js" }, "summary": "Create a DOM indicator that reflects dirty status for a panel schema." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "SCENE_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const SCENE_PANEL_SCHEMA = Object.freeze({", "source": { "line": 270, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Scene panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "LABELS_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const LABELS_PANEL_SCHEMA = Object.freeze({", "source": { "line": 368, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Labels panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "LEGENDS_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const LEGENDS_PANEL_SCHEMA = Object.freeze({", "source": { "line": 414, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Legends panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "MAPPERS_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const MAPPERS_PANEL_SCHEMA = Object.freeze({", "source": { "line": 458, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Mappers panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "FILTERS_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const FILTERS_PANEL_SCHEMA = Object.freeze({", "source": { "line": 494, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Filters panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "LAYOUT_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const LAYOUT_PANEL_SCHEMA = Object.freeze({", "source": { "line": 530, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Layout panel." }, { "category": "Internal", "examples": [], "kind": "symbol", "methods": [], "name": "SELECTION_PANEL_SCHEMA", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export const SELECTION_PANEL_SCHEMA = Object.freeze({", "source": { "line": 558, "path": "src/ui/panels/panelSchema.js" }, "summary": "Built-in state schema for the Selection panel." }, { "category": "Persistence", "examples": [], "kind": "class", "methods": [ { "category": "Construction", "examples": [], "kind": "constructor", "methods": [], "name": "constructor", "parameters": [ { "attributes": "", "default": "", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "constructor(options)", "source": { "line": 27, "path": "src/ui/state/UIAttribute.js" }, "summary": "" }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "value", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "value()", "source": { "line": 49, "path": "src/ui/state/UIAttribute.js" }, "summary": "Configures or reads value." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "write", "parameters": [ { "attributes": "", "default": "", "description": "New write value. Omit this argument to read the current value.", "name": "value", "type": "" }, { "attributes": "", "default": "", "description": "Value passed to `write`.", "name": "context", "type": "" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "write(value, context)", "source": { "line": 53, "path": "src/ui/state/UIAttribute.js" }, "summary": "Configures or reads write." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "notify", "parameters": [], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "notify()", "source": { "line": 59, "path": "src/ui/state/UIAttribute.js" }, "summary": "Configures or reads notify." }, { "category": "Utilities", "examples": [], "kind": "method", "methods": [], "name": "subscribe", "parameters": [ { "attributes": "", "default": "", "description": "Value passed to `subscribe`.", "name": "listener", "type": "" }, { "attributes": "optional", "default": "{}", "description": "Options object for this operation.", "name": "options", "type": "Object" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "subscribe(listener, options = {})", "source": { "line": 69, "path": "src/ui/state/UIAttribute.js" }, "summary": "Configures or reads subscribe." } ], "name": "UIAttribute", "parameters": [ { "attributes": "", "default": "", "description": "Attribute descriptor.", "name": "options", "type": "Object" }, { "attributes": "", "default": "", "description": "Stable attribute id.", "name": "options.id", "type": "string" }, { "attributes": "", "default": "", "description": "Read callback.", "name": "options.get", "type": "Function" }, { "attributes": "optional", "default": "", "description": "Write callback.", "name": "options.set", "type": "Function" } ], "remarks": "", "returns": { "description": "", "type": "" }, "signature": "export class UIAttribute {", "source": { "line": 26, "path": "src/ui/state/UIAttribute.js" }, "summary": "Observable UI attribute descriptor used to bind controls to Helios state." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "ensureDefaultStyles", "parameters": [ { "attributes": "optional", "default": "document", "description": "Target document.", "name": "doc", "type": "Document" } ], "remarks": "", "returns": { "description": "Existing or inserted stylesheet element.", "type": "HTMLStyleElement|null" }, "signature": "export function ensureDefaultStyles(doc = document) {", "source": { "line": 2947, "path": "src/ui/style/defaultStyles.js" }, "summary": "Ensure the default Helios UI stylesheet is present in a document." }, { "category": "Internal", "examples": [], "kind": "function", "methods": [], "name": "defineHeliosWebComponents", "parameters": [ { "attributes": "optional", "default": "document", "description": "Registration target.", "name": "docOrWin", "type": "Document|Window" } ], "remarks": "", "returns": { "description": "Registration result.", "type": "{defined:Array,supported:boolean}" }, "signature": "export function defineHeliosWebComponents(docOrWin = document) {", "source": { "line": 11, "path": "src/ui/web-components/defineHeliosWebComponents.js" }, "summary": "Register Helios Web custom elements in a document or window." } ], "title": "Helios Web", "version": "0.10.5" } }, "schemaVersion": "1.0.0" }