Interface MiniviewProps

Props for the miniview component.

interface MiniviewProps {
    activeTracking?: boolean;
    clickToCenter?: boolean;
    elementFilter?: ((obj) => boolean);
    surface: Surface;
    typeFunction?: ((obj) => string);
}

Properties

activeTracking? clickToCenter? elementFilter? surface typeFunction?

Properties

Optional activeTracking

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.

Optional clickToCenter

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.

Optional elementFilter

elementFilter?: ((obj) => boolean)

Optional filter to decide which elements to show in the miniview.

Type declaration

    • (obj): boolean

    • Parameters

      • obj: Node | Group

      Returns boolean

surface

surface: Surface

Surface to attach to. Required.

Optional typeFunction

typeFunction?: ((obj) => string)

Optional function to use to decorate miniview elements with a jtk-miniview-type attribute. Can be used for simple styling.

Type declaration

    • (obj): string

    • Parameters

      • obj: Node | Group

      Returns string

Settings

Member Visibility

Theme

On This Page

activeTrackingclickToCenterelementFiltersurfacetypeFunction
Version :