Class NeoVis

constructor

• new NeoVis(config): NeoVis

• Parameters

  • config: NeovisConfig | NonFlatNeovisConfig

    configures the visualization and Neo4j server connection

  Returns NeoVis

Static NEOVIS_ADVANCED_CONFIG

Static NEOVIS_DEFAULT_CONFIG

Static objectToTitleHtml

Static objectToTitleString

edges

• get edges(): DataSet<Edge, "id">

• All view edges as DataSet

  Link

  https://visjs.github.io/vis-data/data/dataset.html

  Returns DataSet<Edge, "id">

network

• get network(): Network

• The vis network object

  Link

  https://visjs.github.io/vis-network/docs/network/#methods

  Returns Network

nodes

• get nodes(): DataSet<Node, "id">

• All view nodes as DataSet

  Link

  https://visjs.github.io/vis-data/data/dataset.html

  Returns DataSet<Node, "id">

clearNetwork

• clearNetwork(): void

• Clear the data for the visualization

  Returns void

registerOnEvent

• registerOnEvent<T>(eventType, handler): void

• Type Parameters

  • T extends NeoVisEvents

  Parameters

  • eventType: T

    Event type to be handled

  • handler: EventFunctionTypes[T]

    Handler to manage the event

  Returns void

reinit

• reinit(config, parameter?): void

• Reset the config object and reload data

  Parameters

  • config: NeovisConfig | NonFlatNeovisConfig

  • Optional parameter: unknown

  Returns void

reload

• reload(parameter?): void

• Clear the network and fetch live data form the server and reload the visualization

  Parameters

  • Optional parameter: unknown

  Returns void

render

• render(query_or_function?, parameters?): void

• Renders the network

  Parameters

  • Optional query_or_function: string | DataFunctionType

  • Optional parameters: unknown

  Returns void

renderWithCypher

• renderWithCypher(query, parameters?): void

• Execute an arbitrary Cypher query and re-render the visualization

  Parameters

  • query: string

  • Optional parameters: unknown

    parameters to send to the cypher

  Returns void

renderWithFunction

• renderWithFunction(func, parameters?): void

• Execute an arbitrary function and re-render the visualization

  Parameters

  • func: DataFunctionType

  • Optional parameters: unknown

    parameters to send to the function

  Returns void

stabilize

• stabilize(): void

• Stabilize the visualization

  Returns void

updateWithCypher

• updateWithCypher(query, parameters?): void

• Execute an arbitrary Cypher query and update the current visualization, retaning current nodes This function will not change the original query given by renderWithCypher or the inital cypher.

  Parameters

  • query: string

  • Optional parameters: unknown

    parameters to send to the cypher

  Returns void

updateWithFunction

• updateWithFunction(func, parameters?): void

• Execute an arbitrary function and update the visualization

  Parameters

  • func: DataFunctionType

  • Optional parameters: unknown

    parameters to send to the function

  Returns void