@graphty/graphty-element / jsx / GraphtyElementJSXProps
Interface: GraphtyElementJSXProps ​
Defined in: graphty-element/jsx.ts:30
Every property, attribute and event listener <graphty-element> accepts in JSX, besides the ordinary HTML attributes.
Properties ​
acceleration? ​
optionalacceleration?:AccelerationPolicy
Defined in: graphty-element/jsx.ts:176
Sets the acceleration policy and applies it immediately.
An unrecognised value is reported and then ignored, leaving the previous policy in force. It is not thrown. Lit drives this setter from attributeChangedCallback, so a throw here would abort attribute processing and leave the element unrendered -- a typo in markup would take the whole graph down. HTML has never behaved that way about an attribute value, and an embedded component must not be the first thing that does.
The report is deliberately loud, because the quiet failure is the dangerous one: a page that meant required and wrote requried would otherwise run on the CPU and look healthy.
acceleration-min-nodes? ​
optionalacceleration-min-nodes?:string
Defined in: graphty-element/jsx.ts:294
Sets the threshold and applies it immediately.
A value that is not a whole number of 0 or more is reported and then ignored, leaving the previous threshold in force, for the reason the acceleration setter states: Lit drives this from attributeChangedCallback, and a throw there would leave the element unrendered.
accelerationMinNodes? ​
optionalaccelerationMinNodes?:number
Defined in: graphty-element/jsx.ts:192
Sets the threshold and applies it immediately.
A value that is not a whole number of 0 or more is reported and then ignored, leaving the previous threshold in force, for the reason the acceleration setter states: Lit drives this from attributeChangedCallback, and a throw there would leave the element unrendered.
algorithmsOnLoad? ​
optionalalgorithmsOnLoad?: readonly (string| {algorithm:string;as?:string;params?:Record<string,unknown>;seed?:number;style?:boolean| {size?:boolean| readonly [number,number]; }; })[]
Defined in: graphty-element/jsx.ts:120
Sets which algorithms run once data has finished loading.
auto-frame? ​
optionalauto-frame?:boolean
Defined in: graphty-element/jsx.ts:274
Switches the camera's own framing on or off.
autoFrame? ​
optionalautoFrame?:boolean
Defined in: graphty-element/jsx.ts:146
Switches the camera's own framing on or off.
background? ​
optionalbackground?: {backgroundType:"color";color:string|undefined; } | {backgroundType:"skybox";data:string; }
Defined in: graphty-element/jsx.ts:138
Sets the graph background. Applies it to the scene immediately.
A value the schema refuses is REPORTED AND DROPPED rather than thrown, on the same terms as acceleration: this setter is reached from attributeChangedCallback, and a throw there escapes as an unhandled rejection that reaches nobody, leaving the page with an element that never rendered. A wrong colour in markup must not take the graph down.
data-source? ​
optionaldata-source?:string
Defined in: graphty-element/jsx.ts:206
Sets the data source type. Loads the graph from it, replacing what the graph held, once the configuration is set too.
data-source-config? ​
optionaldata-source-config?:string
Defined in: graphty-element/jsx.ts:211
Sets the data source configuration. Loads the graph from it, replacing what the graph held, once the type is set too.
dataSource? ​
optionaldataSource?:string
Defined in: graphty-element/jsx.ts:44
Sets the data source type. Loads the graph from it, replacing what the graph held, once the configuration is set too.
dataSourceConfig? ​
optionaldataSourceConfig?:Record<string,unknown>
Defined in: graphty-element/jsx.ts:49
Sets the data source configuration. Loads the graph from it, replacing what the graph held, once the type is set too.
directed? ​
optionaldirected?:boolean|"auto"
Defined in: graphty-element/jsx.ts:85
Sets whether the graph is read as directed. Updates graph configuration.
edge-data? ​
optionaledge-data?:string
Defined in: graphty-element/jsx.ts:201
Replaces the graph's edges with these, as one undoable step.
edge-dst-id-path? ​
optionaledge-dst-id-path?:string
Defined in: graphty-element/jsx.ts:223
Sets the JMESPath for edge destination ID extraction. Updates graph configuration.
edge-id-path? ​
optionaledge-id-path?:string
Defined in: graphty-element/jsx.ts:227
Sets the JMESPath for edge identity. Updates graph configuration.
edge-src-id-path? ​
optionaledge-src-id-path?:string
Defined in: graphty-element/jsx.ts:219
Sets the JMESPath for edge source ID extraction. Updates graph configuration.
edge-weight-path? ​
optionaledge-weight-path?:string
Defined in: graphty-element/jsx.ts:239
Sets the JMESPath for an edge's weight. Updates graph configuration.
edgeData? ​
optionaledgeData?:Record<string,unknown>[]
Defined in: graphty-element/jsx.ts:39
Replaces the graph's edges with these, as one undoable step.
edgeDstIdPath? ​
optionaledgeDstIdPath?:string
Defined in: graphty-element/jsx.ts:61
Sets the JMESPath for edge destination ID extraction. Updates graph configuration.
edgeIdPath? ​
optionaledgeIdPath?:string
Defined in: graphty-element/jsx.ts:65
Sets the JMESPath for edge identity. Updates graph configuration.
edgeSrcIdPath? ​
optionaledgeSrcIdPath?:string
Defined in: graphty-element/jsx.ts:57
Sets the JMESPath for edge source ID extraction. Updates graph configuration.
edgeWeightPath? ​
optionaledgeWeightPath?:string
Defined in: graphty-element/jsx.ts:77
Sets the JMESPath for an edge's weight. Updates graph configuration.
enable-detailed-profiling? ​
optionalenable-detailed-profiling?:boolean
Defined in: graphty-element/jsx.ts:286
Sets detailed profiling mode. Enables hierarchical timing and advanced stats collection.
enableDetailedProfiling? ​
optionalenableDetailedProfiling?:boolean
Defined in: graphty-element/jsx.ts:158
Sets detailed profiling mode. Enables hierarchical timing and advanced stats collection.
history-keys? ​
optionalhistory-keys?:boolean
Defined in: graphty-element/jsx.ts:282
Turns the element's own undo keys on or off.
historyKeys? ​
optionalhistoryKeys?:boolean
Defined in: graphty-element/jsx.ts:154
Turns the element's own undo keys on or off.
label-declutter? ​
optionallabel-declutter?:boolean
Defined in: graphty-element/jsx.ts:257
Switches label decluttering on or off.
labelDeclutter? ​
optionallabelDeclutter?:boolean
Defined in: graphty-element/jsx.ts:112
Switches label decluttering on or off.
layout? ​
optionallayout?:string
Defined in: graphty-element/jsx.ts:91
Sets the layout algorithm: one undoable step, which undo takes back to the layout, the engine and the options before it. Assigned with layoutConfig in the same tick, the two are one step.
layout-2d? ​
optionallayout-2d?:boolean
Defined in: graphty-element/jsx.ts:266
Sets 2D mode (deprecated). Converts boolean to viewMode internally.
layout-config? ​
optionallayout-config?:string
Defined in: graphty-element/jsx.ts:247
Sets layout-specific configuration: the layout is drawn again with it, as one undoable step.
layout-scope? ​
optionallayout-scope?:string
Defined in: graphty-element/jsx.ts:253
Sets what the layout runs over, and restarts the running layout over it. A value that is not a scope is reported and dropped, never thrown: this setter is reached from attributeChangedCallback, where a throw would reach nobody.
layout2d? ​
optionallayout2d?:boolean
Defined in: graphty-element/jsx.ts:129
Sets 2D mode (deprecated). Converts boolean to viewMode internally.
layoutBehavior? ​
optionallayoutBehavior?:object
Defined in: graphty-element/jsx.ts:108
Sets how the element drives the layout.
A value the schema refuses is reported and dropped rather than thrown, on the same terms as background and acceleration.
fetchEdges? ​
optionalfetchEdges?:Function
fetchNodes? ​
optionalfetchNodes?:Function
labels? ​
optionallabels?:object=LabelBehaviorOpts
labels.declutter? ​
optionaldeclutter?:boolean
layout? ​
optionallayout?:object
layout.iterationsPerStep? ​
optionaliterationsPerStep?:number
layout.maxInFlight? ​
optionalmaxInFlight?:number
layout.minDelta? ​
optionalminDelta?:number
layout.preSteps? ​
optionalpreSteps?:number
layout.stepMultiplier? ​
optionalstepMultiplier?:number
layout.type? ​
optionaltype?:string
layout.zoomStepInterval? ​
optionalzoomStepInterval?:number
node? ​
optionalnode?:object=NodeBehaviorOpts
node.pinOnDrag? ​
optionalpinOnDrag?:boolean
layoutConfig? ​
optionallayoutConfig?:Record<string,unknown>
Defined in: graphty-element/jsx.ts:95
Sets layout-specific configuration: the layout is drawn again with it, as one undoable step.
layoutScope? ​
optionallayoutScope?:Scope
Defined in: graphty-element/jsx.ts:101
Sets what the layout runs over, and restarts the running layout over it. A value that is not a scope is reported and dropped, never thrown: this setter is reached from attributeChangedCallback, where a throw would reach nobody.
node-data? ​
optionalnode-data?:string
Defined in: graphty-element/jsx.ts:197
Replaces the graph's nodes with these, as one undoable step: a node the array names again keeps its row and its edges, and one it no longer names goes, with its edges.
node-id-path? ​
optionalnode-id-path?:string
Defined in: graphty-element/jsx.ts:215
Sets the JMESPath for node ID extraction. Updates graph configuration.
node-label-path? ​
optionalnode-label-path?:string
Defined in: graphty-element/jsx.ts:235
Sets the JMESPath for a node's display name. Updates graph configuration.
nodeData? ​
optionalnodeData?:Record<string,unknown>[]
Defined in: graphty-element/jsx.ts:35
Replaces the graph's nodes with these, as one undoable step: a node the array names again keeps its row and its edges, and one it no longer names goes, with its edges.
nodeIdPath? ​
optionalnodeIdPath?:string
Defined in: graphty-element/jsx.ts:53
Sets the JMESPath for node ID extraction. Updates graph configuration.
nodeLabelPath? ​
optionalnodeLabelPath?:string
Defined in: graphty-element/jsx.ts:73
Sets the JMESPath for a node's display name. Updates graph configuration.
onai-command-cancelled? ​
optionalonai-command-cancelled?: (event) =>void
Defined in: graphty-element/jsx.ts:298
Emitted when an AI command is cancelled
Parameters ​
event ​
CustomEvent<AiCommandCancelledEvent>
Returns ​
void
onai-command-complete? ​
optionalonai-command-complete?: (event) =>void
Defined in: graphty-element/jsx.ts:302
Emitted when an AI command completes successfully
Parameters ​
event ​
CustomEvent<AiCommandCompleteEvent>
Returns ​
void
onai-command-error? ​
optionalonai-command-error?: (event) =>void
Defined in: graphty-element/jsx.ts:306
Emitted when an AI command encounters an error
Parameters ​
event ​
CustomEvent<AiCommandErrorEvent>
Returns ​
void
onai-command-start? ​
optionalonai-command-start?: (event) =>void
Defined in: graphty-element/jsx.ts:310
Emitted when an AI command starts processing
Parameters ​
event ​
CustomEvent<AiCommandStartEvent>
Returns ​
void
onai-status-change? ​
optionalonai-status-change?: (event) =>void
Defined in: graphty-element/jsx.ts:314
Main event for UI binding - single source of truth for AI status
Parameters ​
event ​
CustomEvent<AiStatusChangeEvent>
Returns ​
void
onai-stream-chunk? ​
optionalonai-stream-chunk?: (event) =>void
Defined in: graphty-element/jsx.ts:318
Emitted during streaming when text chunks arrive (throttled)
Parameters ​
event ​
CustomEvent<AiStreamChunkEvent>
Returns ​
void
onai-stream-tool-call? ​
optionalonai-stream-tool-call?: (event) =>void
Defined in: graphty-element/jsx.ts:322
Emitted when the LLM makes a tool call
Parameters ​
event ​
CustomEvent<AiStreamToolCallEvent>
Returns ​
void
onai-stream-tool-result? ​
optionalonai-stream-tool-result?: (event) =>void
Defined in: graphty-element/jsx.ts:326
Emitted when a tool call completes
Parameters ​
event ​
CustomEvent<AiStreamToolResultEvent>
Returns ​
void
onai-voice-end? ​
optionalonai-voice-end?: (event) =>void
Defined in: graphty-element/jsx.ts:330
Emitted when voice input ends
Parameters ​
event ​
CustomEvent<AiVoiceEndEvent>
Returns ​
void
onai-voice-start? ​
optionalonai-voice-start?: (event) =>void
Defined in: graphty-element/jsx.ts:334
Emitted when voice input starts
Parameters ​
event ​
CustomEvent<AiVoiceStartEvent>
Returns ​
void
onai-voice-transcript? ​
optionalonai-voice-transcript?: (event) =>void
Defined in: graphty-element/jsx.ts:338
Emitted when voice transcript is available
Parameters ​
event ​
CustomEvent<AiVoiceTranscriptEvent>
Returns ​
void
onanimation-cancelled? ​
optionalonanimation-cancelled?: (event) =>void
Defined in: graphty-element/jsx.ts:339
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onanimation-progress? ​
optionalonanimation-progress?: (event) =>void
Defined in: graphty-element/jsx.ts:340
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
oncamera-state-changed? ​
optionaloncamera-state-changed?: (event) =>void
Defined in: graphty-element/jsx.ts:341
Parameters ​
event ​
CustomEvent<CameraStateChangedEvent>
Returns ​
void
ondata-added? ​
optionalondata-added?: (event) =>void
Defined in: graphty-element/jsx.ts:342
Parameters ​
event ​
CustomEvent<GraphDataAddedEvent>
Returns ​
void
ondata-cleared? ​
optionalondata-cleared?: (event) =>void
Defined in: graphty-element/jsx.ts:346
Emitted once every time the graph's data is cleared -- by clearData(), and by a load that
Parameters ​
event ​
CustomEvent<GraphDataClearedEvent>
Returns ​
void
ondata-loaded? ​
optionalondata-loaded?: (event) =>void
Defined in: graphty-element/jsx.ts:347
Parameters ​
event ​
CustomEvent<GraphDataLoadedEvent>
Returns ​
void
ondata-loading-complete? ​
optionalondata-loading-complete?: (event) =>void
Defined in: graphty-element/jsx.ts:348
Parameters ​
event ​
CustomEvent<DataLoadingCompleteEvent>
Returns ​
void
ondata-loading-error? ​
optionalondata-loading-error?: (event) =>void
Defined in: graphty-element/jsx.ts:349
Parameters ​
event ​
CustomEvent<DataLoadingErrorEvent>
Returns ​
void
ondata-loading-error-summary? ​
optionalondata-loading-error-summary?: (event) =>void
Defined in: graphty-element/jsx.ts:350
Parameters ​
event ​
CustomEvent<DataLoadingErrorSummaryEvent>
Returns ​
void
ondata-loading-progress? ​
optionalondata-loading-progress?: (event) =>void
Defined in: graphty-element/jsx.ts:351
Parameters ​
event ​
CustomEvent<DataLoadingProgressEvent>
Returns ​
void
onelements-removed? ​
optionalonelements-removed?: (event) =>void
Defined in: graphty-element/jsx.ts:355
Emitted once per removeNodes call, naming everything that went.
Parameters ​
event ​
CustomEvent<ElementsRemovedEvent>
Returns ​
void
onerror? ​
optionalonerror?: (event) =>void
Defined in: graphty-element/jsx.ts:356
Parameters ​
event ​
CustomEvent<GraphErrorEvent>
Returns ​
void
ongraph-frame-stable? ​
optionalongraph-frame-stable?: (event) =>void
Defined in: graphty-element/jsx.ts:357
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
ongraph-settled? ​
optionalongraph-settled?: (event) =>void
Defined in: graphty-element/jsx.ts:358
Parameters ​
event ​
CustomEvent<GraphSettledEvent>
Returns ​
void
ongraphty-capabilities-change? ​
optionalongraphty-capabilities-change?: (event) =>void
Defined in: graphty-element/jsx.ts:359
Parameters ​
event ​
CustomEvent<{ capabilities: AccelerationCapabilities; }>
Returns ​
void
ongraphty-history-change? ​
optionalongraphty-history-change?: (event) =>void
Defined in: graphty-element/jsx.ts:360
Parameters ​
event ​
CustomEvent<{ canRedo: boolean; canUndo: boolean; position: number; reason: "pending" | "record" | "size" | "merge" | "restore" | "undo" | "redo" | "clear" | "evict"; steps: number; version: number; }>
Returns ​
void
ongraphty-label-change? ​
optionalongraphty-label-change?: (event) =>void
Defined in: graphty-element/jsx.ts:361
Parameters ​
event ​
CustomEvent<NodeLabelCounts>
Returns ​
void
ongraphty-node-click? ​
optionalongraphty-node-click?: (event) =>void
Defined in: graphty-element/jsx.ts:362
Parameters ​
event ​
CustomEvent<NodeEventDetail>
Returns ​
void
ongraphty-node-drag-end? ​
optionalongraphty-node-drag-end?: (event) =>void
Defined in: graphty-element/jsx.ts:363
Parameters ​
event ​
CustomEvent<NodeEventDetail>
Returns ​
void
ongraphty-node-drag-start? ​
optionalongraphty-node-drag-start?: (event) =>void
Defined in: graphty-element/jsx.ts:364
Parameters ​
event ​
CustomEvent<NodeEventDetail>
Returns ​
void
ongraphty-node-hover? ​
optionalongraphty-node-hover?: (event) =>void
Defined in: graphty-element/jsx.ts:365
Parameters ​
event ​
CustomEvent<NodeEventDetail>
Returns ​
void
ongraphty-note-change? ​
optionalongraphty-note-change?: (event) =>void
Defined in: graphty-element/jsx.ts:366
Parameters ​
event ​
CustomEvent<Pick<NoteChange, "cause" | "id" | "fields" | "change">>
Returns ​
void
ongraphty-progress-change? ​
optionalongraphty-progress-change?: (event) =>void
Defined in: graphty-element/jsx.ts:367
Parameters ​
event ​
CustomEvent<ProgressChange>
Returns ​
void
ongraphty-project-status? ​
optionalongraphty-project-status?: (event) =>void
Defined in: graphty-element/jsx.ts:368
Parameters ​
event ​
CustomEvent<ProjectStatus>
Returns ​
void
ongraphty-run-change? ​
optionalongraphty-run-change?: (event) =>void
Defined in: graphty-element/jsx.ts:369
Parameters ​
event ​
CustomEvent<Pick<RunChange, "run" | "phase">>
Returns ​
void
ongraphty-selection-change? ​
optionalongraphty-selection-change?: (event) =>void
Defined in: graphty-element/jsx.ts:370
Parameters ​
event ​
CustomEvent<SelectionDelta>
Returns ​
void
ongraphty-visibility-change? ​
optionalongraphty-visibility-change?: (event) =>void
Defined in: graphty-element/jsx.ts:371
Parameters ​
event ​
CustomEvent<VisibilityChange>
Returns ​
void
onlayout-initialized? ​
optionalonlayout-initialized?: (event) =>void
Defined in: graphty-element/jsx.ts:372
Parameters ​
event ​
CustomEvent<GraphLayoutInitializedEvent>
Returns ​
void
onlayout-progress? ​
optionalonlayout-progress?: (event) =>void
Defined in: graphty-element/jsx.ts:373
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onlifecycle-disposed? ​
optionalonlifecycle-disposed?: (event) =>void
Defined in: graphty-element/jsx.ts:374
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onlifecycle-initialized? ​
optionalonlifecycle-initialized?: (event) =>void
Defined in: graphty-element/jsx.ts:375
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onmanager-initialized? ​
optionalonmanager-initialized?: (event) =>void
Defined in: graphty-element/jsx.ts:376
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-batch-complete? ​
optionalonoperation-batch-complete?: (event) =>void
Defined in: graphty-element/jsx.ts:377
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-complete? ​
optionalonoperation-complete?: (event) =>void
Defined in: graphty-element/jsx.ts:378
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-obsoleted? ​
optionalonoperation-obsoleted?: (event) =>void
Defined in: graphty-element/jsx.ts:379
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-progress? ​
optionalonoperation-progress?: (event) =>void
Defined in: graphty-element/jsx.ts:380
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-queue-active? ​
optionalonoperation-queue-active?: (event) =>void
Defined in: graphty-element/jsx.ts:381
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-queue-idle? ​
optionalonoperation-queue-idle?: (event) =>void
Defined in: graphty-element/jsx.ts:382
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onoperation-start? ​
optionalonoperation-start?: (event) =>void
Defined in: graphty-element/jsx.ts:383
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onrender-initialized? ​
optionalonrender-initialized?: (event) =>void
Defined in: graphty-element/jsx.ts:384
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onscreenshot-enhancing? ​
optionalonscreenshot-enhancing?: (event) =>void
Defined in: graphty-element/jsx.ts:385
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onscreenshot-ready? ​
optionalonscreenshot-ready?: (event) =>void
Defined in: graphty-element/jsx.ts:386
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onselection-changed? ​
optionalonselection-changed?: (event) =>void
Defined in: graphty-element/jsx.ts:387
Parameters ​
event ​
CustomEvent<SelectionChangedEvent>
Returns ​
void
onskybox-loaded? ​
optionalonskybox-loaded?: (event) =>void
Defined in: graphty-element/jsx.ts:388
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
onstyle-changed? ​
optionalonstyle-changed?: (event) =>void
Defined in: graphty-element/jsx.ts:392
Emitted after the style stack changed and the graph was repainted for it.
Parameters ​
event ​
CustomEvent<StyleChangedEvent>
Returns ​
void
onzoom-to-fit-complete? ​
optionalonzoom-to-fit-complete?: (event) =>void
Defined in: graphty-element/jsx.ts:393
Parameters ​
event ​
CustomEvent<GraphGenericEvent>
Returns ​
void
position-scale? ​
optionalposition-scale?:string
Defined in: graphty-element/jsx.ts:243
Sets the record-units-to-scene-units multiplier. Updates graph configuration.
positionScale? ​
optionalpositionScale?:number
Defined in: graphty-element/jsx.ts:81
Sets the record-units-to-scene-units multiplier. Updates graph configuration.
renderer? ​
optionalrenderer?:RendererRequest
Defined in: graphty-element/jsx.ts:184
Sets the renderer the element opens when it is first drawn.
An unrecognised value, or a change once the element is drawing, is reported and ignored rather than thrown, for the reason given on acceleration: Lit drives this setter from attributeChangedCallback, and a throw there would leave the element unrendered.
repeated-edges? ​
optionalrepeated-edges?:string
Defined in: graphty-element/jsx.ts:231
Sets the repeat policy. Updates graph configuration.
repeatedEdges? ​
optionalrepeatedEdges?:DuplicatePolicy
Defined in: graphty-element/jsx.ts:69
Sets the repeat policy. Updates graph configuration.
run-algorithms-on-load? ​
optionalrun-algorithms-on-load?:boolean
Defined in: graphty-element/jsx.ts:278
Sets whether to run algorithms when a style template loads. Updates graph configuration.
runAlgorithmsOnLoad? ​
optionalrunAlgorithmsOnLoad?:boolean
Defined in: graphty-element/jsx.ts:150
Sets whether to run algorithms when a style template loads. Updates graph configuration.
selectionStyle? ​
optionalselectionStyle?:object
Defined in: graphty-element/jsx.ts:116
Sets what a selected node looks like.
color? ​
optionalcolor?:string
The halo's colour. Any colour the element understands; normalised to hex on parse.
opacity? ​
optionalopacity?:number
How solid the halo is, in [0, 1]. Low enough to read as a highlight rather than a node.
scale? ​
optionalscale?:number
How much of the node's own size the halo is drawn at.
Greater than 1 puts a ring around the node, which is what a highlight reads as. Below 1 the halo disappears inside the node it is meant to mark, so the schema takes any positive number and the default stands a little clear of the node.
starting-camera-distance? ​
optionalstarting-camera-distance?:string
Defined in: graphty-element/jsx.ts:270
Sets the starting camera distance.
startingCameraDistance? ​
optionalstartingCameraDistance?:number
Defined in: graphty-element/jsx.ts:142
Sets the starting camera distance.
view-mode? ​
optionalview-mode?:string
Defined in: graphty-element/jsx.ts:262
Sets the view mode. Switching between 2D and 3D is one undoable step; entering VR or AR is not a step, and from 2D it switches to 3D first in the same step.
viewMode? ​
optionalviewMode?:"2d"|"3d"|"ar"|"vr"
Defined in: graphty-element/jsx.ts:125
Sets the view mode. Switching between 2D and 3D is one undoable step; entering VR or AR is not a step, and from 2D it switches to 3D first in the same step.
xr? ​
optionalxr?:object
Defined in: graphty-element/jsx.ts:162
Sets XR configuration. Updates VR/AR settings and UI options.
ar? ​
optionalar?:object
AR mode configuration
ar.enabled? ​
optionalenabled?:boolean
Enable AR mode
Default ​
truear.optionalFeatures? ​
optionaloptionalFeatures?:string[]
Optional WebXR features to request
Default ​
["hit-test"]ar.referenceSpaceType? ​
optionalreferenceSpaceType?:"unbounded"|"local"|"local-floor"|"bounded-floor"
WebXR reference space type for AR
Default ​
"local-floor"enabled? ​
optionalenabled?:boolean
Enable/disable XR functionality globally
Default ​
trueinput? ​
optionalinput?:object
XR input and interaction configuration
input.controllers? ​
optionalcontrollers?:boolean
Enable motion controllers
Default ​
trueinput.enableZAmplificationInDesktop? ​
optionalenableZAmplificationInDesktop?:boolean
Enable Z-axis amplification in desktop mode Normally amplification only applies in XR mode, but this can enable it for desktop too
Default ​
falseinput.handTracking? ​
optionalhandTracking?:boolean
Enable hand tracking
Default ​
trueinput.nearInteraction? ​
optionalnearInteraction?:boolean
Enable near interaction (touch/grab)
Default ​
trueinput.physics? ​
optionalphysics?:boolean
Enable physics-based interactions
Default ​
falseinput.zAxisAmplification? ​
optionalzAxisAmplification?:number
Z-axis movement amplification factor Multiplies Z-axis delta during drag to make depth manipulation practical in VR
Example: With zAxisAmplification = 10, moving controller 0.1 units in Z will move the node 1.0 units in Z
Default ​
10.0teleportation? ​
optionalteleportation?:object
Teleportation configuration
teleportation.easeTime? ​
optionaleaseTime?:number
Teleportation animation duration (ms)
Default ​
200teleportation.enabled? ​
optionalenabled?:boolean
Enable teleportation system
Default ​
falseui? ​
optionalui?:object
XR UI button configuration
ui.enabled? ​
optionalenabled?:boolean
Show VR/AR entry buttons
Default ​
trueui.position? ​
optionalposition?:"top-right"|"top-left"|"bottom-left"|"bottom-right"
Button position on screen
Default ​
"bottom-right"ui.showAvailabilityWarning? ​
optionalshowAvailabilityWarning?:boolean
Show "VR / AR NOT AVAILABLE" warning when XR is not available When false, no message is displayed if AR/VR aren't available
Default ​
falseui.unavailableMessageDuration? ​
optionalunavailableMessageDuration?:number
Duration to show "not available" message (ms)
Default ​
5000vr? ​
optionalvr?:object
VR mode configuration
vr.enabled? ​
optionalenabled?:boolean
Enable VR mode
Default ​
truevr.optionalFeatures? ​
optionaloptionalFeatures?:string[]
Optional WebXR features to request
Default ​
[]vr.referenceSpaceType? ​
optionalreferenceSpaceType?:"unbounded"|"local"|"local-floor"|"bounded-floor"
WebXR reference space type for VR
- "local": Seated/standing experience, no room bounds
- "local-floor": Floor-level origin, no room bounds
- "bounded-floor": Room-scale with bounds
- "unbounded": Unlimited tracking space
Default ​
"local-floor"