Skip to main content

Streamlit component that wraps visjs

Project description

Streamlit visjs component

Streamlit component that wraps vis.js.

Installation instructions

pip install visjs-component

Usage instructions

import streamlit as st
from visjs_component import visjs

data = {
    "nodes": [
        {"id": 1, "label": "Node 1"},
        {"id": 2, "label": "Node 2"},
        {"id": 3, "label": "Node 3"},
        {"id": 4, "label": "Node 4"},
        {"id": 5, "label": "Node 5"},
    ],
    "edges": [
        {"from": 1, "to": 3},
        {"from": 1, "to": 2},
        {"from": 2, "to": 4},
        {"from": 2, "to": 5},
    ],
    "options": {
        "nodes": {
            "shape": "dot",
            "size": 16,
        },
        "edges": {
            "color": "#000000",
        },
        "physics": {
            "enabled": True,
        },
        "interaction": {
            "hover": True,
        },
        "height": "500px",
    },
}

eventHandlers = [
    {
        "event": "click",
        "callback": lambda eventData: st.json(
            eventData['data']
        ),
    }
]

visjs(title="# Network Vis", type="network", data=data, eventHandlers=eventHandlers, key="my_network_id")

Supports all vis.js types:

  • network
  • timeline
  • graph3d

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[0.2.0] - 2024-05-27

Added

  • New combined.py example with the 3 types of visualisations
  • Support for multiple instances by adding a key parameter as shown below
visjs(title="# Network Vis", type="network", data=data, eventHandlers=eventHandlers, key="your_unique_key")

Changed

  • title property is now optional.

Donate

If you like this project and want to support it, please consider donating.

ko-fi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

visjs_component-0.2.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

visjs_component-0.2.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file visjs_component-0.2.0.tar.gz.

File metadata

  • Download URL: visjs_component-0.2.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for visjs_component-0.2.0.tar.gz
Algorithm Hash digest
SHA256 dc02a37e9c87cd9ae6766ec5c86ab6699d25b9027b1d38ef7eb17b1f5ce6b1f7
MD5 af52d0e5d8d67a7560d6019b1ea7e813
BLAKE2b-256 6fcc4a0e6221f209d7f08ab448f26c614c36c0bacdac3c6d4da16e7739c3cfe3

See more details on using hashes here.

File details

Details for the file visjs_component-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for visjs_component-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7800b910d349db5d7b7fdfae7c8fc12b74d399c9c9f8a946f6809b1b627b11fa
MD5 ef7d9ec76fa4468a22a519bf862e1703
BLAKE2b-256 c204b9e2e82309875ed677eb45ce364e61e9e611d3aaa951aad569c6d091622b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page