Interface SelectionOptions

Options for the behaviour of a selection.

interface SelectionOptions {
    autoFill?: boolean;
    generator?: Function;
    lazy?: boolean;
    mode?:
        | "mixed"
        | "isolated"
        | "nodesOnly"
        | "groupsOnly"
        | "edgesOnly";
    onBeforeReload?: Function;
    onClear?: Function;
    onReload?: Function;
}

Properties

autoFill? generator? lazy? mode? onBeforeReload? onClear? onReload?

Properties

OptionalautoFill

autoFill?: boolean

Defaults to false. If true, and a generator is supplied,

Optionalgenerator

generator?: Function

Optional function that can be called to fill the selection. You'd use this when you are rendering individual selections and you need to be able to refresh the whole view based on some change in the data model.

Optionallazy

lazy?: boolean

If true, the selection will not populate itself as soon as it is constructed. Otherwise, and this is the default behaviour, it will.

Optionalmode

mode?:
    | "mixed"
    | "isolated"
    | "nodesOnly"
    | "groupsOnly"
    | "edgesOnly"

Defaults to SelectionModes.mixed, meaning any combination of nodes, groups and edges may be present in the selection at a given point in time.

OptionalonBeforeReload

onBeforeReload?: Function

Optional. called before the selection is cleared at the beginning of a reload, when a generator is supplied.

OptionalonClear

onClear?: Function

Optional function to call when the selection is cleared.

OptionalonReload

onReload?: Function

Optional. called after a reload when a generator was supplied.

Settings

Member Visibility

On This Page

Properties
Version :