ve.ObjectEditor

ve.Component. ve.ObjectEditor

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

A recursive editor for JavaScript Objects, Arrays, and primitives. Layout: [Icon] [Key] : [Value] ... [Delete]

  • Functional binding: veObjectEditor().
Constructor:
  • arg0_value: Object|Array - The object to edit.
  • arg1_options: Object
    • .auto_collapse_depth=1: number - The depth at which folders start collapsing automatically.
    • .do_not_allow_deletion=false: boolean
    • .do_not_allow_insertion=false: boolean
    • .do_not_allow_key_change=false: boolean
    • .do_not_allow_type_change=false: boolean
    • .do_not_display_icons=false: boolean - Whether to show type icons.
    • .preserve_structure=false: boolean - Whether to only allow changes to primitives, and not to the data structure itself.
Instance:
  • .hierarchy: ve.Hierarchy - The internal hierarchy component.
  • .v: Object|Array
Methods:
  • refresh()

Constructor

new ve.ObjectEditor()

Source:

Extends

Members

v :Object

Returns the component value to a JSON object.

  • Accessor of: ve.ObjectEditor
Source:
Type:

v

Sets the new component value to a JSON object.

  • Accessor of: ve.ObjectEditor
Source:

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

instances :Array.<ve.Component>

Overrides:
Source:
Type:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

Methods

_generateRecursive(arg0_current_data, arg1_current_key, arg2_depth, arg3_parent_object, arg4_parent_path) → {ve.HierarchyDatatype}

Generates HTML recursively for the current component.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_current_data any
arg1_current_key string
arg2_depth number
arg3_parent_object Array.<any> | Object
arg4_parent_path string
Returns:
Type:
ve.HierarchyDatatype

_getType(arg0_value) → {string}

Returns the type of a JSON-valid primitive.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_value any
Returns:
Type:
string

_handleReorder(arg0_v, arg1_e)

Handles the reordering of an element within the ve.Hierarchy of an ObjectEditor.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_v Object
arg1_e Object

_moveArrayItem(arg0_array, arg1_old_index, arg2_new_index) → {Array.<any>}

Moves an array item inside an array within ObjectEditor.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_array Array.<any>
arg1_old_index number
arg2_new_index number
Returns:
Type:
Array.<any>

_openAddModal(arg0_target_obj)

Opens a modal for adding a new variable type to the Object.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_target_obj Object

_openChangeTypeModal(arg0_target_object, arg1_key)

Opens a modal to change an existing key type in the Object.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_target_object Object
arg1_key string

_renameObjectKey(arg0_obj, arg1_old_key, arg2_new_key)

Renames an Object key.

  • Private method of: ve.ObjectEditor
Source:
Parameters:
Name Type Description
arg0_obj Object
arg1_old_key string
arg2_new_key string

refresh()

Refreshes the given ve.ObjectEditor to be in sync with the JSON object passed in.

  • Method of: ve.ObjectEditor
Source:

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

copy() → {ve.Component}

Copies the current component and returns a new instance of it.

Overrides:
Source:
Returns:
Type:
ve.Component

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

gc()

Adds the current component to the garbage collector.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array

setValueFromObject(arg0_object, arg1_object)

Destructures Object values and transfers them into the .v instance fields of each Vercengen component.

Overrides:
Source:
Parameters:
Name Type Description
arg0_object Object

The Vercengen object to transfer to.
arg1_object Object

The other object to transfer from.