Interface NvlOptions

Configurations for a NVL instance

interface NvlOptions {
    allowDynamicMinZoom?: boolean;
    callbacks?: ExternalCallbacks;
    disableTelemetry?: boolean;
    disableWebGL?: boolean;
    frame?: HTMLElement;
    initialZoom?: number;
    instanceId?: string;
    layout?: Layout;
    layoutOptions?: LayoutOptions;
    layoutTimeLimit?: number;
    logging?: {
        level: LogLevelDesc;
    };
    maxZoom?: number;
    minZoom?: number;
    minimapContainer?: HTMLElement;
    nodeDefaultBorderColor?: string;
    panX?: number;
    panY?: number;
    relationshipThreshold?: number;
    renderer?: Renderer;
    selectedBorderColor?: string;
    useWebGL?: boolean;
}

Properties

allowDynamicMinZoom? callbacks? disableTelemetry? disableWebGL? frame? initialZoom? instanceId? layout? layoutOptions? layoutTimeLimit? logging? maxZoom? minZoom? minimapContainer? nodeDefaultBorderColor? panX? panY? relationshipThreshold? renderer? selectedBorderColor? useWebGL?

Properties

OptionalallowDynamicMinZoom

allowDynamicMinZoom?: boolean

Whether or not to dynamically allow decreasing minimum zoom value if current graph does not fit on screen at minimum zoom. When set to true, zoom and fit operations will allow zooming out further than the minimum zoom value if the graph does not fit on screen. When set to false, zoom and fit operations will stop at the minimum zoom value, even if the full graph does not fit on screen at that zoom level.

Default Value

true

Optionalcallbacks

callbacks?: ExternalCallbacks

OptionaldisableTelemetry

disableTelemetry?: boolean

Disables tracking of library usage

Default Value

false

Optional InternaldisableWebGL

disableWebGL?: boolean

Whether or not to disable WebGL completely.

Optional Internalframe

frame?: HTMLElement

Deprecated

The DOM element in which to render the graph visualization

OptionalinitialZoom

initialZoom?: number

Zoom value of the current viewport

Optional InternalinstanceId

instanceId?: string

Id for uniquely identifying the instance of Nvl

Optionallayout

layout?: Layout

The graph layout algorithm to be used

OptionallayoutOptions

layoutOptions?: LayoutOptions

Configuration for the current layout

Optional InternallayoutTimeLimit

layoutTimeLimit?: number

Defines a time limit for how long layout iterations may run

Optional Internallogging

logging?: {
    level: LogLevelDesc;
}

Specify the log level.

OptionalmaxZoom

maxZoom?: number

The maximum zoom level allowed

Default

10

OptionalminZoom

minZoom?: number

The minimum zoom level allowed

Default

0.075

OptionalminimapContainer

minimapContainer?: HTMLElement

The DOM container in which to render the minimap

OptionalnodeDefaultBorderColor

nodeDefaultBorderColor?: string

The color to use for the default border of nodes

OptionalpanX

panX?: number

X-coordinate for panning of the current viewport

OptionalpanY

panY?: number

Y-coordinate for panning of the current viewport

Optional InternalrelationshipThreshold

relationshipThreshold?: number

Optionalrenderer

renderer?: Renderer

What renderer to use Possible values are 'webgl' or 'canvas'

Default Value

'webgl'
WebGL renderer uses GPU and has better performance.
Captions and arrowheads are only displayed when using the canvas renderer.

OptionalselectedBorderColor

selectedBorderColor?: string

The color to use for the selected border of nodes

OptionaluseWebGL

useWebGL?: boolean

Deprecated

use renderer instead Whether to user the Canvas or WebGL renderer Will be ignored when renderer is set

Settings

Member Visibility

On This Page

Properties