get_subgraph

Function Usage

Obtains a submap by name.

Prototype

1
get_subgraph(name: str) -> Optional[Graph]

Parameters

Parameter

Input/Output

Description

name

Input

Subgraph name, which is of the string type.

Returns

(Graph | None) Subgraph object. If no subgraph object is found, None is returned.

Constraints

  • If name is not a string, TypeError is thrown.
  • If the value fails to be obtained, RuntimeError is thrown.