Skip to content
Neuroglancer
neuroglancer.viewer_state.StarredSegments.get
Initializing search
    neuroglancer
    • User Guide
    • Concepts
    • Data sources
    • JSON API
    • Python API
    neuroglancer
      • Navigation
      • Coordinate spaces
      • Data view
      • Layer
    • Data sources
      • API Reference
      • API Reference
        • Core
        • Viewer state
          • C SidePanelLocation
          • C ToolPalette
          • C SelectedLayerState
          • C StatisticsDisplayState
          • C LayerSidePanelState
          • C LayerListPanelState
          • C HelpPanelState
          • C DimensionPlaybackVelocity
          • C CoordinateSpaceTransform
          • C LayerDataSubsource
          • C LayerDataSource
          • C LayerDataSources
          • C InvlerpParameters
          • C TransferFunctionParameters
          • C SkeletonRenderingOptions
          • C StarredSegments
            • Public members
              • M __init__
              • M copy
              • M __len__
              • M __contains__
              • M keys
              • M values
              • M items
              • M __eq__
              • M add
              • M get
                • Parameters
                  • p segment_id
                • Returns
              • M __getitem__
              • M remove
              • M discard
              • M __setitem__
              • M __delitem__
              • M clear
              • M __repr__
              • M update
              • M to_json
              • P visible
          • C VisibleSegments
          • C PointAnnotation
          • C LineAnnotation
          • C PolyLineAnnotation
          • C AxisAlignedBoundingBoxAnnotation
          • C EllipsoidAnnotation
          • C AnnotationPropertySpec
          • C Layers
          • C LinkedType
          • C LinkedPosition
          • C LinkedZoomFactor
          • C LinkedDepthRange
          • C LinkedOrientationState
          • C CrossSection
          • C CrossSectionMap
          • C DataPanelLayout
          • C StackLayout
          • F row_layout
          • F column_layout
          • C LayerGroupViewer
          • C ViewerState
          • C Annotation
          • Segment sets
          • URL representation
          • Coordinate space
          • Layers
          • Tools
        • Viewer Config state
        • Exposing local data as data source
        • Credentials
        • Capturing Screenshots
        • Server
        • Utilities
    • Parameters
      • p segment_id
    • Returns
    neuroglancer.viewer_state.StarredSegments.get(
        
    segment_id: int,
    ) 
    -> bool | None
    neuroglancer.viewer_state.StarredSegments.get[T](
        
    segment_id: int, default: T
    ) 
    -> bool | T

    Checks if a segment is visible.

    Parameters:¶
    segment_id: int¶

    Segment to check.

    default: T

    Return value if segment_id is not starred.

    Returns:¶

    True if visible, False if starred but not visible, default if not starred.

    © Copyright 2021 The Neuroglancer Authors.
    Created using Sphinx 8.1.3. and Sphinx-Immaterial