Neuroglancer

https://neuroglancer-docs.web.app/
Admin
Neuroglancer is a WebGL-based viewer for volumetric data that displays arbitrary cross-sectional...
Tokens:109,872
Snippets:1,075
Trust Score:7.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example PrecomputedVolume Metadata

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

This is an example of the PrecomputedVolume metadata structure, illustrating the configuration for multiple scales of a JPEG-encoded volume.

```json
{
  "data_type": "uint8",
  "num_channels": 1,
  "scales": [ {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "8_8_8",
      "resolution": [8, 8, 8],
      "size": [6446, 6643, 8090],
      "voxel_offset": [0, 0, 0]
    },
    {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "16_16_16",
      "resolution": [16, 16, 16],
      "size": [3223, 3321, 4045],
      "voxel_offset": [0, 0, 0]
    },
    {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "32_32_32",
      "resolution": [32, 32, 32],
      "size": [1611, 1660, 2022],
      "voxel_offset": [0, 0, 0]
    },
    {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "64_64_64",
      "resolution": [64, 64, 64],
      "size": [805, 830, 1011],
      "voxel_offset": [0, 0, 0]
    },
    {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "128_128_128",
      "resolution": [128, 128, 128],
      "size": [402, 415, 505],
      "voxel_offset": [0, 0, 0]
    },
    {
      "chunk_sizes": [[64, 64, 64]],
      "encoding": "jpeg",
      "key": "256_256_256",
      "resolution": [256, 256, 256],
      "size": [201, 207, 252],
      "voxel_offset": [0, 0, 0]
    }
  ]
}
```

--------------------------------

### Scale Key Example

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Specifies the relative path to the directory containing chunk data for a specific resolution scale.

```string
"8_8_8"
```

--------------------------------

### Scale Key Example with Path

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Specifies the relative path to the directory containing chunk data for a specific resolution scale, including a path to another volume.

```string
"../other_volume/8_8_8"
```

--------------------------------

### Volume Size Example

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Defines the dimensions of the volume in voxels, specified in XYZ order.

```json
[500, 500, 500]
```

--------------------------------

### Chunk Sizes Example (Single)

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Specifies the chunk dimensions in XYZ order for a single chunk shape.

```json
[[64, 64, 64]]
```

--------------------------------

### Chunk Sizes Example (Multiple)

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Specifies multiple chunk dimensions in XYZ order to optimize different read access patterns. For each specified chunk shape, a separate copy of the data must be stored.

```json
[[512, 512, 1], [512, 1, 512], [1, 512, 512]]
```

--------------------------------

### Tool Constructor

Source: https://neuroglancer-docs.web.app/python/api/Tool.__init__.html

Initializes the Tool class. Refer to the help() function for the accurate signature and parameter details.

```APIDOC
## Tool(*args, **kwargs)

### Description
Initializes the Tool class.

### Method
__init__

### Parameters
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.

### See Also
help(type(self))
```

--------------------------------

### ImageLayer Constructor

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.__init__.html

Initializes an ImageLayer. Refer to the help() function for the accurate signature.

```APIDOC
## ImageLayer(*args, **kwargs)

### Description
Initializes the ImageLayer object.

### Method
__init__

### Parameters
- ***args**: Variable length argument list.
- ****kwargs**: Arbitrary keyword arguments.

### Remarks
See help(type(self)) for accurate signature.
```

--------------------------------

### Raw Chunk Encoding Example

Source: https://neuroglancer-docs.web.app/datasource/precomputed/volume.html

Describes the raw chunk encoding format, where data is stored directly in little-endian binary format without any header. This example specifies dimensions and data type to calculate the expected chunk size.

```plaintext
Supported `data_type` | Any  
---|---
Supported `num_channels` | Any  

```

--------------------------------

### Get Item

Source: https://neuroglancer-docs.web.app/python/api/List.html

Retrieves an element from the list at a specific index.

```APIDOC
## Get Item

### Description
Returns the element at the specified index.

### Method
__getitem__

### Parameters
- **key** (int) - The index of the element to retrieve.

### Returns
- **T** - The element at the specified index.
```

--------------------------------

### Get Output Dimensions

Source: https://neuroglancer-docs.web.app/python/api/CoordinateSpaceTransform.output_dimensions.html

Retrieves the output CoordinateSpace of the transform.

```APIDOC
## CoordinateSpaceTransform.outputDimensions

### Description
Returns the output CoordinateSpace of the transform.

### Method
Attribute Access

### Parameters
None

### Response
- **outputDimensions** (CoordinateSpace) - The output CoordinateSpace.
```

--------------------------------

### OpacityTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/OpacityTool.html

Initializes an OpacityTool instance. This can be done with or without arguments.

```APIDOC
## OpacityTool

### Description
Initializes an OpacityTool instance.

### Method
__init__

### Parameters
- `*args`: Variable length argument list.
- `**kwargs`: Arbitrary keyword arguments.

### Example
```python
opacity_tool = OpacityTool()
```
```

--------------------------------

### Viewer Initialization

Source: https://neuroglancer-docs.web.app/python/api/Viewer.html

Initializes the Viewer object. Accepts arbitrary keyword arguments.

```APIDOC
## Viewer()

### Description
Initializes the Viewer object.

### Parameters
Accepts arbitrary keyword arguments.
```

--------------------------------

### get

Source: https://neuroglancer-docs.web.app/python/api/read_precomputed_annotations.AnnotationMap.html

Asynchronously reads a value from the annotation map, returning a Future.

```APIDOC
## get(key: K, batch: Batch | None = `None`) -> Future[V | None]

### Description
Reads a value associated with the given key, returning a Future that will resolve to the value or None if the key is not found.

### Parameters
- **key** (K) - The key to look up.
- **batch** (Batch | None) - An optional batch object for batched operations.

### Returns
- **Future[V | None]** - A Future that resolves to the value or None.
```

--------------------------------

### Get Total Screenshot Statistics

Source: https://neuroglancer-docs.web.app/python/api/ScreenshotStatistics.total.html

Retrieves the aggregated statistics for all screenshots.

```APIDOC
## Get Total Screenshot Statistics

### Description
Retrieves the aggregated statistics for all screenshots.

### Method
GET

### Endpoint
/screenshots/statistics/total

### Response
#### Success Response (200)
- **statistics** (AggregateChunkSourceStatistics) - The aggregated statistics object.
```

--------------------------------

### PlacePolylineTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/PlacePolylineTool.html

Initializes a new instance of the PlacePolylineTool. See help(type(self)) for accurate signature details.

```APIDOC
## PlacePolylineTool(*args, **kwargs)

### Description
Initializes a new instance of the PlacePolylineTool.

### Parameters
* **args**: Variable length argument list.
* **kwargs**: Arbitrary keyword arguments.

### See Also
help(type(self))
```

--------------------------------

### Get Map Length

Source: https://neuroglancer-docs.web.app/python/api/CrossSectionMap.html

Returns the number of entries currently in the CrossSectionMap.

```APIDOC
## __len__() -> int

### Description
Returns the number of entries in the map.

### Method
__len__
```

--------------------------------

### Get Viewer Position

Source: https://neuroglancer-docs.web.app/python/api/ViewerState.position.html

Retrieves the current position of the viewer in voxel coordinates.

```APIDOC
## Get Viewer Position

### Description
Retrieves the current position of the viewer in voxel coordinates.

### Method
GET

### Endpoint
/viewer_state/position

### Response
#### Success Response (200)
- **position** (NDArray[float32] | None) - The current voxel coordinates of the viewer.
```

--------------------------------

### AnnotationLayer Initialization

Source: https://neuroglancer-docs.web.app/python/api/AnnotationLayer.__init__.html

Initializes the AnnotationLayer. Refer to the help() function for the accurate signature.

```APIDOC
## AnnotationLayer(*args, **kwargs)

### Description
Initializes the AnnotationLayer.

### Parameters
*args: Arguments passed to the initializer.
**kwargs: Keyword arguments passed to the initializer.

### See Also
help(type(self))
```

--------------------------------

### SegmentationLayer.crossSectionRenderScale

Source: https://neuroglancer-docs.web.app/python/api/SegmentationLayer.cross_section_render_scale.html

Gets or sets the render scale for cross-section views of the segmentation layer.

```APIDOC
## SegmentationLayer.crossSectionRenderScale

### Description

Gets or sets the render scale for cross-section views of the segmentation layer. This property controls how the segmentation is scaled when viewed in a cross-section.

### Method

Property Access (Getter/Setter)

### Parameters

This property does not take any parameters for direct access. It is a direct attribute of the SegmentationLayer object.

### Response

#### Success Response

- **crossSectionRenderScale** (float) - The current render scale value for cross-section views. This is a floating-point number.

### Request Example

```python
# Get the current render scale
current_scale = segmentation_layer.crossSectionRenderScale

# Set a new render scale
segmentation_layer.crossSectionRenderScale = 2.5
```

### Response Example

```json
2.5
```
```

--------------------------------

### LocalVolume Initialization

Source: https://neuroglancer-docs.web.app/python/api/LocalVolume.__init__.html

Initializes a LocalVolume with specified data and configuration options.

```APIDOC
## LocalVolume Initialization

### Description
Initializes a LocalVolume with specified data and configuration options.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (any) - Required - Source data.
- **dimensions** (any) - Optional - Dimensions of the volume.
- **volume_type** (string) - Optional - Type of the volume, either 'image' or 'segmentation'. Guessed from data type if not specified.
- **voxel_offset** (any) - Optional - Offset of the voxels.
- **encoding** (string) - Optional - Encoding format for the data, defaults to "npz".
- **max_voxels_per_chunk_log2** (integer) - Optional - Maximum number of voxels per chunk in log2 scale.
- **mesh_options** (dict) - Optional - Options for mesh simplification for 'segmentation' volumes. See details below.
- **downsampling** (string) - Optional - Method for downsampling. '3d' for isotropic, '2d' for separate XY, XZ, YZ downsampling, or None for no downsampling. Defaults to "3d".
- **chunk_layout** (any) - Optional - Layout of the chunks.
- **max_downsampling** (integer) - Optional - Maximum amount by which on-the-fly downsampling may reduce the volume of a chunk. Defaults to 64.
- **max_downsampled_size** (integer) - Optional - Maximum size of the downsampled volume. Defaults to 128.
- **max_downsampling_scales** (float) - Optional - Maximum scales for downsampling. Defaults to infinity.

### Mesh Options Details
- **max_quadrics_error** (float) - Optional - Edge collapses with a larger associated quadric error than this amount are prohibited. Set to a negative number to disable mesh simplification. Defaults to 1e6.
- **max_normal_angle_deviation** (float) - Optional - Edge collapses that change a triangle normal by more than this angle (in degrees) are prohibited. Defaults to 90.
- **lock_boundary_vertices** (bool) - Optional - Retain all vertices along mesh surface boundaries. Defaults to true.

### Request Example
```python
neuroglancer.LocalVolume(
    data=my_data,
    dimensions=my_dimensions,
    volume_type='image',
    encoding='npz',
    downsampling='3d',
    max_downsampling=64,
    mesh_options={
        "max_quadrics_error": 1e6,
        "max_normal_angle_deviation": 90,
        "lock_boundary_vertices": True
    }
)
```

### Response
#### Success Response (200)
N/A (This is an initialization method, not an API endpoint with a response).

#### Response Example
N/A
```

--------------------------------

### PlaceEllipsoidTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/PlaceEllipsoidTool.html

Initializes a new instance of the PlaceEllipsoidTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## PlaceEllipsoidTool

### Description
Initializes a new instance of the PlaceEllipsoidTool.

### Method
__init__

### Parameters
Accepts arbitrary positional and keyword arguments (*args, **kwargs).

### Example
```python
from neuroglancer.viewer_state import PlaceEllipsoidTool

tool = PlaceEllipsoidTool()
```
```

--------------------------------

### SegmentationLayer.color_seed

Source: https://neuroglancer-docs.web.app/python/api/SegmentationLayer.color_seed.html

Sets or gets the integer seed used for color generation in the SegmentationLayer.

```APIDOC
## SegmentationLayer.color_seed

### Description

Sets or gets the integer seed used for color generation in the SegmentationLayer. This property influences the deterministic generation of colors for segmentation masks.

### Type

`int`

### Usage

```python
# Get the current color seed
current_seed = segmentation_layer.color_seed

# Set a new color seed
segmentation_layer.color_seed = 12345
```
```

--------------------------------

### ScreenshotSaver Initialization

Source: https://neuroglancer-docs.web.app/python/api/ScreenshotSaver.__init__.html

Initializes the ScreenshotSaver with a viewer and a directory path.

```APIDOC
## ScreenshotSaver(viewer, directory)

### Description
Initializes the ScreenshotSaver.

### Parameters
- **viewer**: The neuroglancer viewer object.
- **directory**: The directory path where screenshots will be saved.
```

--------------------------------

### ImageLayer.volume_rendering

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.volume_rendering_mode.html

Alias for volume_rendering_mode. Sets or gets the volume rendering mode for the ImageLayer.

```APIDOC
## ImageLayer.volume_rendering

### Description

An alias for `volume_rendering_mode`. This property allows setting or getting the volume rendering mode of the ImageLayer. It accepts a boolean or a string.

### Method

GET/SET

### Endpoint

Not applicable (SDK property)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **volume_rendering** (bool | str) - Required - The desired volume rendering mode.

### Request Example

```json
{
  "volume_rendering": "additive"
}
```

### Response

#### Success Response (200)

- **volume_rendering** (bool | str) - The current volume rendering mode.

#### Response Example

```json
{
  "volume_rendering": false
}
```
```

--------------------------------

### VolumeRenderingGainTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/VolumeRenderingGainTool.html

Initializes a new instance of the VolumeRenderingGainTool. This tool is associated with a specific layer for volume rendering gain adjustments.

```APIDOC
## VolumeRenderingGainTool

### Description
Initializes a VolumeRenderingGainTool. This tool is used to adjust volume rendering gain for a specific layer.

### Method
__init__

### Parameters
- **args**: Variable length argument list.
- **kwargs**: Arbitrary keyword arguments.

### Attributes
- **TOOL_TYPE**: str = "volumeRenderingGain"
- **layer**: str | None - Name of the layer to which this tool applies.
- **type**: str
```

--------------------------------

### ImageLayer.VolumeRendering

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.volume_rendering_mode.html

Alias for volume_rendering_mode. Sets or gets the volume rendering mode for the ImageLayer.

```APIDOC
## ImageLayer.VolumeRendering

### Description

An alias for `volume_rendering_mode`. This property allows setting or getting the volume rendering mode of the ImageLayer. It accepts a boolean or a string.

### Method

GET/SET

### Endpoint

Not applicable (SDK property)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **VolumeRendering** (bool | str) - Required - The desired volume rendering mode.

### Request Example

```json
{
  "VolumeRendering": "mip"
}
```

### Response

#### Success Response (200)

- **VolumeRendering** (bool | str) - The current volume rendering mode.

#### Response Example

```json
{
  "VolumeRendering": true
}
```
```

--------------------------------

### Tool Class Initialization

Source: https://neuroglancer-docs.web.app/python/api/Tool.html

Initializes a Tool object. See help(type(self)) for accurate signature.

```APIDOC
## Tool(*args, **kwargs)

### Description
Initializes a Tool object.

### Parameters
* `*args`: Variable length argument list.
* `**kwargs`: Arbitrary keyword arguments.

### Returns
An initialized Tool object.
```

--------------------------------

### ImageLayer.volumeRenderingMode

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.volume_rendering_mode.html

Alias for volume_rendering_mode. Sets or gets the volume rendering mode for the ImageLayer.

```APIDOC
## ImageLayer.volumeRenderingMode

### Description

An alias for `volume_rendering_mode`. This property allows setting or getting the volume rendering mode of the ImageLayer. It accepts a boolean or a string.

### Method

GET/SET

### Endpoint

Not applicable (SDK property)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **volumeRenderingMode** (bool | str) - Required - The desired volume rendering mode.

### Request Example

```json
{
  "volumeRenderingMode": false
}
```

### Response

#### Success Response (200)

- **volumeRenderingMode** (bool | str) - The current volume rendering mode.

#### Response Example

```json
{
  "volumeRenderingMode": true
}
```
```

--------------------------------

### ScreenshotSaver Constructor

Source: https://neuroglancer-docs.web.app/python/api/ScreenshotSaver.html

Initializes the ScreenshotSaver with a viewer and a directory to save screenshots.

```APIDOC
## ScreenshotSaver(viewer, directory)

### Description
Initializes the ScreenshotSaver.

### Parameters
- **viewer**: The viewer object associated with the screenshots.
- **directory**: The directory where screenshots will be saved.
```

--------------------------------

### ImageLayer.volume_rendering_mode

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.volume_rendering_mode.html

Sets or gets the volume rendering mode for the ImageLayer. This can be a boolean or a string.

```APIDOC
## ImageLayer.volume_rendering_mode

### Description

Controls the volume rendering mode of the ImageLayer. Accepts a boolean or a string value.

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

- **volume_rendering_mode** (bool | str) - Required - The desired volume rendering mode.

### Request Example

```json
{
  "volume_rendering_mode": true
}
```

### Response

#### Success Response (200)

- **volume_rendering_mode** (bool | str) - The current volume rendering mode.

#### Response Example

```json
{
  "volume_rendering_mode": "raycasting"
}
```
```

--------------------------------

### DataPanelLayout.orthographic_projection

Source: https://neuroglancer-docs.web.app/python/api/DataPanelLayout.html

Gets or sets a boolean indicating whether orthographic projection is enabled.

```APIDOC
## DataPanelLayout.orthographic_projection

### Description
Gets or sets a boolean indicating whether orthographic projection is enabled.

### Type
bool
```

--------------------------------

### ConfigState Initialization

Source: https://neuroglancer-docs.web.app/python/api/ConfigState.html

Initializes the ConfigState object. Accepts JSON data and optional keyword arguments.

```APIDOC
## ConfigState Constructor

### Description
Initializes the ConfigState object. See help(type(self)) for accurate signature.

### Parameters
- **json_data** (str | None) - Optional JSON data to initialize the state.
- **_readonly** (bool) - Internal flag, typically False.
- **kwargs** - Additional keyword arguments.
```

--------------------------------

### Get Map Keys

Source: https://neuroglancer-docs.web.app/python/api/CrossSectionMap.html

Returns a dynamic view of the keys present in the CrossSectionMap.

```APIDOC
## keys()

### Description
Returns a dynamic view of the keys in the map.

### Method
keys

### Returns
KeysView[str]
```

--------------------------------

### PlaceLineTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/PlaceLineTool.html

Initializes a new instance of the PlaceLineTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## PlaceLineTool()

### Description
Initializes a new instance of the PlaceLineTool.

### Method
`__init__`

### Parameters
Accepts arbitrary positional and keyword arguments (`*args`, `**kwargs`).

### Request Example
```python
from neuroglancer.viewer_state import PlaceLineTool

# Example initialization
line_tool = PlaceLineTool()
```
```

--------------------------------

### Accessing Viewer State

Source: https://neuroglancer-docs.web.app/python/api/ActionState.viewer_state.html

Provides information on how to get the current viewer state.

```APIDOC
## Get Viewer State

### Description
Retrieves the current state of the viewer.

### Method
GET

### Endpoint
/viewer/state

### Response
#### Success Response (200)
- **viewerState** (ViewerState) - The current state object of the viewer.

### Response Example
```json
{
  "viewerState": {
    "someField": "someValue"
  }
}
```
```

--------------------------------

### SelectedAlphaTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/SelectedAlphaTool.html

Initializes a new instance of the SelectedAlphaTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## SelectedAlphaTool(*args, **kwargs)

### Description
Initializes self. See help(type(self)) for accurate signature.

### Parameters
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.
```

--------------------------------

### Get Mouse Position

Source: https://neuroglancer-docs.web.app/python/api/ActionState.mouse_position.html

Retrieves the current mouse position in pixel coordinates.

```APIDOC
## ActionState.mouse_position

### Description

Gets the current mouse position in pixel coordinates.

### Type

NDArray[float32] | None
```

--------------------------------

### ConfigState Methods

Source: https://neuroglancer-docs.web.app/python/api/ConfigState.html

Details the methods available on the ConfigState class.

```APIDOC
## ConfigState Methods

### to_json()

#### Description
Converts the ConfigState object to a JSON string.

### __eq__(other)

#### Description
Compares this ConfigState object with another object for equality.

### __repr__()

#### Description
Returns a string representation of the ConfigState object.
```

--------------------------------

### DataPanelLayout Initialization

Source: https://neuroglancer-docs.web.app/python/api/DataPanelLayout.__init__.html

Initializes a new instance of the DataPanelLayout class. Accepts optional JSON data and keyword arguments.

```APIDOC
## DataPanelLayout Constructor

### Description
Initializes a new instance of the DataPanelLayout class. See help(type(self)) for accurate signature.

### Parameters
- `json_data` (string, optional): JSON data to initialize the layout from. Defaults to None.
- `_readonly` (bool, optional): Flag to indicate if the layout is read-only. Defaults to False.
- `**kwargs`: Additional keyword arguments.
```

--------------------------------

### Get Number of Starred Segments

Source: https://neuroglancer-docs.web.app/python/api/StarredSegments.html

Returns the total number of segments that are currently starred.

```APIDOC
## Get Number of Starred Segments

### Description
Returns the total number of segments that are currently starred.

### Method
__len__()

### Returns
(int) The number of starred segments.
```

--------------------------------

### PlaceBoundingBoxTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/PlaceBoundingBoxTool.html

Initializes a new instance of the PlaceBoundingBoxTool. This tool is used for annotating bounding boxes.

```APIDOC
## PlaceBoundingBoxTool()

### Description
Initializes a new instance of the PlaceBoundingBoxTool. This tool is used for annotating bounding boxes.

### Method
__init__

### Parameters
* **args**: Variable length argument list.
* **kwargs**: Arbitrary keyword arguments.

### Returns
An initialized instance of PlaceBoundingBoxTool.
```

--------------------------------

### Actions Initialization

Source: https://neuroglancer-docs.web.app/python/api/Actions.__init__.html

Initializes the Actions class. Refer to the class signature for detailed parameter information.

```APIDOC
## Actions(set_config)

### Description
Initializes the Actions class. See help(type(self)) for accurate signature.

### Method
__init__

### Parameters
- **set_config**: (callable) - A callable function to set the configuration.

### Code Example
```python
from neuroglancer.viewer_config_state import Actions

def my_set_config_function(config):
    # Logic to update configuration
    pass

actions_instance = Actions(my_set_config_function)
```
```

--------------------------------

### LayerSelectionState.local_position

Source: https://neuroglancer-docs.web.app/python/api/LayerSelectionState.local_position.html

Gets or sets the local position of the selected layer. This is an NDArray of float32 or None.

```APIDOC
## LayerSelectionState.local_position

### Description
Gets or sets the local position of the selected layer. This is an NDArray of float32 or None.

### Type
NDArray[float32] | None
```

--------------------------------

### ColorSeedTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/ColorSeedTool.html

Initializes a new instance of the ColorSeedTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## ColorSeedTool(*args, **kwargs)

### Description
Initializes self. See help(type(self)) for accurate signature.

### Method
__init__
```

--------------------------------

### Get Item from Map

Source: https://neuroglancer-docs.web.app/python/api/CrossSectionMap.html

Retrieves an item from the map by its key, with optional default value.

```APIDOC
## get(key: str, default: T = None) -> CrossSection | T

### Description
Returns the mapped value associated with the key, or the specified default value if the key is not found.

### Method
get

### Parameters
- **key** (str) - Required - The key of the item to retrieve.
- **default** (T) - Optional - The default value to return if the key is not found.
```

--------------------------------

### BlendTool Initialization and Usage

Source: https://neuroglancer-docs.web.app/python/api/BlendTool.html

This snippet covers the initialization of the BlendTool and its core functionalities, including layer targeting and JSON serialization.

```APIDOC
## Class: BlendTool

### Description
Represents a tool for blending layers in the Neuroglancer viewer.

### Public Members

- **TOOL_TYPE**: `str` = `"blend"`
  - Type identifier for the blend tool.

- **layer**: `str` | `None`
  - The name of the layer to which this tool applies. Can be `None`.

- **type**: `str`
  - The type of the tool.

### Methods

- **BlendTool(*args, **kwargs)**
  - Initializes the BlendTool instance. Use `help(type(self))` for detailed signature.

- **_static _BlendTool(cls, json_data=None, _readonly=False, ...)**
  - A static method to coerce arguments into a `Tool` object, specifically for `BlendTool`.

- **to_json()**
  - Serializes the BlendTool instance to a JSON-compatible format.

- **__eq__(other)**
  - Compares this BlendTool instance with another object for equality.

- **__repr__()**
  - Returns a string representation of the BlendTool instance.
```

--------------------------------

### Get Map Items

Source: https://neuroglancer-docs.web.app/python/api/CrossSectionMap.html

Returns a dynamic view of the key-value pairs (items) in the CrossSectionMap.

```APIDOC
## items()

### Description
Returns a dynamic view of the items in the map.

### Method
items

### Returns
ItemsView[str, CrossSection]
```

--------------------------------

### MeshSilhouetteRenderingTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/MeshSilhouetteRenderingTool.html

Initializes a new instance of the MeshSilhouetteRenderingTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## MeshSilhouetteRenderingTool()

### Description
Initializes a new instance of the MeshSilhouetteRenderingTool.

### Method
__init__

### Parameters
Accepts arbitrary positional and keyword arguments.

### Request Example
```python
MeshSilhouetteRenderingTool(arg1, kwarg1='value')
```

### Response Example
```python
<MeshSilhouetteRenderingTool object>
```
```

--------------------------------

### Get Map Values

Source: https://neuroglancer-docs.web.app/python/api/CrossSectionMap.html

Returns a dynamic view of the values (CrossSection objects) in the CrossSectionMap.

```APIDOC
## values()

### Description
Returns a dynamic view of the values in the map.

### Method
values

### Returns
ValuesView[CrossSection]
```

--------------------------------

### UnsynchronizedViewer Initialization

Source: https://neuroglancer-docs.web.app/python/api/UnsynchronizedViewer.__init__.html

Initializes the UnsynchronizedViewer. For detailed signature information, refer to the help() function for this type.

```APIDOC
## neuroglancer.UnsynchronizedViewer(**kwargs)

### Description
Initializes the UnsynchronizedViewer.

### Parameters
#### Keyword Arguments
- **kwargs**: Arbitrary keyword arguments. See help(type(self)) for accurate signature.
```

--------------------------------

### Get Screenshot Statistics

Source: https://neuroglancer-docs.web.app/python/api/ActionState.screenshot_statistics.html

Retrieves the current screenshot statistics. This can be None if no statistics are available.

```APIDOC
## Get Screenshot Statistics

### Description
Retrieves the current screenshot statistics. This can be None if no statistics are available.

### Method
GET (implied)

### Endpoint
/action/screenshot_statistics

### Response
#### Success Response (200)
- **screenshot_statistics** (ScreenshotStatistics | None) - The screenshot statistics object or None.
```

--------------------------------

### ToolPalette Initialization

Source: https://neuroglancer-docs.web.app/python/api/ToolPalette.html

Initializes a ToolPalette instance. Accepts JSON data for pre-configuration or keyword arguments.

```APIDOC
## ToolPalette Constructor

### Description
Initializes a ToolPalette instance. See help(type(self)) for accurate signature.

### Parameters
- **json_data** (str | None) - Optional - JSON data to initialize the ToolPalette.
- **_readonly** (bool) - Internal flag, defaults to False.
- ****kwargs** - Additional keyword arguments.
```

--------------------------------

### Get Mouse Voxel Coordinates

Source: https://neuroglancer-docs.web.app/python/api/ActionState.mouse_position.html

Retrieves the current mouse position in voxel coordinates.

```APIDOC
## ActionState.mouse_voxel_coordinates

### Description

Gets the current mouse position in voxel coordinates.

### Type

NDArray[float32] | None
```

--------------------------------

### LocalVolume Initialization

Source: https://neuroglancer-docs.web.app/python/api/LocalVolume.html

Initializes a LocalVolume with provided data and optional dimensions and volume type.

```APIDOC
## LocalVolume Constructor

### Description
Initializes a LocalVolume with provided data and optional dimensions and volume type.

### Parameters
- **data**: The local array data.
- **dimensions** (optional): The dimensions of the volume.
- **volume_type** (optional): The type of the volume.
```

--------------------------------

### Get Object Alpha

Source: https://neuroglancer-docs.web.app/python/api/SegmentationLayer.object_alpha.html

Retrieve the current object alpha transparency setting for the segmentation layer.

```APIDOC
## SegmentationLayer.objectAlpha

### Description
Gets the current transparency for individual objects in the segmentation layer.

### Property
`objectAlpha` (float)

### Return Value
A float representing the current transparency (0.0 to 1.0).

### Example
```python
# Assuming 'layer' is an instance of SegmentationLayer
current_alpha = layer.objectAlpha
print(f"Current object alpha: {current_alpha}")
```
```

--------------------------------

### LineAnnotation Constructor

Source: https://neuroglancer-docs.web.app/python/api/LineAnnotation.__init__.html

Initializes a new instance of the LineAnnotation class. Refer to the help() function for the accurate signature.

```APIDOC
## LineAnnotation(*args, **kwargs)

### Description
Initializes self. See help(type(self)) for accurate signature.

### Parameters
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.

### See Also
help(type(self))
```

--------------------------------

### SegmentationLayer.meshRenderScale

Source: https://neuroglancer-docs.web.app/python/api/SegmentationLayer.mesh_render_scale.html

Sets or gets the rendering scale for meshes associated with a SegmentationLayer. This property is a float value.

```APIDOC
## SegmentationLayer.meshRenderScale

### Description

Controls the rendering scale of meshes within the SegmentationLayer.

### Type

float

### Usage

```python
# Get the current mesh render scale
scale = segmentation_layer.meshRenderScale

# Set a new mesh render scale
segmentation_layer.meshRenderScale = 2.0
```
```

--------------------------------

### ImageLayer.crossSectionRenderScale

Source: https://neuroglancer-docs.web.app/python/api/ImageLayer.cross_section_render_scale.html

Gets or sets the rendering scale for cross-sections of the ImageLayer. This property accepts a float value.

```APIDOC
## ImageLayer.crossSectionRenderScale

### Description

Gets or sets the rendering scale for cross-sections of the ImageLayer. This property accepts a float value.

### Type

float
```

--------------------------------

### DataPanelLayout.crossSections

Source: https://neuroglancer-docs.web.app/python/api/DataPanelLayout.html

Gets or sets the cross-section mappings for the data panel layout (alternative property name).

```APIDOC
## DataPanelLayout.crossSections

### Description
Gets or sets the cross-section mappings for the data panel layout (alternative property name).

### Type
Map[str, str]
```

--------------------------------

### PrefetchState Methods

Source: https://neuroglancer-docs.web.app/python/api/PrefetchState.html

Available methods for the PrefetchState class.

```APIDOC
## PrefetchState Methods

### to_json()

#### Description
Converts the PrefetchState object to its JSON representation.

### __eq__(other)

#### Description
Compares the current PrefetchState object with another object for equality.

#### Parameters
- **other** (any) - The object to compare with.

#### Returns
- **bool**: True if the objects are equal, False otherwise.

### __repr__()

#### Description
Returns a string representation of the PrefetchState object.
```

--------------------------------

### PrefetchState Initialization

Source: https://neuroglancer-docs.web.app/python/api/PrefetchState.html

Initializes a PrefetchState object. It can be initialized with JSON data or keyword arguments.

```APIDOC
## PrefetchState Constructor

### Description
Initializes a PrefetchState object. See help(type(self)) for accurate signature.

### Parameters
- **json_data** (any) - Optional - JSON data to initialize the state.
- **_readonly** (bool) - Optional - Flag to indicate if the state is read-only.
- **kwargs** (any) - Additional keyword arguments.
```

--------------------------------

### ViewerState.cross_section_background_color

Source: https://neuroglancer-docs.web.app/python/api/ViewerState.cross_section_background_color.html

Gets or sets the background color for cross-sections. The color is represented as a string (e.g., '#RRGGBB') or None.

```APIDOC
## ViewerState.cross_section_background_color

### Description
Gets or sets the background color for cross-sections. The color is represented as a string (e.g., '#RRGGBB') or None.

### Method Signature
`ViewerState.cross_section_background_color: str | None`

### Usage
```python
# Get the current cross-section background color
background_color = viewer_state.cross_section_background_color

# Set a new cross-section background color
viewer_state.cross_section_background_color = '#FFFFFF' # White

# Set to no background color
viewer_state.cross_section_background_color = None
```

### Return Value
- `str | None`: The current background color as a hex string (e.g., '#RRGGBB') or `None` if no color is set.
```

--------------------------------

### Get Starred Segment Keys

Source: https://neuroglancer-docs.web.app/python/api/StarredSegments.html

Returns a view object that displays a list of all the starred segment IDs.

```APIDOC
## Get Starred Segment Keys

### Description
Returns a view object that displays a list of all the starred segment IDs.

### Method
keys()

### Returns
KeysView[int] A view of the starred segment IDs.
```

--------------------------------

### SkeletonRenderingOptions Constructor

Source: https://neuroglancer-docs.web.app/python/api/SkeletonRenderingOptions.html

Information about initializing a SkeletonRenderingOptions object.

```APIDOC
## SkeletonRenderingOptions()

### Description
Initializes the SkeletonRenderingOptions object.

### Parameters
- **json_data** (optional): JSON data to initialize the object from.
- **_readonly** (optional): Flag indicating if the object is read-only.
- **kwargs**: Additional keyword arguments.
```

--------------------------------

### Accessing Cross Section Orientation

Source: https://neuroglancer-docs.web.app/python/api/LayerGroupViewer.cross_section_orientation.html

Demonstrates how to get the current cross-section orientation state from a LayerGroupViewer instance.

```APIDOC
## Get Cross Section Orientation

### Description
Retrieves the current orientation state for cross-sections within the LayerGroupViewer.

### Method
Attribute Access

### Endpoint
N/A (SDK Method)

### Parameters
None

### Response
#### Success Response
- **crossSectionOrientation** (LinkedOrientationState) - The current orientation state of the cross-section.
```

--------------------------------

### ObjectAlphaTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/ObjectAlphaTool.html

Initializes an ObjectAlphaTool instance. This tool is associated with a specific layer and is used for controlling object transparency.

```APIDOC
## ObjectAlphaTool

### Description
Initializes an ObjectAlphaTool instance. This tool is associated with a specific layer and is used for controlling object transparency.

### Method
__init__

### Parameters
- **args**: Variable length argument list.
- **kwargs**: Arbitrary keyword arguments.

### Example
```python
from neuroglancer.viewer_state import ObjectAlphaTool

tool = ObjectAlphaTool()
```
```

--------------------------------

### DataPanelLayout.orthographicProjection

Source: https://neuroglancer-docs.web.app/python/api/DataPanelLayout.html

Gets or sets a boolean indicating whether orthographic projection is enabled (alternative property name).

```APIDOC
## DataPanelLayout.orthographicProjection

### Description
Gets or sets a boolean indicating whether orthographic projection is enabled (alternative property name).

### Type
bool
```

--------------------------------

### Layer Initialization

Source: https://neuroglancer-docs.web.app/python/api/Layer.html

Initializes a Layer object. Accepts JSON data and optional keyword arguments.

```APIDOC
## Layer(json_data=None, _readonly=False, **kwargs)

### Description
Initializes self. See help(type(self)) for accurate signature.

### Parameters
- **json_data** (str | None) - Optional JSON data for initialization.
- **_readonly** (bool) - Flag to indicate if the layer is read-only.
- **kwargs** - Additional keyword arguments.
```

--------------------------------

### ViewerState.crossSectionBackgroundColor

Source: https://neuroglancer-docs.web.app/python/api/ViewerState.cross_section_background_color.html

A property to get or set the cross-section background color. Accepts a string (hex color code) or None.

```APIDOC
## ViewerState.crossSectionBackgroundColor

### Description
This property allows you to retrieve or modify the background color of cross-sections in the viewer. The color can be specified as a hexadecimal string (e.g., '#RRGGBB') or set to `None` to indicate no specific background color.

### Property Signature
`ViewerState.crossSectionBackgroundColor: str | None`

### Usage
```python
# Retrieve the background color
current_color = viewer_state.crossSectionBackgroundColor

# Set a new background color (e.g., black)
viewer_state.crossSectionBackgroundColor = '#000000'

# Remove the background color
viewer_state.crossSectionBackgroundColor = None
```

### Return Value
- `str | None`: Returns the current background color as a hex string or `None`.
```

--------------------------------

### SplitSegmentsTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/SplitSegmentsTool.html

Initializes a new instance of the SplitSegmentsTool. Accepts arbitrary positional and keyword arguments.

```APIDOC
## SplitSegmentsTool

### Description
Initializes a new instance of the SplitSegmentsTool.

### Method Signature
`SplitSegmentsTool(*args, **kwargs)`

### Parameters
- `*args`: Variable length argument list.
- `**kwargs`: Arbitrary keyword arguments.
```

--------------------------------

### Get Segment Visibility

Source: https://neuroglancer-docs.web.app/python/api/StarredSegments.html

Retrieves the visibility state of a given segment ID. Returns None if the segment is not starred.

```APIDOC
## Get Segment Visibility

### Description
Retrieves the visibility state of a given segment ID. Returns None if the segment is not starred.

### Method
get(segment_id: int)

### Parameters
- **segment_id** (int) - The ID of the segment to check.

### Returns
(bool | None) The visibility state of the segment, or None if not starred.
```

--------------------------------

### Get Starred Segment Values

Source: https://neuroglancer-docs.web.app/python/api/StarredSegments.html

Returns a view object that displays the visibility state (True/False) for each starred segment.

```APIDOC
## Get Starred Segment Values

### Description
Returns a view object that displays the visibility state (True/False) for each starred segment.

### Method
values()

### Returns
ValuesView[bool] A view of the visibility state of each starred segment.
```

--------------------------------

### SingleMeshLayer Initialization

Source: https://neuroglancer-docs.web.app/python/api/SingleMeshLayer.html

Initializes a new SingleMeshLayer instance. Accepts arbitrary positional and keyword arguments.

```APIDOC
## SingleMeshLayer(*args, **kwargs)

### Description
Initializes a new SingleMeshLayer instance. Accepts arbitrary positional and keyword arguments.

### Parameters
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.
```

--------------------------------

### PointAnnotationLayer Initialization

Source: https://neuroglancer-docs.web.app/python/api/PointAnnotationLayer.html

Initializes a new PointAnnotationLayer instance. The constructor accepts arbitrary arguments and keyword arguments.

```APIDOC
## PointAnnotationLayer(*args, **kwargs)

### Description
Initializes a new PointAnnotationLayer instance.

### Parameters
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.
```

--------------------------------

### Get Vertex Attribute Sources

Source: https://neuroglancer-docs.web.app/python/api/SingleMeshLayer.vertex_attribute_sources.html

Retrieves the list of vertex attribute sources for the SingleMeshLayer. This can be null if no sources are defined.

```APIDOC
## SingleMeshLayer.vertexAttributeSources

### Description
Gets the list of vertex attribute sources for the SingleMeshLayer.

### Type
List[str] | None
```

--------------------------------

### SegmentationLayer.segment_default_color

Source: https://neuroglancer-docs.web.app/python/api/SegmentationLayer.segment_default_color.html

Gets or sets the default color for segments in the SegmentationLayer. This color is used when a segment does not have a specific color assigned.

```APIDOC
## SegmentationLayer.segment_default_color

### Description

Gets or sets the default color for segments in the SegmentationLayer. This color is used when a segment does not have a specific color assigned.

### Method

Attribute Access (Getter/Setter)

### Parameters

This attribute does not take parameters directly. It is assigned a value.

#### Setter

- **color** (str | None) - Required - The color to set as the default. Can be a color string (e.g., "#RRGGBB") or None to use the system default.

### Response

#### Success Response (Attribute Value)

- **color** (str | None) - The current default segment color.

### Request Example (Setting the color)

```python
segmentation_layer.segment_default_color = "#FF0000"
```

### Request Example (Clearing the color)

```python
segmentation_layer.segment_default_color = None
```

### Response Example (Getting the color)

```python
default_color = segmentation_layer.segment_default_color
print(default_color) # Output: "#FF0000" or None
```
```

--------------------------------

### StatisticsDisplayState Initialization

Source: https://neuroglancer-docs.web.app/python/api/StatisticsDisplayState.html

Initializes a new instance of StatisticsDisplayState. It can be initialized with JSON data or keyword arguments.

```APIDOC
## StatisticsDisplayState Constructor

### Description
Initializes a new instance of the StatisticsDisplayState class.

### Signature
StatisticsDisplayState(json_data=None, _readonly=False, **kwargs)

### Parameters
- **json_data** (str | None) - Optional JSON data to initialize the state from.
- **_readonly** (bool) - Internal flag, typically False.
- **kwargs** - Additional keyword arguments to configure the state.
```

--------------------------------

### Accessing change_count

Source: https://neuroglancer-docs.web.app/python/api/ChangeNotifier.change_count.html

This snippet shows how to access the `change_count` property from the `ChangeNotifier` class to get the total number of changes.

```APIDOC
## ChangeNotifier.change_count

### Description

Provides the total number of changes that have occurred.

### Property

- `change_count` (int) - The total number of changes.
```

--------------------------------

### SaturationTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/SaturationTool.html

Initializes a new instance of the SaturationTool. This tool is associated with a specific layer and is used for adjusting saturation.

```APIDOC
## SaturationTool

### Description
Initializes a new instance of the SaturationTool. This tool is associated with a specific layer and is used for adjusting saturation.

### Method
__init__

### Parameters
- **args**: Variable length argument list.
- **kwargs**: Arbitrary keyword arguments.

### Attributes
- **TOOL_TYPE**: str = "saturation"
- **layer**: str | None - Name of the layer to which this tool applies.
- **type**: str
```

--------------------------------

### PanelResolutionData Initialization and Methods

Source: https://neuroglancer-docs.web.app/python/api/PanelResolutionData.html

This snippet details the constructor and public methods of the PanelResolutionData class, illustrating how to initialize and interact with resolution data.

```APIDOC
## Class: PanelResolutionData

### Description
Represents resolution data for a panel.

### Attributes
- **type** (str): The type of the resolution.
- **width** (int): The width of the panel in pixels.
- **height** (int): The height of the panel in pixels.
- **resolution** (str): A string representing the resolution (e.g., '1920x1080').

### Methods
#### `__init__(self, json_data=None, _readonly=False, **kwargs)`
Initializes a new instance of PanelResolutionData. Accepts optional JSON data and keyword arguments.

#### `to_json(self)`
Converts the PanelResolutionData object to its JSON representation.

#### `__eq__(self, other)`
Compares this PanelResolutionData object with another for equality.

#### `__repr__(self)`
Returns a string representation of the PanelResolutionData object.
```

--------------------------------

### Get Annotation Relationships

Source: https://neuroglancer-docs.web.app/python/api/AnnotationLayer.annotation_relationships.html

Retrieves a list of strings representing the annotation relationships available for the current annotation layer.

```APIDOC
## GET AnnotationLayer.annotationRelationships

### Description
Retrieves a list of strings, where each string represents an annotation relationship.

### Method
GET

### Endpoint
/annotation_layer/annotation_relationships

### Response
#### Success Response (200)
- **annotationRelationships** (List[str]) - A list of strings, each identifying an annotation relationship.

### Response Example
{
  "annotationRelationships": [
    "related_to",
    "part_of"
  ]
}
```

--------------------------------

### Get Mouse Voxel Coordinates (Alternative)

Source: https://neuroglancer-docs.web.app/python/api/ActionState.mouse_position.html

An alternative method to retrieve the current mouse position in voxel coordinates.

```APIDOC
## ActionState.mouseVoxelCoordinates

### Description

Gets the current mouse position in voxel coordinates.

### Type

NDArray[float32] | None
```

--------------------------------

### StackLayout Initialization

Source: https://neuroglancer-docs.web.app/python/api/StackLayout.html

Initializes a StackLayout instance. It can be initialized with JSON data or keyword arguments.

```APIDOC
## StackLayout

### Description
Initializes a StackLayout instance.

### Parameters
- **json_data** (str, optional): JSON data to initialize the layout from. Defaults to None.
- **_readonly** (bool, optional): Whether the layout is read-only. Defaults to False.
- **kwargs**: Additional keyword arguments to initialize the layout with.
```

--------------------------------

### ViewerState.concurrentDownloads

Source: https://neuroglancer-docs.web.app/python/api/ViewerState.concurrent_downloads.html

A public property to get or set the concurrent download limit. It's a Pythonic way to access the underlying setting.

```APIDOC
## ViewerState.concurrentDownloads

### Description

This property provides a Pythonic interface to manage the number of concurrent downloads. It allows you to get the current limit or set a new one. Setting it to `None` removes any limit.

### Property

`concurrentDownloads`

### Type

`int | None`

### Usage

Access this property on a `ViewerState` instance to configure download concurrency.

#### Example

```python
# Get the concurrent download limit
limit = viewer_state.concurrentDownloads

# Set the limit to 10
viewer_state.concurrentDownloads = 10

# Disable the limit
viewer_state.concurrentDownloads = None
```
```

--------------------------------

### PlacePointTool Initialization

Source: https://neuroglancer-docs.web.app/python/api/PlacePointTool.html

Initializes a new instance of the PlacePointTool. The TOOL_TYPE is set to 'annotatePoint'.

```APIDOC
## PlacePointTool

### Description
Initializes a new instance of the PlacePointTool.

### Method
__init__

### Parameters
- `*args`: Variable length argument list.
- `**kwargs`: Arbitrary keyword arguments.

### Example
```python
from neuroglancer.viewer_state import PlacePointTool

# Assuming necessary context or viewer object is available
# tool = PlacePointTool()
```
```

--------------------------------

### Get Starred Segment Items

Source: https://neuroglancer-docs.web.app/python/api/StarredSegments.html

Returns a view object that displays a list of (segment_id, visible) pairs for all starred segments.

```APIDOC
## Get Starred Segment Items

### Description
Returns a view object that displays a list of (segment_id, visible) pairs for all starred segments.

### Method
items()

### Returns
ItemsView[int, bool] A view of the (segment, visible) pairs.
```

--------------------------------

### VolumeRenderingGainTool.__repr__

Source: https://neuroglancer-docs.web.app/python/api/VolumeRenderingGainTool.html

Returns a string representation of the VolumeRenderingGainTool object.

```APIDOC
## __repr__()

### Description
Returns a developer-friendly string representation of the VolumeRenderingGainTool object.

### Method
__repr__
```

--------------------------------

### ScaleBarOptions.max_width_fraction

Source: https://neuroglancer-docs.web.app/python/api/ScaleBarOptions.max_width_fraction.html

Sets or gets the maximum width fraction for the scale bar. This value is a float representing a fraction of the viewport width.

```APIDOC
## ScaleBarOptions.max_width_fraction

### Description

Specifies the maximum width of the scale bar as a fraction of the viewport width. This property is a float.

### Property

- **max_width_fraction** (float) - The maximum width fraction for the scale bar.
```
Tokens:
Raw