Interface MiniviewComponentProps

Props for the MiniviewComponent.

interface MiniviewComponentProps {
    activeTracking?: boolean;
    clickToCenter?: boolean;
    collapsible?: boolean;
    elementFilter?: ((v: Vertex) => boolean);
    enableWheelZoom?: boolean;
    typeFunction?: ((v: Node | Group) => string);
    visible?: boolean;
    wheelReverse?: boolean;
    wheelSensitivity?: number;
}

Hierarchy

  • DOMAttributes<HTMLDivElement>
    • MiniviewComponentProps

Properties

activeTracking? clickToCenter? collapsible? elementFilter? enableWheelZoom? typeFunction? visible? wheelReverse? wheelSensitivity?

Properties

OptionalactiveTracking

activeTracking?: boolean

Defaults to true, meaning the miniview actively updates as nodes/groups are dragged on the related surface. If this is set to false, the miniview only updates after mouseup.

OptionalclickToCenter

clickToCenter?: boolean

Defaults to true, meaning a click on a node/group in the miniview will cause that node/group to be centered in the related surface.

Optionalcollapsible

collapsible?: boolean

Defaults to true, determines whether or not the miniview can be collapsed.

OptionalelementFilter

elementFilter?: ((v: Vertex) => boolean)

Optional filter for elements to display. Defaults to undefined - all elements displayed.

OptionalenableWheelZoom

enableWheelZoom?: boolean

Defaults to true, Whether or not to enable the wheel zoom.

OptionaltypeFunction

typeFunction?: ((v: Node | Group) => string)

Optional function to use to derive a type for each rendered node/group. This is written onto the corresponding element as the value of the data-jtk-miniview-type attribute, and can be useful for styling.

Optionalvisible

visible?: boolean

Defaults to true. Whether or not the miniview is initially visible.

OptionalwheelReverse

wheelReverse?: boolean

Defaults to false. Whether or not to reverse the zoom direction in response to a wheel event.

OptionalwheelSensitivity

wheelSensitivity?: number

Optional overide for how sensitive the wheel zoom should be.

Settings

Member Visibility

On This Page

Properties
Version :