Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

...

  • Both methods require an API token for authentication. See: Adding an API token

  • The token should be retrieved securely and never exposed in frontend code.

  • Tokens can be passed via query parameters (for iframe) or function arguments (for SDK).

...

Code Block
<iframe
  src="https://orthogramic.com/embed/mindmap?id=YOUR_MAP_ID&token=YOUR_AUTH_TOKEN"
  width="100%"
  height="600px"
  style="border:none;"
  allowfullscreen>
</iframe>

Key Parameters

Parameter

Type

Required

Description

id

string

The unique mindmap ID

token

string

Authentication token

theme

`"light"

"dark"`

zoom

number

Zoom level (e.g., 1.2)

...

Code Block
<div id="mindmap-container"></div>

<script>
  const socket = new WebSocket("wss://orthogramic.com/ws/mindmap");

  socket.onopen = function() {
    socket.send(JSON.stringify({
      action: "subscribe",
      mindmapId: "12345",
      token: "abc123"
    }));
  };

  socket.onmessage = function(event) {
    const data = JSON.parse(event.data);
    if (data.update) {
      OrthogramicMindmap.render({
        container: "mindmap-container",
        mindmapId: data.mindmapId,
        token: "abc123",
        theme: "dark"
      });
    }
  };

  socket.onerror = function(error) {
    console.error("WebSocket Error: ", error);
  };

  socket.onclose = function() {
    console.log("WebSocket connection closed. Reconnecting...");
    setTimeout(() => {
      location.reload(); // Simple reconnection strategy
    }, 5000);
  };
</script>

Available Options

Parameter

Type

Default

Description

container

string

Required

The HTML element ID where the mindmap will be loaded

mindmapId

string

Required

The unique ID of the mindmap

token

string

Required

Authentication token

width

string

"100%"

Width of the container (supports % or px)

height

string

"600px"

Height of the container

zoom

number

1

Zoom level (1.0 = default, 1.5 = 150%)

...

Choosing the right method

Feature

<iframe>

JavaScript SDK

Easy to integrate

✅ Yes

❌ Requires JavaScript

Dynamic updates

❌ No

✅ Yes

Custom styling

❌ Limited

✅ Full control

Real-time support

❌ No

✅ Yes

Secure authentication

❌ Token in URL

✅ Backend token retrieval

...