Class AutoSaveManager

Manager for automatically saving diagrams. The hook must be implemented.

const mgr = new AutoSaveManager(editor.graph);
mgr.save() {
  GlobalConfig.logger.show();
  GlobalConfig.logger.debug('save');
};

Hierarchy (view full)

Constructors

constructor

Properties

autoSaveDelay autoSaveThreshold autoSaveThrottle changeHandler enabled eventListeners eventsEnabled eventSource graph ignoredChanges lastSnapshot

Methods

addListener destroy fireEvent getEventSource graphModelChanged isEnabled isEventsEnabled removeListener reset save setEnabled setEventsEnabled setEventSource setGraph

Constructors

constructor

Properties

autoSaveDelay

autoSaveDelay: number = 10

Minimum amount of seconds between two consecutive autosaves. Eg. a value of 1 (s) means the graph is not stored more than once per second. Default is 10.

autoSaveThreshold

autoSaveThreshold: number = 5

Minimum amount of ignored changes before an autosave. Eg. a value of 2 means after 2 change of the graph model the autosave will trigger if the condition below is true. Default is 5.

autoSaveThrottle

autoSaveThrottle: number = 2

Minimum amount of seconds between two consecutive autosaves triggered by more than changes within a timespan of less than seconds. Eg. a value of 1 (s) means the graph is not stored more than once per second even if there are more than changes within that timespan. Default is 2.

changeHandler

changeHandler: Function

Holds the function that handles graph model changes.

enabled

enabled: boolean = true

Specifies if event handling is enabled. Default is true.

eventListeners

eventListeners: EventListenerObject[] = []

Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.

eventsEnabled

eventsEnabled: boolean = true

Specifies if events can be fired. Default is true.

eventSource

eventSource: null | EventTarget = null

Optional source for events. Default is null.

graph

graph: null | Graph = null

Reference to the enclosing Graph.

ignoredChanges

ignoredChanges: number = 0

Counter for ignored changes in autosave.

lastSnapshot

lastSnapshot: number = 0

Used for autosaving. See .

Methods

addListener

  • addListener(name, funct): void

  • Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.

    The parameters of the listener are the sender and an EventObject.

    Parameters

    • name: string
    • funct: Function

    Returns void

destroy

fireEvent

  • fireEvent(evt, sender?): void

  • Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope ("this") is used for the listener invocation (see Utils#bind).

    Example:

    fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN))

    Parameters

    • evt: EventObject

      EventObject that represents the event.

    • sender: null | EventTarget = null

      Optional sender to be passed to the listener. Default value is the return value of .

    Returns void

getEventSource

graphModelChanged

isEnabled

isEventsEnabled

removeListener

reset

save

setEnabled

  • setEnabled(value): void

  • Enables or disables event handling. This implementation updates .

    Parameters

    • value: boolean

    Returns void

setEventsEnabled

setEventSource

setGraph

Settings

Member Visibility

On This Page

Constructors
Properties
Methods