Header menu logo Sigma.NET

HTML Type

Provides methods to generate HTML content for visualizing graphs with Sigma.

Static members

Static member Description

HTML.CreateGraphHTML(graphData, layout, settings, divId, widgets, sigmaJSRef, ?Width, ?Height)

Full Usage: HTML.CreateGraphHTML(graphData, layout, settings, divId, widgets, sigmaJSRef, ?Width, ?Height)

Parameters:
    graphData : string - JSON representation of the graph.
    layout : string - Layout configuration for the graph.
    settings : string - Settings configuration for the graph.
    divId : string - ID of the HTML container for the graph.
    widgets : string - Widgets to include in the graph.
    sigmaJSRef : JSlibReference - Reference to Sigma.js libraries.
    ?Width : CssLength - Optional width of the graph container.
    ?Height : CssLength - Optional height of the graph container.

Returns: XmlNode list A list of HTML nodes for rendering the graph.

Creates HTML content for a graph with Sigma.js embedded in a specified container.

graphData : string

JSON representation of the graph.

layout : string

Layout configuration for the graph.

settings : string

Settings configuration for the graph.

divId : string

ID of the HTML container for the graph.

widgets : string

Widgets to include in the graph.

sigmaJSRef : JSlibReference

Reference to Sigma.js libraries.

?Width : CssLength

Optional width of the graph container.

?Height : CssLength

Optional height of the graph container.

Returns: XmlNode list

A list of HTML nodes for rendering the graph.

HTML.CreateGraphScript(graphData, layout, settings, containerId, widgets, sigmaJSRef)

Full Usage: HTML.CreateGraphScript(graphData, layout, settings, containerId, widgets, sigmaJSRef)

Parameters:
    graphData : string - JSON representation of the graph.
    layout : string - Layout configuration for the graph.
    settings : string - Settings configuration for the graph.
    containerId : string - ID of the HTML container for the graph.
    widgets : string - Widgets to include in the graph.
    sigmaJSRef : JSlibReference - Reference to Sigma.js libraries.

Returns: XmlNode An HTML script element for embedding Sigma.js graph.

Creates a script to render a graph with Sigma.js.

graphData : string

JSON representation of the graph.

layout : string

Layout configuration for the graph.

settings : string

Settings configuration for the graph.

containerId : string

ID of the HTML container for the graph.

widgets : string

Widgets to include in the graph.

sigmaJSRef : JSlibReference

Reference to Sigma.js libraries.

Returns: XmlNode

An HTML script element for embedding Sigma.js graph.

HTML.Doc(graphHTML, sigmaJSRef, ?AdditionalHeadTags)

Full Usage: HTML.Doc(graphHTML, sigmaJSRef, ?AdditionalHeadTags)

Parameters:
    graphHTML : XmlNode list - List of XML nodes representing the graph HTML.
    sigmaJSRef : JSlibReference - Reference to Sigma.js libraries.
    ?AdditionalHeadTags : XmlNode list - Optional additional tags to include in the section.

Returns: XmlNode An HTML document with the embedded graph.

Generates a complete HTML document including the graph and Sigma.js references.

graphHTML : XmlNode list

List of XML nodes representing the graph HTML.

sigmaJSRef : JSlibReference

Reference to Sigma.js libraries.

?AdditionalHeadTags : XmlNode list

Optional additional tags to include in the section.

Returns: XmlNode

An HTML document with the embedded graph.

HTML.show (graph, ?DisplayOpts)

Full Usage: HTML.show (graph, ?DisplayOpts)

Parameters:
    graph : SigmaGraph - The SigmaGraph to display.
    ?DisplayOpts : DisplayOptions - Optional display options for the graph.

Shows a SigmaGraph in the default web browser by creating an HTML file and opening it.

graph : SigmaGraph

The SigmaGraph to display.

?DisplayOpts : DisplayOptions

Optional display options for the graph.

HTML.toEmbeddedHTML ?DisplayOpts

Full Usage: HTML.toEmbeddedHTML ?DisplayOpts

Parameters:
    ?DisplayOpts : DisplayOptions - Optional display options for the graph.

Returns: SigmaGraph -> string A function that takes a SigmaGraph and returns a complete HTML document as a string.

Converts a SigmaGraph to its HTML representation and embeds it into a full HTML page.

?DisplayOpts : DisplayOptions

Optional display options for the graph.

Returns: SigmaGraph -> string

A function that takes a SigmaGraph and returns a complete HTML document as a string.

HTML.toGraphHTML ?DisplayOpts

Full Usage: HTML.toGraphHTML ?DisplayOpts

Parameters:
    ?DisplayOpts : DisplayOptions - Optional display options for the graph.

Returns: SigmaGraph -> string A function that takes a SigmaGraph and returns HTML as a string.

Converts a SigmaGraph to its HTML representation as a string.

?DisplayOpts : DisplayOptions

Optional display options for the graph.

Returns: SigmaGraph -> string

A function that takes a SigmaGraph and returns HTML as a string.

HTML.toGraphHTMLNodes ?DisplayOpts

Full Usage: HTML.toGraphHTMLNodes ?DisplayOpts

Parameters:
    ?DisplayOpts : DisplayOptions - Optional display options for the graph.

Returns: SigmaGraph -> XmlNode list A function that takes a SigmaGraph and returns HTML nodes.

Converts a CyGraph to its HTML representation, with optional display options.

?DisplayOpts : DisplayOptions

Optional display options for the graph.

Returns: SigmaGraph -> XmlNode list

A function that takes a SigmaGraph and returns HTML nodes.

Type something to start searching.