molsysviewer.regions.Region#

class molsysviewer.regions.Region(view, tag, selection, *, atom_indices=None, representation=None, repr_params=None)[source]#

Wrapper for a molecular region (Mol* component) addressed by tag.

Parameters:
  • view (Any)

  • tag (str)

  • selection (str | Any)

  • atom_indices (Optional[list[int]])

  • representation (str | None)

  • repr_params (Optional[Dict[str, Any]])

__init__(view, tag, selection, *, atom_indices=None, representation=None, repr_params=None)[source]#
Parameters:
  • view (Any)

  • tag (str)

  • selection (str | Any)

  • atom_indices (list[int] | None)

  • representation (str | None)

  • repr_params (Dict[str, Any] | None)

Return type:

None

Methods

__init__(view, tag, selection, *[, ...])

delete()

Remove this region and its representations.

get([element, selection, structure_indices, ...])

Retrieve values, scoped to this region.

hide()

Hide this region (all attached representations).

info([element, selection, syntax, mask, ...])

Show a summary table, scoped to this region.

new_complementary_region([tag])

Create a new region with the complement of this region's atoms.

select([selection, structure_indices, ...])

Select indices, scoped to this region.

set_representation([representation, preset])

Apply or update a representation for this region.

show()

Show this region (all attached representations).