sesaparcours
    Preparing search index...

    Class Selected

    Fake class which should be extended to avoid inheriting static properties

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    group isBlank isUiEvent newElementId oldElementId recordUndo type workspaceId

    Methods

    fromJson isNull run toJson

    Constructors

    • Class for a selected event.

      Parameters

      • Optionalopt_oldElementId: string

        The ID of the previously selected element. Null if no element last selected. Undefined for a blank event.

      • Optionalopt_newElementId: string

        The ID of the selected element. Null if no element currently selected (deselect). Undefined for a blank event.

      • Optionalopt_workspaceId: string

        The workspace identifier for this event. Null if no element previously selected. Undefined for a blank event.

      Returns Selected

    Properties

    group: string

    The event group id for the group this event belongs to. Groups define events that should be treated as an single action from the user's perspective, and should be undone together.

    isBlank: boolean

    Whether or not the event is blank (to be populated by fromJson).

    isUiEvent: boolean

    Whether or not the event is a UI event.

    newElementId: any

    The id of the selected element.

    oldElementId: any

    The id of the last selected element.

    recordUndo: boolean

    Sets whether the event should be added to the undo stack.

    type: string

    Type of this event.

    workspaceId: string

    The workspace identifier for this event.

    Methods

    • Decode the JSON event.

      Parameters

      • json: Object

        JSON representation.

      Returns void

    • Does this event record any change of state?

      Returns boolean

      True if null, false if something changed.

    • Run an event.

      Parameters

      • _forward: boolean

        True if run forward, false if run backward (undo).

      Returns void

    • Encode the event as JSON.

      Returns Object

      JSON representation.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods