SurfView.js API
Classes
- AlignmentQAWorkspace
- ColorMap
- ColorMap2D
- ConnectivityLayer
- CrosshairManager
- EventEmitter
- DynamicEventEmitter
- FlatMapView
- GPULayerCompositor
- LabeledNeuroSurface
- LayerConfigError
- LayerRegistry
- LinkedBrainWorkspace
- MorphableSurface
- MultiLayerNeuroSurface
- NeuroSurfaceViewer
- NoopNeuroSurfaceViewer
- OutlineLayer
- PluginHost
- SubjectPackage
- SurfaceControls
- SurfaceFactory
- SurfaceSet
- VariantSurface
- AnnotationManager
- AtlasPlateView
- SurfaceGeometryError
- SurfaceGeometry
- NeuroSurface
- ColorMappedNeuroSurface
- VertexColoredNeuroSurface
- SurfViewControlSession
- ViewerControlTarget
- Layer
- RGBALayer
- DataLayer
- VolumeProjectionLayer
- TwoDataLayer
- BaseLayer
- LabelLayer
- LayerStack
- CurvatureLayer
- ParcelConnectivityLayer
- ParcelValueLayer
- StatisticalMapLayer
- SurfaceLoadError
- VolumeProjectionMaterial
- ParcelIndex
- ParcelMapOptimizer
- ParcelPuzzle
- ParcelPuzzleView
- ReportSceneControlTarget
- ReportSceneController
- ROIManager
- SceneManifestError
- ParcelSurface
- VolumeProjectedSurface
- SparklineOverlay
- TemporalDataLayer
- TimelineController
- VolumeTexture3D
- BoundingBoxHelper
- ClipPlane
- ClipPlaneSet
- GPUPicker
- LaplacianSmoothing
- MeshAdjacencyError
- NumericValidationError
Interfaces
- AlignmentVolume
- AlignmentSurface
- AlignmentTransform
- AlignmentQAConfig
- SurfaceDistanceSummary
- EdgeAgreementSummary
- DropoutSummary
- AlignmentQAMetrics
- AlignmentQAReport
- AnatomicalViewAxes
- SingleAnatomicalViewOptions
- PairedAnatomicalViewOptions
- BilateralSurfaceGroup
- AnatomicalViewCapabilities
- BilateralSurfaceGroupRegisteredEvent
- BilateralSurfaceGroupRemovedEvent
- AnatomicalViewChangedEvent
- ColorMapEventMap
- ColorMapOptions
- ColorMap2DOptions
- ConnectivityEdge
- ConnectivityLayerConfig
- ConnectivityLayerUpdate
- CSRData
- CrosshairOptions
- FlatMapGeometryInput
- FlatMapViewOptions
- FlatMapVertexEvent
- FlatMapClickEvent
- FlatMapSelectionEvent
- FlatMapROIEvent
- FlatMapROIDrawingOptions
- FlatMapEventMap
- GPUCompositorUpdateStats
- GPUCompositorCapacity
- GPUMaterialResponse
- NoInspectionSelection
- VertexInspectionSelection
- ParcelInspectionSelection
- InspectionSelectionOptions
- InspectionSelectionChangedEvent
- VertexInspectionLayerValue
- VertexInspectionParcel
- VertexInspectionAtlas
- VertexInspection
- LabelDefinition
- RegisteredLayerConfig
- BuiltInLayerConfigBase
- BaseLayerFactoryConfig
- RGBALayerFactoryConfig
- DataLayerFactoryConfig
- OutlineLayerFactoryConfig
- LabelLayerFactoryConfig
- TwoDataLayerFactoryConfig
- TemporalLayerFactoryConfig
- VolumeLayerFactoryConfig
- CurvatureLayerFactoryConfig
- StatisticalLayerFactoryConfig
- ConnectivityLayerFactoryConfig
- BuiltInLayerConfigMap
- BuiltInLayerMap
- LayerRegistryEntry
- LinkOptions
- LinkedViewerLike
- LinkedTimelineLike
- LinkedBrainWorkspaceOptions
- MorphTargetConfig
- MorphAnimationOptions
- MorphableSurfaceConfig
- MultiLayerSurfaceConfig
- LayerUpdate
- ClearLayersOptions
- NeuroSurfaceViewerConfig
- ParcelFocusOptions
- ViewerFigureBackground
- ViewpointConfig
- ViewpointState
- OutlineLayerOptions
- OutlineLayerUpdate
- PluginHostViewer
- ViewerPluginContext
- ViewerPlugin
- RegisterPluginOptions
- PluginRegistration
- StylePresetBackground
- StylePresetLighting
- StylePresetMaterial
- StylePresetCurvature
- StylePresetROI
- StylePresetAnnotation
- StylePresetColormaps
- StylePresetFigure
- SurfViewStylePreset
- FigureExportLabel
- FigureColorbarCaps
- FigureColorbarSource
- FigureExportContext
- FigureExportOptions
- ResolvedFigureExportOptions
- PackageAssetRef
- SubjectPackageSoftware
- SubjectPackageProvenance
- SurfaceVariantManifest
- SurfaceSetManifest
- MetricManifest
- ParcellationManifest
- RoiManifest
- TransformManifest
- VolumeManifest
- SceneLayerManifest
- SceneSurfaceManifest
- SceneManifest
- SubjectPackageManifest
- SubjectPackageValidationIssue
- SubjectPackageValidationReport
- SubjectPackageOptions
- SubjectPackageLoadOptions
- SurfaceControlsConfig
- SurfaceDefinition
- SurfaceSetConfig
- VariantTransitionOptions
- AnnotationOptions
- AnnotationRecord
- AtlasFigureSpec
- AtlasFigureSource
- AtlasPlateStyle
- AtlasPlateViewOptions
- AtlasPlateLayout
- AtlasViewport
- AtlasPlatePresentation
- AtlasPoint
- AtlasBounds
- AtlasPlateProvenance
- AtlasPlateInput
- AtlasPlateOptions
- AtlasPlateRegion
- AtlasPlateLabel
- AtlasPlate
- SurfaceConfig
- ResolvedSurfaceConfig
- SurfViewControlSessionOptions
- SurfViewControlFocusSnapshot
- SurfViewControlSessionSnapshot
- ControlJsonObject
- CapabilityAvailability
- ControlOptionDescriptor
- NumericRangeControlDescriptor
- HistogramControlDescriptor
- LayerDataSummaryControlDescriptor
- ScalarMappingControls
- BivariateMappingControls
- TemporalControls
- ParcelControls
- OutlineControls
- LayerColorPreviewDescriptor
- LayerControlDescriptor
- SurfaceControlDescriptor
- AnatomicalViewTargetDescriptor
- CurrentAnatomicalViewDescriptor
- ViewControlDescriptor
- SelectionControlDescriptor
- FigurePresetControlDescriptor
- FigureControlDescriptor
- ExclusiveMapCapability
- ReferenceLayersCapability
- SurfViewControlCapabilities
- SurfViewControlSnapshot
- ControlCommandFailure
- SetAnatomicalViewRequest
- LayerControlAddress
- ScalarMappingUpdate
- FigureExportRequest
- FigureExportResult
- SurfViewControlTargetCommands
- SurfViewControlSubscription
- SurfViewControlTarget
- SurfViewControlSessionState
- ManagedViewerControlSessionOptions
- ViewerControlTargetOptions
- SurfaceLayerReorderedEvent
- SurfaceEventMap
- ViewerStateChangedEvent
- SurfacePickEvent
- VertexHoverEvent
- ParcelInteractionEvent
- ParcelSelectionEvent
- ViewerSurfaceEvent
- LayerEvent
- LayerUpdatedEvent
- LayerReorderedEvent
- LayerColormapEvent
- LayerRangeEvent
- LayerThresholdEvent
- LayerOpacityEvent
- AnnotationEvent
- ViewpointChangedEvent
- CameraChangedEvent
- ViewerEventMap
- GraphEdge
- GraphStyle
- GraphBoundaryLayerConfig
- ResolvedEdgeStyle
- NeighborhoodLensConfig
- QualityChannelConfig
- QualityChannelResult
- LayerOrderConstraints
- LayerOrderDescriptor
- LayerPresentation
- LayerHistogram
- LayerDataSummary
- LayerHistogramOptions
- LayerDataSummaryOptions
- RibbonSamplingConfig
- LayerConfig
- DataLayerConfig
- VolumeProjectionLayerConfig
- TwoDataLayerConfig
- LayerUpdateData
- RGBALayerUpdateData
- DataLayerUpdateData
- VolumeProjectionLayerUpdateData
- TwoDataLayerUpdateData
- BaseLayerUpdateData
- LabelLayerUpdateData
- LabelLayerOptions
- CurvatureConfig
- CurvatureLayerUpdateData
- ParcelConnectivityLayerConfig
- ParcelConnectivityLayerUpdate
- ParcelValueLayerConfig
- ParcelValueLayerUpdateData
- StatisticalMapLayerConfig
- DualThresholdConfig
- VertexStatInfo
- StatisticalMapLayerUpdateData
- ParsedSurfaceData
- SurfaceLoadOptions
- VolumeProjectionMaterialConfig
- VolumeProjectionMaterialOptions
- AtlasRef
- ParcelAtlasMetadata
- ParcelRecord
- ParcelData
- ParcelValidationOptions
- VolumeDescriptor
- ProjectionSurface
- ProjectVolumeOptions
- ProjectVolumeResult
- RibbonProjectionSurface
- ParcelMapMesh
- ParcelMapParameters
- ParcelMapMetrics
- ParcelMapStep
- ParcelMapSolveOptions
- ParcelPuzzleOptions
- ParcelPuzzleSelection
- ParcelPuzzleEvents
- ParcelDetailContext
- ParcelPuzzleViewOptions
- ParcelPuzzleViewEvents
- ParcelPuzzleInput
- ParcelPuzzleGeometryOptions
- ParcelPieceGeometry
- ParcelPuzzleGeometry
- ReportAnatomicalMesh
- ReportSceneControllerOptions
- ReportFitInsets
- ReportSceneControllerState
- ReportObliqueAngle
- MountSurfViewOptions
- SurfViewMountHandle
- RoiPoint
- RoiProvenance
- VertexROI
- CreateROIOptions
- PolygonVertexSource
- RoiSVGOptions
- RoiLabelExportOptions
- RoiManifestExportOptions
- CreateSceneAssetOptions
- LoadSceneAssetOptions
- SceneAssetDescriptor
- SceneGeometryManifest
- SceneLayerValuesManifest
- SceneLayerLegend
- SceneMapLayerManifest
- SceneReferenceLayerManifest
- SurfViewSceneManifest
- SceneAssetManifest
- SceneExportProvenance
- SceneExportManifest
- SceneExportOptions
- StaticHTMLExportOptions
- CameraState
- LightingState
- ViewerConfigState
- SerializedClipPlaneState
- LayerState
- SurfaceStateV1
- SurfaceState
- SerializedCrosshairState
- SerializedTimelineState
SelectionState- SurfaceGroupState
- ViewerStateV1
- ViewerStateV2
- RestorationIssue
- RestorationReport
- SurfaceShadingOptions
- ParcelSurfaceConfig
- ParcelColorLayerConfig
- VolumeProjectedSurfaceOptions
- FactorDescriptor
- TemporalDataConfig
- TimelineState
- TimelineEvent
- TimelineEventMap
- SparklineOptions
- VolumeTexture3DOptions
- ClipPlaneConfig
- GPUPickResult
- GPUPickOptions
- PickInfo
- ViewerCapabilities
- MeanCurvatureOptions
- SulcalDepthOptions
- MeshAdjacency
- FDRResult
- BonferroniResult
- ClusterResult
- FiniteNumberDomain
Type Aliases
- AlignmentSliceAxis
- AnatomicalView
- AnatomicalHemisphere
- AnatomicalViewLayout
- Vector3Tuple
- AnatomicalViewOptions
- BilateralSurfaceGroupFailureCode
- BilateralSurfaceGroupResult
- AnatomicalViewFailureCode
- AnatomicalViewResult
- AnatomicalViewResetResult
- BilateralSurfaceGroupRemovalReason
- Color
- RGBA
- RGB
- ColorArray
- ColorMap2DRGBA
- ColorMap2DPreset
- RenderMode
- CrosshairMode
- EventListener
- UnsubscribeFn
- EventPayloadArgs
- TypedEventListener
- EventType
- EventArgsFor
- InspectionSelection
- InspectionSelectionFailureCode
- InspectionSelectionResult
- BuiltInLayerType
- BuiltInLayerRegistryEntries
- BuiltInLayerConfig
- BuiltInLayer
- BuiltInLayerFor
- LayerCreationFailureCode
- LayerCreationResult
- LayerFactory
- RegistryType
- RegistryConfigUnion
- RegistryLayer
- RegistryLayerUnion
- RegistryLayerForConfig
- ReadonlyLayerRegistry
- EasingFunction
- ResolvedNeuroSurfaceViewerConfig
- Viewpoint
- PluginTeardown
- SurfViewStylePresetName
- LabelDensity
- FigureBackground
- SubjectHemisphere
- SceneLayerSourceType
- ValidationSeverity
- SurfaceType
- AtlasPlateOrientation
- SurfaceGeometryErrorCode
- SurfViewControlSessionSnapshotListener
- ControlJsonPrimitive
- ControlJsonValue
- AnatomicalViewTargetRef
- ControlCommandFailureCode
- ControlCommandSuccess
- ControlCommandResult
- ControlQueryResult
- SurfViewControlSnapshotListener
- SurfViewControlSectionId
- SurfaceEventType
- NumericRange
- ControlDomain
- ViewerEventType
- ViewerEventListener
- NodeId
- EdgeMetricFn
- FocusPolicy
- BlendMode
- LayerRole
- LayerPinnedPosition
- LayerOrderFailureCode
- LayerOrderResult
- VolumeProjectionMode
- VolumeSamplingMode
- VolumeProjectionQuality
- RibbonReducer
- LayerChangeSet
- ParcelConnectivityAlphaMode
- StatType
- CorrectionMethod
- SurfaceFormat
- Hemisphere
- SurfaceLoadStage
- SurfaceLoadErrorCode
- AtlasRepresentation
- AtlasConfidence
- NormalProjectionReducer
- ProjectRibbonVolumeOptions
- ParcelDetailRenderer
- ReportSceneControlTargetOptions
- ReportLayout
- ReportBrainView
- ReportSceneMutationPhase
- ReportSceneMutationListener
- ReportSceneDisposingListener
- SurfViewSceneView
- RoiDrawMode
- SceneTypedArray
- SceneHemisphere
- SceneAssetDType
- SceneAssetRole
- SurfViewSceneLayerManifest
- SceneAssetType
- ViewerState
- RestorationIssueCode
- ParcelColorResolver
- LoopMode
- VolumeTextureFilter
- ClipAxis
- MeshAdjacencyErrorCode
- StraightRGBA
- NumericValidationErrorCode
Variables
- ANATOMICAL_VIEWS
- NO_INSPECTION_SELECTION
- builtInLayerRegistry
- Easing
- STYLE_PRESETS
- embedStyles
- DEFAULT_PARCEL_MAP_PARAMETERS
- REPORT_BRAIN_VIEWS
- DEFAULT_REPORT_OBLIQUE
- SURFVIEW_SCENE_SCHEMA
- SURFVIEW_SCENE_SCHEMA_V2
- SURFVIEW_EXPORT_SCHEMA
- SURFVIEW_VERSION
- CURRENT_VERSION
- MAX_DEVICE_PIXEL_RATIO
Functions
- createAlignmentQAReport
- computeAlignmentQAMetrics
- normalizeAnatomicalHemisphere
- getAnatomicalViewAxes
- tryCreateLayerFromConfig
- createLayerFromConfig
- hasDOM
- listStylePresets
- getStylePreset
- resolveStylePreset
- resolveFigureExportOptions
- validateSubjectPackageManifest
- parseAtlasFigureSpec
- renderAtlasFigureSVG
- renderAtlasPlateSVG
- emptyAtlasLayout
- parseAtlasPlateLayout
- buildAtlasPlate
- validateSurfaceGeometryData
- createSurfViewControlSession
- createManagedViewerControlSession
- createViewerControlTarget
- setDebug
- debugLog
- applyEmbedStyles
- buildAdjacency
- computeNeighborhoodShells
- createDefaultShellStyle
- resolveNeighborhoodLensStyles
- resolveBoundaryStyles
- createDifferenceEdgeMetric
- mapQualityChannelValue
- createOpacityQualityChannel
- createPatternQualityChannel
- detectSurfaceFormat
- detectHemisphereFromName
- getDomParser
- parseFreeSurferSurface
- parseGIfTISurface
- parseGIfTIScalars
- parsePLY
- loadSurface
- loadSurfaceFromFile
- parseFreeSurferCurvature
- normalizeVertexLabels
- validateAtlasRef
- validateParcelData
- buildParcelLookup
- mapParcelValuesToVertices
- parcelValuesInOrder
- projectVolume
- projectRibbonVolume
- buildParcelMapMesh
- flattenParcelMap
- buildParcelPuzzle
- createReportSceneControlTarget
- layoutReportAnatomicalMeshes
- mountSurfView
- createROIFromPolygon
- selectVerticesInPolygon
- roiToLabelArray
- roiToSVG
- roiToLabelGIFTI
- roiToSubjectPackageRoi
- cloneROI
- createSceneAsset
- loadSceneAsset
- validateSceneManifest
- exportScene
- exportSceneJSON
- exportSceneBlob
- exportStaticHTML
- deserialize
- serialize
- encode
- decode
- migrateViewerState
- migrateV1toV2
- createColormapTexture
- computePickInfo
- detectCapabilities
- computeMeanCurvature
- computeSulcalDepth
- normalizeCurvature
- curvatureToGrayscale
- buildVertexAdjacency
- compositeStraightRGBA
- compositeStraightRGBABuffer
- premultiplyStraightRGBA
- computeFDRThreshold
- computeBonferroniThreshold
- findClusters
- filterClustersBySize
- pToZ
- tToZ