Skip to main content

Home > @jsplumbtoolkit/browser-ui > SurfaceRenderOptions

SurfaceRenderOptions interface#

This interface defines the allowed parameters on a render call that will create a new Surface.

Signature:

export interface SurfaceRenderOptions 

Properties#

PropertyTypeDescription
activeFiltering?boolean(Optional)
assignDragGroup?(v: Vertex) => DragGroupSpec(Optional)
autoExitSelectMode?boolean(Optional)
clamp?boolean(Optional)
clampToBackground?boolean(Optional)
clampToBackgroundExtents?boolean(Optional)
consumeRightClick?boolean(Optional)
debug?boolean(Optional)
decorators?Array<DecoratorSpec>(Optional)
defaults?JsPlumbDefaults<ElementType>(Optional)
directRender?boolean(Optional)
dragOptions?SurfaceDragOptions(Optional)
elementsDraggable?boolean(Optional)
enableAnimation?boolean(Optional)
enablePan?boolean(Optional)
enablePanButtons?boolean(Optional)
enableWheelZoom?boolean(Optional)
enhancedView?boolean(Optional)
events?Record<string, (value: any, event?: any) => any>(Optional)
grid?SurfaceGridOptions(Optional)
id?string(Optional)
interceptors?Record<string, (value: any, event?: any) => any>(Optional)
lassoEdges?boolean(Optional)
lassoFilter?any(Optional)
lassoInvert?boolean(Optional)
lassoSelectionFilter?(obj: any) => boolean(Optional)
layout?{ type: string; options?: LayoutParameters; }(Optional)
magnetize?SurfaceMagnetizeOptions(Optional)
mode?SurfaceMode(Optional)
modelLeftAttribute?string(Optional)
modelTopAttribute?string(Optional)
objectFilter?(b: Base) => boolean(Optional)
padding?[number, number](Optional)
panDistance?number(Optional)
panFilter?any(Optional)
plugins?Array<SurfacePluginSpec>(Optional)
refreshAutomatically?boolean(Optional)
refreshLayoutOnEdgeConnect?boolean(Optional)
relayoutOnGroupUpdate?boolean(Optional)
selection?Selection | Function(Optional)
storePositionsInModel?boolean(Optional)
templates?Dictionary<string>(Optional)
view?SurfaceViewOptions(Optional)
wheelFilter?any(Optional)
wheelPan?boolean(Optional)
wheelReverse?boolean(Optional)
wheelSensitivity?number(Optional)
wheelZoomMetaKey?boolean(Optional)
zoom?number(Optional)
zoomRange?ZoomRange(Optional)
zoomToFit?boolean(Optional)
zoomToFitIfNecessary?boolean(Optional)