LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Caches
    • Callbacks
    • Documents
    • Document loaders
    • Embeddings
    • Exceptions
    • Language models
    • Serialization
    • Output parsers
    • Prompts
    • Rate limiters
    • Retrievers
    • Runnables
    • Utilities
    • Vector stores
    MCP Adapters
    Standard Tests
    Text Splitters
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    OverviewCachesCallbacksDocumentsDocument loadersEmbeddingsExceptionsLanguage modelsSerializationOutput parsersPromptsRate limitersRetrieversRunnablesUtilitiesVector stores
    MCP Adapters
    Standard Tests
    Text Splitters
    Language
    Theme
    Pythonlangchain-corerunnablesgraph_mermaiddraw_mermaid_png
    Function●Since v0.1

    draw_mermaid_png

    Copy
    draw_mermaid_png(
      mermaid_syntax: str,
      output_file_path: str | None = None,
      draw_method: MermaidDrawMethod
    View source on GitHub
    =
    MermaidDrawMethod
    .
    API
    ,
    background_color
    :
    str
    |
    None
    =
    'white'
    ,
    padding
    :
    int
    =
    10
    ,
    max_retries
    :
    int
    =
    1
    ,
    retry_delay
    :
    float
    =
    1.0
    ,
    base_url
    :
    str
    |
    None
    =
    None
    ,
    proxies
    :
    dict
    [
    str
    ,
    str
    ]
    |
    None
    =
    None
    )
    ->
    bytes

    Parameters

    NameTypeDescription
    mermaid_syntax*str

    Mermaid graph syntax.

    output_file_pathstr | None
    Default:None

    Path to save the PNG image.

    draw_methodMermaidDrawMethod
    Default:MermaidDrawMethod.API

    Method to draw the graph.

    background_colorstr | None
    Default:'white'
    paddingint
    Default:10
    max_retriesint
    Default:1
    retry_delayfloat
    Default:1.0
    base_urlstr | None
    Default:None
    proxiesdict[str, str] | None
    Default:None

    Draws a Mermaid graph as PNG using provided syntax.

    Background color of the image.

    Padding around the image.

    Maximum number of retries (MermaidDrawMethod.API).

    Delay between retries (MermaidDrawMethod.API).

    Base URL for the Mermaid.ink API.

    HTTP/HTTPS proxies for requests (e.g. {"http": "http://127.0.0.1:7890"}).