Skip to content

Graphty

Main Navigation Home

graphty-element

algorithms

layout

graph-io

visual-review

Appearance

Sidebar Navigation

Introduction

Overview

Getting Started

Installation

Migrating to 3.0

Usage

Web Component API

JavaScript API

Styling

Coloring by a Column

Style Helpers & Palettes

Layouts

Acceleration

Algorithms

Data Sources

Events

Columns, Runs & Progress

Undo & History

Camera

Screenshots & Video

VR/AR

Extending

Custom Layouts

Custom Algorithms

Custom Data Sources

API

Overview

Web Component API

JavaScript API

Generated TypeDoc

ai

Classes

AiController

AiManager

AiStatusManager

ApiKeyManager

CommandRegistry

MockLlmProvider

SchemaExtractor

SchemaManager

SystemPromptBuilder

TextInputAdapter

VercelAiProvider

VoiceInputAdapter

Interfaces

AiControllerOptions

AiManagerConfig

AiStatus

ApiKeyManagerOptions

AttributeHistogramBin

CommandContext

CommandExample

CommandResult

ExecutionResult

GraphCommand

InputAdapter

InputOptions

KeyPersistenceConfig

LlmProvider

LlmResponse

Message

NumericStatistics

PersistenceConfig

PropertySummary

ProviderOptions

SchemaExtractorOptions

SchemaSummary

StreamCallbacks

SystemPromptOptions

ToolCall

ToolCallStatus

ToolDefinition

WebLlmModelInfo

Type Aliases

AiEventEmitter

AiStage

AiState

InputCallback

ProgressCallback

PropertyType

ProviderType

StatusChangeCallback

ToolCallStatusType

VercelProviderType

VoiceStartCallback

Variables

captureScreenshot

captureVideo

clearStyles

describeProperty

findAndStyleEdges

findAndStyleNodes

findNodes

listAlgorithms

queryGraph

runAlgorithm

sampleData

setCameraPosition

setDimension

setImmersiveMode

setLayout

zoomToNodes

Functions

createAiManager

createProvider

createSystemPromptBuilder

createWebLlmProvider

formatSchemaForPrompt

getWebLlmProviderClass

catalog

Interfaces

Loading

GraphListing

Other

AlgorithmDescriptor

BuiltInAlgorithmDescriptor

ByDesignWaiver

CameraDescriptor

CatalogApi

ChannelDescriptor

ColorValue

DefectWaiver

DetectionInput

FormatDescriptor

FunctionDescriptor

LayoutCatalogEntry

LayoutDescriptor

LayoutImplementation

LegacyAlgorithmKey

LegacyAlgorithmMapping

LogSinkDescriptor

MetricAvailability

OptionBound

OptionChoice

OptionDescriptor

OptionsFromZodOptions

PaletteDescriptor

ScaleDescriptor

SuggestedName

UnservedFormat

UnservedLayout

WithdrawnCapability

Type Aliases

AlgorithmKey

AttributeType

CameraId

ChannelGroup

ChannelValueKind

CostClass

DeprecatedAlgorithm

DeprecatedCatalogMethod

DrawingMode

Filter

FilterDirection

FormatId

KnownAlgorithm

LabelAnimation

LabelBadge

LabelGradientDirection

LabelGradientType

LabelIconPosition

LabelLocation

LabelPointerDirection

LabelTextAlign

LayoutId

LogSinkId

OptionsSource

OptionType

OptionUiMeta

PaletteId

UnpaintedChannel

UnreachableStyleField

Waiver

Variables

ATTRIBUTE_TYPES

BUILT_IN_ALGORITHMS

CAMERA_DESCRIPTORS

CHANNEL_DESCRIPTORS

CHANNELS

COST_CLASSES

DEPRECATED_ALGORITHMS

FORMAT_DESCRIPTORS

KNOWN_ALGORITHMS

KNOWN_CAMERA_IDS

KNOWN_FORMAT_IDS

KNOWN_LAYOUT_IDS

KNOWN_LOG_SINK_IDS

KNOWN_PALETTE_IDS

LABEL_STYLE_FIELDS

LAYOUT_CATALOG

LAYOUT_DESCRIPTORS

LOG_SINK_DESCRIPTORS

OPTION_BOUND_SOURCES

OPTION_TYPES

PALETTE_DESCRIPTORS

SCALE_DESCRIPTORS

UNPAINTED_CHANNELS

UNREACHABLE_STYLE_FIELDS

UNSERVED_FORMAT_IDS

UNSERVED_LAYOUT_IDS

WAIVER_EXPIRY_UNSET

WAIVER_HORIZON_DAYS

WAIVER_OWNER_UNASSIGNED

WITHDRAWN_CAPABILITIES

Functions

algorithmByKey

algorithmByLegacyKey

cameraDescriptor

camerasForMode

channelDescriptor

channelsFor

detectFormat

detectFormats

formatDescriptor

formatsForExtension

isAttributeType

isCostClass

isOptionBound

isOptionType

layoutDescriptor

layoutEntry

layoutIdForEngine

listGraphs

logSinkDescriptor

optionsFromZod

paletteDescriptor

palettesOfKind

scaleDescriptor

scalesForDomain

toColorValue

commands

Type Aliases

CommandMeta

Variables

COMMANDS

Functions

isSessionCommand

extend

Classes

Other

AcceleratorRegistry

DeclaredAlgorithm

OptionValidationError

Reports and errors

ImportError

Interfaces

Loading

CommonImportOptions

GraphChoiceOptions

Other

AcceleratorRegistration

AlgorithmContext

AlgorithmOutput

AlgorithmRunContext

AlgorithmStatics

CameraViewInput

CameraViewRegistration

DeclaredDirection

DefaultPaletteControls

DefaultPalettes

DefinitionBase

EdgeScoreDefinition

EdgeView

GraphBounds

GraphSink

GraphSnapshot

GraphView

GroupingDefinition

ImporterSourceOptions

LayoutContext

LayoutDefinition

LayoutEngineStatics

LogDestinationDefinition

LogSinkRegistration

NodeScoreDefinition

NodeView

OptionContext

OptionDefinition

OptionDescriptorDomain

PaletteDefinition

PlainLogRecord

RegisterAcceleratorOptions

RegisteredAlgorithm

RegisteredFormat

RegisteredLayout

RegisterOptions

ResultElementValues

ResultFieldSpec

ScopedInput

ScopedInputOptions

Vec3

WholeGraphScoreDefinition

Reports and errors

ImporterReport

ImportIssue

Saving

CommonExportOptions

ExportCapabilities

LossNote

Writing a format

GraphExporter

GraphImporter

Type Aliases

Loading

ImportInput

Other

AlgorithmDefinition

AlgorithmGraphMode

AlgorithmGraphView

AuthoredLayoutDescriptor

ColorVisionDeficiency

Column

EdgeMask

GraphLister

ImporterDataSourceClass

LogLevelName

NodeId

NodeMask

OptionsFromSchema

OptionShorthand

OptionsSchema

OptionsShorthand

OptionValuesOf

PaletteRegistration

Point

ScopeInputDeclaration

Score

ShorthandValue

Reports and errors

IssueCategory

Variables

acceleratorRegistry

DEFAULT_ACCELERATOR_PRECISION

LAYERED_GROUPING_FIELD_SPECS

PATH_FIELD_SPECS

Functions

checkShapeContract

clearRegisteredAlgorithmsForTesting

clearRegisteredCamerasForTesting

clearRegisteredFormatsForTesting

clearRegisteredFormatWritersForTesting

clearRegisteredLayoutsForTesting

clearRegisteredLogSinksForTesting

clearRegisteredPalettesForTesting

communityFields

communityFieldSpecs

compareNodeIds

declaredCaveats

defineOptionsSchema

edgeMetricFields

forEachChunked

maskTest

metricField

metricFieldSpecs

nodeMetricFields

registerAccelerator

registeredAlgorithmDescriptors

registeredCameraDescriptors

registeredFormatDescriptors

registeredLayoutDescriptors

registeredLogSinkDescriptors

registeredPaletteDescriptors

resolveOptions

resolveOptionValues

setFieldSpecs

validateOption

format

Interfaces

AdjacencyView

DerivedGraph

Type Aliases

ArcIndex

EdgeIndex

F32

F64

I32

NodeIndex

U32

U8

Variables

INVALID_INDEX

Functions

expandEdges

foldArcs

gatherArray

isGraphSnapshot

makeMask

maskCount

maskSet

maskToIndices

remapArray

scatterArray

index

Enumerations

PolyhedronType

ScreenshotErrorCode

Classes

Algorithm

AlgorithmManager

AnimationCancelledError

DataManager

DataSource

Edge

ErrorAggregator

EventManager

Graph

Graphty

GraphtyError

InputManager

LayoutEngine

LayoutManager

Node

OperationQueueManager

RenderManager

ScreenshotError

SelectionManager

SimpleLayoutEngine

StatsManager

UpdateManager

Interfaces

AccelerationStatus

AcceleratorDeviceInfo

AcceleratorFactoryOptions

AnimationOptions

AnimationResult

BaseDataSourceConfig

CalibrationRecord

CameraAnimationOptions

CameraState

CameraStateChangedEvent

CameraWaypoint

Capabilities

CapabilityCheck

CaptureCapability

CaptureEstimate

CodedFact

ColumnRef

DataLoadingCompleteEvent

DataLoadingError

DataLoadingErrorEvent

DataLoadingErrorSummaryEvent

DataLoadingProgressEvent

DataSourceChunk

EdgeAddEvent

EdgeGenericEvent

EdgePosition

EncodingSuggestion

ErrorSummary

ExportResult

FindEnd

FindHitBase

FindOptions

FindResult

FindValueRow

FormatWriterRegistration

GraphAccelerator

GraphContext

GraphContextConfig

GraphDataAddedEvent

GraphDataClearedEvent

GraphDataLoadedEvent

GraphErrorEvent

GraphGenericEvent

GraphLayoutInitializedEvent

GraphSettledEvent

GraphtyErrorInit

GraphtyErrorJson

HighlightSuggestion

Limits

Manager

ManagerConfig

ManagerContext

Neighbor

NeighborOptions

NeighborPage

NeighborSort

NodeAddEvent

NodeClickEvent

NodeDragEndEvent

NodeDragStartEvent

NodeEventDetail

NodeGenericEvent

NodeHoverEvent

NodeLabelCounts

NodeScreenPosition

Note

NoteChange

NoteCite

NoteCiteStatus

NoteInput

NoteListOptions

NoteMergeOptions

NotePatch

NotesApi

NotesDocument

NotesReport

NoteStatus

NoteTargetStatus

Position

Problem

ProgressChange

ProjectApi

ProjectOpenOptions

ProjectOpenReport

ProjectSaveOptions

ProjectSaveReport

ProjectStatus

QualityEnhancementOptions

QueueableManager

QueueableOptions

RendererStatus

ResultRef

RunAlgorithmOptions

RunPainting

SavedProject

ScreenshotOptions

ScreenshotResult

SetLayoutOptions

SnapshotLayoutInput

SnapshotLayoutProgress

SnapshotLayoutRegistration

StyleChangedEvent

WeightMeaning

WorkerCapability

XrCapability

XRConfig

XRInputConfig

XRModeConfig

XRTeleportationConfig

XRUIConfig

Type Aliases

AccelerationCapabilities

AccelerationErrorCode

AccelerationPolicy

AccelerationPrecision

AccelerationState

AcceleratorFactory

ActiveRenderer

AdHocData

AlgorithmOnLoad

ClipboardStatus

CodedFactParam

EdgeEvent

EdgeEventType

EdgeStyleConfig

EventCallbackType

EventType

ExportGraphOptions

FindHit

FindKind

GraphBackgroundConfig

GraphEvent

GraphEventType

GraphtyElementEventMap

GraphtyErrorCode

GraphtyErrorSource

GraphtyErrorTarget

GraphtyWarningCode

ImageData

NodeEvent

NodeEventType

NodeId

NodeIdType

NodeStyleConfig

NoteId

NoteTarget

NoteTargetInput

PartialXRConfig

ProjectProblem

ProjectSource

RendererRequest

RichTextStyleType

SimpleLayoutConfigType

SimpleLayoutOpts

SnapshotLayoutAnswer

StyleSuggestion

SuggestionOutcome

ViewMode

Variables

ACCELERATION_ERROR_CODES

ACCELERATION_MIN_NODES_DEFAULT

ACCELERATION_MIN_NODES_KEY

ACCELERATION_POLICIES

ACCELERATION_POLICY_DEFAULT

BLUE_HIGHLIGHT

BLUE_ORANGE_COLORS

BLUES_COLORS

BUILTIN_PRESETS

CARBON_COLORS

CPU_PRECISION

DEFAULT_VIEW_MODE

defaultEdgeStyle

defaultNodeStyle

defaultRichTextLabelStyle

defaultXRConfig

EDGE_CONSTANTS

EdgeStyle

GraphBackground

GRAPHTY_ERROR_CODES

GREEN_SUCCESS

GREENS_COLORS

INFERNO_COLORS

NodeShapes

NodeStyle

OKABE_ITO_COLORS

ORANGE_WARNING

ORANGES_COLORS

OTHER_GROUP_COLOR

PASTEL_COLORS

PLASMA_COLORS

PROJECT_FILE

PURPLE_GREEN_COLORS

RED_BLUE_COLORS

RichTextStyle

SHAPE_CONSTANTS

SimpleLayoutConfig

TOL_MUTED_COLORS

TOL_VIBRANT_COLORS

VIEW_MODE_VALUES

VIRIDIS_COLORS

YLORBR_COLORS

Functions

colorToHex

defineAlgorithm

defineLayout

defineLogDestination

definePalette

isAccelerationPolicy

isGraphtyError

isGraphtyErrorCode

isViewMode

projectFileName

registerCameraView

registerFormatWriter

registerLogSink

registerPalette

registerSnapshotLayout

jsx

Interfaces

GraphtyElementJSXProps

logging

Enumerations

LogLevel

Interfaces

ConsoleSinkOptions

GraphtyLoggerConfig

LogFormatOptions

Logger

LoggerConfig

LogRecord

LogSinkReference

ParsedLoggingParams

RemoteSinkOptions

Sink

Variables

GraphtyLogger

LOG_LEVEL_NAMES

LOG_LEVEL_TO_NAME

Functions

clearLoggingConfig

configureLogging

createConsoleSink

createRemoteSink

formatLogRecord

getLoggingConfig

isModuleEnabled

lazy

loadLoggingConfig

parseLoggingURLParams

parseLogLevel

resetLoggingConfig

saveLoggingConfig

react

schema

Interfaces

LabelStyle

Rgba

RgbColor

ThemeDescriptor

Type Aliases

ChannelValue

EdgeLinePattern

Filter

FilterDirection

GraphSelectionStyleConfig

GraphSelectionStyleInput

Variables

DEFAULT_SELECTION_STYLE

EdgeArrowTypes

EdgeLineTypes

GraphSelectionStyleOpts

MISSING_DATA_COLOR

Functions

areDistinguishableInGrayscale

colorDifference

hexToRgb

interpolatePalette

isPaletteSafe

simulateDeuteranopia

simulateProtanopia

simulateTritanopia

toGrayscale

session

Interfaces

AlgorithmRunCommand

AttributeDescriptor

BatchResult

BatchStep

Caveats

ChannelExplanation

ChannelShare

ColumnEncodingSpec

CommandOutcomeMap

ComponentStatistics

CostEstimate

CostGateLimits

CostMeasurement

CreateGraphSessionOptions

DataSourceDescriptor

DataSourceInput

DraftColumn

DraftRow

DraftRowOptions

DraftTable

EdgeMember

EdgePageOptions

EdgeRecord

ElementLayerSpec

ElementSet

EncodingRun

EncodingSpec

Endpoint

EngineVersions

FieldBand

FieldDescriptor

FieldInterpretation

FieldWords

FilterResult

GraphSession

GraphStatistics

HighlightSpec

Histogram

HistogramBin

HistogramOptions

HistoryStep

ImportOptions

ImportReport

JournalApi

JournalEntry

Layer

LayerPosition

LayerProblem

LayerSpec

LayoutRecommendation

LayoutRecommendationOptions

LegendBlock

LegendReading

LegendSwatch

LoadChoices

LoadDraft

LoadError

LoadMappingRead

LoadReport

MachineCalibration

Memberships

NodeRecord

NumericColumnView

PageColumn

PendingStep

Plan

PlanBlock

PositionEntry

Progress

ProjectConfig

ProjectConfigPatch

QueryValidation

QueueEntry

RankingEntry

ReadingOptions

ReadonlyElementPositions

RecordPage

RecordPageOptions

RecordSort

RepaintReport

RepeatedEdgeCounts

ResolvedScope

ResultColumnDescriptor

ResultItem

ResultsApi

ResultSort

ResultSummary

RowUpdate

Run

RunChange

RunExecutionContext

RunOptions

RunOutcome

RunProgressReport

RunQueue

RunRecord

RunRemoval

RunResult

RunsApi

RunScopeRecord

RunSpec

SavedScope

ScopeApi

ScopeCount

ScopeCountOptions

SelectionApi

SelectionAttributeStatistics

SelectionDelta

SelectionStatistics

SessionConfig

SessionDataApi

SessionEventMap

SessionGraphStore

SessionHistory

SessionLayout

SessionPositions

SessionRunsOptions

SessionStatus

SessionStylesApi

SessionViews

SetChange

SetOffer

SetsApi

SetStatus

SetUser

StaleNote

StartOptions

StyleAgreement

StyleChange

StyleContribution

StyleDocument

StyleExplanation

StyleProblem

StylesApi

SummaryEntry

SummaryGroup

TableMapping

TableMappingRead

TemplateOptions

TemplateReport

TimeWindow

TooLargeDetails

TopRanking

TransactionOptions

UnboundLayer

ValidationResult

VisibilityApi

VisibilityChange

VisibilitySummary

Type Aliases

AttributeRole

AttributeUse

Binding

BindingOverflow

Channel

ChannelAgreement

ColumnHistogram

ColumnRole

CommandOutcome

CostConfidence

CostGateDecision

DefaultableLimits

DraftRowFilter

EdgeId

EdgeReading

EdgeRecordInput

EdgeRef

Encoding

EncodingOptions

EncodingProposal

EncodingRefusalCode

EndpointSpelling

ExplainTarget

Filter

FilterDirection

HistogramBinning

HistoryCause

HistoryOutcome

HistoryStepId

ItemKey

JournalId

LayerId

LayerKind

LayerSource

LoadMapping

Measurement

MeasurementDeclaration

MeasurementSource

NodeRecordInput

Normalization

Path

PathKind

PendingId

PlanEffect

Precision

ProjectSlice

Query

QueuePolicy

RepaintReason

ResultCell

ResultColumn

ResultId

ResultShape

RuleTree

RunDirection

RunExecutor

RunId

RunPhase

RunRef

RunStatus

RunStyle

Scope

ScopeId

ScopeInput

SelectionCause

SelectionDirection

SelectionOp

SelectionTarget

SelectionTextMode

Selector

SessionAttributes

SessionCatalogApi

SessionCommand

SessionDataConfig

SetCombine

SetCreatedFrom

SetDefinition

SetDefinitionInput

SetId

SetOp

SetOperand

SetStatusReason

StaticStyle

TimeStep

TransactionScope

Variables

DEFAULT_COST_GATE_LIMITS

DEFAULT_EXACT_COMPUTATION_CAP_SECONDS

DEFAULT_LIMITS

DEFAULT_SCOPE_SAMPLE

DEFAULT_SELECTION_CAP

LOAD_ROLES

QUEUE_POLICIES

RESULT_FIELD_NAMES

RESULT_ROOT

RESULT_SHAPE_CONTRACTS

RESULT_SHAPES

RUN_ID_PATTERN

RUN_PHASES

RUN_STATUSES

SET_OPS

TERMINAL_RUN_STATUSES

Functions

createGraphSession

defaultReading

isAlgorithmRunCommand

isResultShape

isRunId

isRunStatus

isTerminalRunStatus

parseScope

parseSetDefinition

quotePath

recommendLayout

resultPath

webgpu

On this page

@graphty/graphty-element / react

react

Edit this page

Pager

Previous pagesaveLoggingConfig

Next pageschema

Loading

Other

Other

Reports and errors

Loading

Other

Reports and errors

Saving

Writing a format

Loading

Other

Reports and errors

react ​

react