Embed Graphics

Introduction

Neural Sketch makes it simple to place images inside blocks—as native parts of your diagrams. You can inject anything from icons to plots, screenshots to schematics—using just one line of code.

There are two modes:

• GFX embed — quick image injection, auto-scaled to fit
• Custom embed — full manual control via raw $TikZ$

Universal Raster Embedding

Neural Sketch offers robust, universal raster embedding features capable of automatically adapting graphics to any block shape. It also supports precise cropping, clipping, and customization to fit your exact diagramming needs.

Quick Usage

Use the embed-gfx key to quickly insert and automatically scale graphics to fit block dimensions:

\nskBlock[
  embed-gfx=<image-path>,
]

For advanced control, the embed key allows you to directly inject custom $TikZ$ commands:

embed={
    <custom-wrapper>
},

For instance a node with includegraphics

\nskBlock[
  embed={
    \node[] {
      \includegraphics[width=4cm, height=2cm]{../assets/in.png};
    };
  }
]

Comparison of Embed Types

Here's a comprehensive example illustrating both raw and gfx embeddings:

\nskBlock[
  embed-gfx={../assets/in.png},
]

Embedding in Custom Shapes

Neural Sketch automatically adapts embedded graphics to various block shapes. Here’s how graphics seamlessly fit into different geometrical primitives:

\nskContainer[text-north=Raster Block Embedding, text-north-loc=west]{
  \foreach \shape in
    {rectangle, circle, diamond, trapezium, semicircle}{
      \nskBlock[
        type=\shape,
        text-south=\shape, text-south-style={yshift=-2mm},
        last-pos-s=right,
        embed={ 
            \node[] 
            {\includegraphics[width=4cm, height=2cm]{../assets/in.png};}; 
        }, 
      ]
    }

Fine-Tuning Padding

Control the spacing between your embedded graphics and block boundaries using embed-padding:

\nskBlock[
  embed-gfx={../assets/in.png},
  embed-padding=<padding-size>
]

Here's a practical demonstration:

\nskContainer[text-north=Variable Embed Padding, text-north-loc=west]{
  \foreach \p in {1,...,4} {
      \nskBlock[
        last-pos-s=right, text-north=\p mm,
        embed-gfx={../assets/in.png}, embed-padding={\p mm}
      ]
    }
}

Rounding the Embed

You can round the embedded content corners using embed-border-radius. This value mirrors the block’s own corner radius unless set manually.

\nskBlock[
  embed-gfx={../assets/in.png},
  embed-border-radius=<radius-size>
]

A visual example:

\nskContainer[text-north=Variable Embed B-Radii, text-north-loc=west]{
  \foreach \r in {0,...,4} {
      \tikzmath{int \oor, \r; \oor = \r+1;}
      \nskBlock[
        last-pos-s=right, text-north=\r mm, text-south=\oor mm,
        embed-gfx={../assets/in.png}, embed-border-radius={\r mm},
        border-radius={\oor mm},
      ]
    }

Reference Table