# {py:mod}`dss.plot`

```{py:module} dss.plot
```

```{autodoc2-docstring} dss.plot
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ToggleAdvancedTypes <dss.plot.ToggleAdvancedTypes>`
  - ```{autodoc2-docstring} dss.plot.ToggleAdvancedTypes
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`disable <dss.plot.disable>`
  - ```{autodoc2-docstring} dss.plot.disable
    :summary:
    ```
* - {py:obj}`dss_circuit_plot <dss.plot.dss_circuit_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_circuit_plot
    :summary:
    ```
* - {py:obj}`dss_comparecases_plot <dss.plot.dss_comparecases_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_comparecases_plot
    :summary:
    ```
* - {py:obj}`dss_daisy_plot <dss.plot.dss_daisy_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_daisy_plot
    :summary:
    ```
* - {py:obj}`dss_di_plot <dss.plot.dss_di_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_di_plot
    :summary:
    ```
* - {py:obj}`dss_general_data_plot <dss.plot.dss_general_data_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_general_data_plot
    :summary:
    ```
* - {py:obj}`dss_loadshape_plot <dss.plot.dss_loadshape_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_loadshape_plot
    :summary:
    ```
* - {py:obj}`dss_matrix_plot <dss.plot.dss_matrix_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_matrix_plot
    :summary:
    ```
* - {py:obj}`dss_monitor_plot <dss.plot.dss_monitor_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_monitor_plot
    :summary:
    ```
* - {py:obj}`dss_plot <dss.plot.dss_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_plot
    :summary:
    ```
* - {py:obj}`dss_priceshape_plot <dss.plot.dss_priceshape_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_priceshape_plot
    :summary:
    ```
* - {py:obj}`dss_profile_plot <dss.plot.dss_profile_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_profile_plot
    :summary:
    ```
* - {py:obj}`dss_python_cb_plot <dss.plot.dss_python_cb_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_python_cb_plot
    :summary:
    ```
* - {py:obj}`dss_python_cb_write <dss.plot.dss_python_cb_write>`
  - ```{autodoc2-docstring} dss.plot.dss_python_cb_write
    :summary:
    ```
* - {py:obj}`dss_scatter_plot <dss.plot.dss_scatter_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_scatter_plot
    :summary:
    ```
* - {py:obj}`dss_tshape_plot <dss.plot.dss_tshape_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_tshape_plot
    :summary:
    ```
* - {py:obj}`dss_visualize_plot <dss.plot.dss_visualize_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_visualize_plot
    :summary:
    ```
* - {py:obj}`dss_yearly_curve_plot <dss.plot.dss_yearly_curve_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_yearly_curve_plot
    :summary:
    ```
* - {py:obj}`dss_zone_plot <dss.plot.dss_zone_plot>`
  - ```{autodoc2-docstring} dss.plot.dss_zone_plot
    :summary:
    ```
* - {py:obj}`enable <dss.plot.enable>`
  - ```{autodoc2-docstring} dss.plot.enable
    :summary:
    ```
* - {py:obj}`get_branch_data <dss.plot.get_branch_data>`
  - ```{autodoc2-docstring} dss.plot.get_branch_data
    :summary:
    ```
* - {py:obj}`get_gic_line_data <dss.plot.get_gic_line_data>`
  - ```{autodoc2-docstring} dss.plot.get_gic_line_data
    :summary:
    ```
* - {py:obj}`get_marker_dict <dss.plot.get_marker_dict>`
  - ```{autodoc2-docstring} dss.plot.get_marker_dict
    :summary:
    ```
* - {py:obj}`get_point_data <dss.plot.get_point_data>`
  - ```{autodoc2-docstring} dss.plot.get_point_data
    :summary:
    ```
* - {py:obj}`nodot <dss.plot.nodot>`
  - ```{autodoc2-docstring} dss.plot.nodot
    :summary:
    ```
* - {py:obj}`remove_nodes <dss.plot.remove_nodes>`
  - ```{autodoc2-docstring} dss.plot.remove_nodes
    :summary:
    ```
* - {py:obj}`unquote <dss.plot.unquote>`
  - ```{autodoc2-docstring} dss.plot.unquote
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Colors <dss.plot.Colors>`
  - ```{autodoc2-docstring} dss.plot.Colors
    :summary:
    ```
* - {py:obj}`DSS_MARKER_20 <dss.plot.DSS_MARKER_20>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_20
    :summary:
    ```
* - {py:obj}`DSS_MARKER_21 <dss.plot.DSS_MARKER_21>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_21
    :summary:
    ```
* - {py:obj}`DSS_MARKER_22 <dss.plot.DSS_MARKER_22>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_22
    :summary:
    ```
* - {py:obj}`DSS_MARKER_23 <dss.plot.DSS_MARKER_23>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_23
    :summary:
    ```
* - {py:obj}`DSS_MARKER_37 <dss.plot.DSS_MARKER_37>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_37
    :summary:
    ```
* - {py:obj}`DSS_MARKER_38 <dss.plot.DSS_MARKER_38>`
  - ```{autodoc2-docstring} dss.plot.DSS_MARKER_38
    :summary:
    ```
* - {py:obj}`LINES_STYLE_CODE <dss.plot.LINES_STYLE_CODE>`
  - ```{autodoc2-docstring} dss.plot.LINES_STYLE_CODE
    :summary:
    ```
* - {py:obj}`MARKER_MAP <dss.plot.MARKER_MAP>`
  - ```{autodoc2-docstring} dss.plot.MARKER_MAP
    :summary:
    ```
* - {py:obj}`MARKER_SEQ <dss.plot.MARKER_SEQ>`
  - ```{autodoc2-docstring} dss.plot.MARKER_SEQ
    :summary:
    ```
* - {py:obj}`PROFILE3PH <dss.plot.PROFILE3PH>`
  - ```{autodoc2-docstring} dss.plot.PROFILE3PH
    :summary:
    ```
* - {py:obj}`PROFILEALL <dss.plot.PROFILEALL>`
  - ```{autodoc2-docstring} dss.plot.PROFILEALL
    :summary:
    ```
* - {py:obj}`PROFILEALLPRI <dss.plot.PROFILEALLPRI>`
  - ```{autodoc2-docstring} dss.plot.PROFILEALLPRI
    :summary:
    ```
* - {py:obj}`PROFILELL3PH <dss.plot.PROFILELL3PH>`
  - ```{autodoc2-docstring} dss.plot.PROFILELL3PH
    :summary:
    ```
* - {py:obj}`PROFILELLALL <dss.plot.PROFILELLALL>`
  - ```{autodoc2-docstring} dss.plot.PROFILELLALL
    :summary:
    ```
* - {py:obj}`PROFILELLPRI <dss.plot.PROFILELLPRI>`
  - ```{autodoc2-docstring} dss.plot.PROFILELLPRI
    :summary:
    ```
* - {py:obj}`dss_plot_funcs <dss.plot.dss_plot_funcs>`
  - ```{autodoc2-docstring} dss.plot.dss_plot_funcs
    :summary:
    ```
* - {py:obj}`include_3d <dss.plot.include_3d>`
  - ```{autodoc2-docstring} dss.plot.include_3d
    :summary:
    ```
* - {py:obj}`node_re <dss.plot.node_re>`
  - ```{autodoc2-docstring} dss.plot.node_re
    :summary:
    ```
* - {py:obj}`quantity_str <dss.plot.quantity_str>`
  - ```{autodoc2-docstring} dss.plot.quantity_str
    :summary:
    ```
* - {py:obj}`sizes <dss.plot.sizes>`
  - ```{autodoc2-docstring} dss.plot.sizes
    :summary:
    ```
* - {py:obj}`str_to_pq <dss.plot.str_to_pq>`
  - ```{autodoc2-docstring} dss.plot.str_to_pq
    :summary:
    ```
````

### API

````{py:data} Colors
:canonical: dss.plot.Colors
:value: >
   ['#000000', '#FF0000', '#0000FF', '#FF00FF', '#008000', '#80FF00', '#FF8040', '#DADE21', '#B56AFF', ...

```{autodoc2-docstring} dss.plot.Colors
```

````

````{py:data} DSS_MARKER_20
:canonical: dss.plot.DSS_MARKER_20
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_20
```

````

````{py:data} DSS_MARKER_21
:canonical: dss.plot.DSS_MARKER_21
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_21
```

````

````{py:data} DSS_MARKER_22
:canonical: dss.plot.DSS_MARKER_22
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_22
```

````

````{py:data} DSS_MARKER_23
:canonical: dss.plot.DSS_MARKER_23
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_23
```

````

````{py:data} DSS_MARKER_37
:canonical: dss.plot.DSS_MARKER_37
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_37
```

````

````{py:data} DSS_MARKER_38
:canonical: dss.plot.DSS_MARKER_38
:value: >
   'Path(...)'

```{autodoc2-docstring} dss.plot.DSS_MARKER_38
```

````

````{py:data} LINES_STYLE_CODE
:canonical: dss.plot.LINES_STYLE_CODE
:value: >
   None

```{autodoc2-docstring} dss.plot.LINES_STYLE_CODE
```

````

````{py:data} MARKER_MAP
:canonical: dss.plot.MARKER_MAP
:value: >
   None

```{autodoc2-docstring} dss.plot.MARKER_MAP
```

````

````{py:data} MARKER_SEQ
:canonical: dss.plot.MARKER_SEQ
:value: >
   (5, 15, 2, 8, 26, 36, 39, 19, 18)

```{autodoc2-docstring} dss.plot.MARKER_SEQ
```

````

````{py:data} PROFILE3PH
:canonical: dss.plot.PROFILE3PH
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILE3PH
```

````

````{py:data} PROFILEALL
:canonical: dss.plot.PROFILEALL
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILEALL
```

````

````{py:data} PROFILEALLPRI
:canonical: dss.plot.PROFILEALLPRI
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILEALLPRI
```

````

````{py:data} PROFILELL3PH
:canonical: dss.plot.PROFILELL3PH
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILELL3PH
```

````

````{py:data} PROFILELLALL
:canonical: dss.plot.PROFILELLALL
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILELLALL
```

````

````{py:data} PROFILELLPRI
:canonical: dss.plot.PROFILELLPRI
:value: >
   None

```{autodoc2-docstring} dss.plot.PROFILELLPRI
```

````

`````{py:class} ToggleAdvancedTypes(dss: dss.IDSS.IDSS, value: bool)
:canonical: dss.plot.ToggleAdvancedTypes

```{autodoc2-docstring} dss.plot.ToggleAdvancedTypes
```

````{py:method} __enter__()
:canonical: dss.plot.ToggleAdvancedTypes.__enter__

```{autodoc2-docstring} dss.plot.ToggleAdvancedTypes.__enter__
```

````

````{py:method} __exit__(exc_type, exc_val, exc_tb)
:canonical: dss.plot.ToggleAdvancedTypes.__exit__

```{autodoc2-docstring} dss.plot.ToggleAdvancedTypes.__exit__
```

````

````{py:method} __init__(dss: dss.IDSS.IDSS, value: bool)
:canonical: dss.plot.ToggleAdvancedTypes.__init__

```{autodoc2-docstring} dss.plot.ToggleAdvancedTypes.__init__
```

````

`````

````{py:function} disable()
:canonical: dss.plot.disable

```{autodoc2-docstring} dss.plot.disable
```
````

````{py:function} dss_circuit_plot(DSS: dss.IDSS.IDSS, params={}, fig=None, ax=None, is3d=False)
:canonical: dss.plot.dss_circuit_plot

```{autodoc2-docstring} dss.plot.dss_circuit_plot
```
````

````{py:function} dss_comparecases_plot(DSS: dss.IDSS.IDSS, params)
:canonical: dss.plot.dss_comparecases_plot

```{autodoc2-docstring} dss.plot.dss_comparecases_plot
```
````

````{py:function} dss_daisy_plot(DSS, params)
:canonical: dss.plot.dss_daisy_plot

```{autodoc2-docstring} dss.plot.dss_daisy_plot
```
````

````{py:function} dss_di_plot(DSS: dss.IDSS.IDSS, params)
:canonical: dss.plot.dss_di_plot

```{autodoc2-docstring} dss.plot.dss_di_plot
```
````

````{py:function} dss_general_data_plot(DSS, params)
:canonical: dss.plot.dss_general_data_plot

```{autodoc2-docstring} dss.plot.dss_general_data_plot
```
````

````{py:function} dss_loadshape_plot(DSS, params)
:canonical: dss.plot.dss_loadshape_plot

```{autodoc2-docstring} dss.plot.dss_loadshape_plot
```
````

````{py:function} dss_matrix_plot(DSS, params)
:canonical: dss.plot.dss_matrix_plot

```{autodoc2-docstring} dss.plot.dss_matrix_plot
```
````

````{py:function} dss_monitor_plot(DSS: dss.IDSS.IDSS, params)
:canonical: dss.plot.dss_monitor_plot

```{autodoc2-docstring} dss.plot.dss_monitor_plot
```
````

````{py:function} dss_plot(DSS, params)
:canonical: dss.plot.dss_plot

```{autodoc2-docstring} dss.plot.dss_plot
```
````

````{py:data} dss_plot_funcs
:canonical: dss.plot.dss_plot_funcs
:value: >
   None

```{autodoc2-docstring} dss.plot.dss_plot_funcs
```

````

````{py:function} dss_priceshape_plot(DSS, params)
:canonical: dss.plot.dss_priceshape_plot

```{autodoc2-docstring} dss.plot.dss_priceshape_plot
```
````

````{py:function} dss_profile_plot(DSS, params)
:canonical: dss.plot.dss_profile_plot

```{autodoc2-docstring} dss.plot.dss_profile_plot
```
````

````{py:function} dss_python_cb_plot(ctx, paramsStr)
:canonical: dss.plot.dss_python_cb_plot

```{autodoc2-docstring} dss.plot.dss_python_cb_plot
```
````

````{py:function} dss_python_cb_write(ctx, message_str, message_type: int, message_size: int, message_subtype: int)
:canonical: dss.plot.dss_python_cb_write

```{autodoc2-docstring} dss.plot.dss_python_cb_write
```
````

````{py:function} dss_scatter_plot(DSS, params)
:canonical: dss.plot.dss_scatter_plot

```{autodoc2-docstring} dss.plot.dss_scatter_plot
```
````

````{py:function} dss_tshape_plot(DSS, params)
:canonical: dss.plot.dss_tshape_plot

```{autodoc2-docstring} dss.plot.dss_tshape_plot
```
````

````{py:function} dss_visualize_plot(DSS, params)
:canonical: dss.plot.dss_visualize_plot

```{autodoc2-docstring} dss.plot.dss_visualize_plot
```
````

````{py:function} dss_yearly_curve_plot(DSS: dss.IDSS.IDSS, params)
:canonical: dss.plot.dss_yearly_curve_plot

```{autodoc2-docstring} dss.plot.dss_yearly_curve_plot
```
````

````{py:function} dss_zone_plot(DSS: dss.IDSS.IDSS, params)
:canonical: dss.plot.dss_zone_plot

```{autodoc2-docstring} dss.plot.dss_zone_plot
```
````

````{py:function} enable(plot3d: bool = False, plot2d: bool = True, show: bool = True)
:canonical: dss.plot.enable

```{autodoc2-docstring} dss.plot.enable
```
````

````{py:function} get_branch_data(DSS, branch_objects, bus_coords, do_values=pqNone, do_switches=False, idxs=None, single_ph_line_style=1, three_ph_line_style=1)
:canonical: dss.plot.get_branch_data

```{autodoc2-docstring} dss.plot.get_branch_data
```
````

````{py:function} get_gic_line_data(DSS: dss.IDSS.IDSS, bus_coords, single_ph_line_style=1, three_ph_line_style=1)
:canonical: dss.plot.get_gic_line_data

```{autodoc2-docstring} dss.plot.get_gic_line_data
```
````

````{py:function} get_marker_dict(dss_code)
:canonical: dss.plot.get_marker_dict

```{autodoc2-docstring} dss.plot.get_marker_dict
```
````

````{py:function} get_point_data(DSS: dss.IDSS.IDSS, point_objects, bus_coords, do_values=False)
:canonical: dss.plot.get_point_data

```{autodoc2-docstring} dss.plot.get_point_data
```
````

````{py:data} include_3d
:canonical: dss.plot.include_3d
:value: >
   '2d'

```{autodoc2-docstring} dss.plot.include_3d
```

````

````{py:data} node_re
:canonical: dss.plot.node_re
:value: >
   'compile(...)'

```{autodoc2-docstring} dss.plot.node_re
```

````

````{py:function} nodot(b)
:canonical: dss.plot.nodot

```{autodoc2-docstring} dss.plot.nodot
```
````

````{py:data} quantity_str
:canonical: dss.plot.quantity_str
:value: >
   None

```{autodoc2-docstring} dss.plot.quantity_str
```

````

````{py:function} remove_nodes(bus)
:canonical: dss.plot.remove_nodes

```{autodoc2-docstring} dss.plot.remove_nodes
```
````

````{py:data} sizes
:canonical: dss.plot.sizes
:value: >
   None

```{autodoc2-docstring} dss.plot.sizes
```

````

````{py:data} str_to_pq
:canonical: dss.plot.str_to_pq
:value: >
   None

```{autodoc2-docstring} dss.plot.str_to_pq
```

````

````{py:function} unquote(field: str)
:canonical: dss.plot.unquote

```{autodoc2-docstring} dss.plot.unquote
```
````