ve.DatavisSuite

ve.Component. ve.DatavisSuite

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

DatavisSuite used for visualising data either from a ve.Spreadsheet, ve.NodeEditor, or ve.ScriptManager. Has 1-to-1 GUI bindings with Echarts and visual macro support, please read Echarts Bindings for more details. Spreadsheets support all Google Sheets and Excel formulas, but inline chart support has been removed in favour of a separate window in which multiple graphs can be composed and analysed.

The default file extension is .ve-ds.

  • Functional binding: veDatavisSuite().
Constructor:
  • arg0_value: Object
    • .data_scripts: Object
      • <script_key>: string
        • .name: string
        • .description: string
        • .tags: Array<string>
        • .value; Object - The JSON object that stores the current script from which to serialise/deserialise.
    • .graphs: Object
      • <graph_key>: ve.Graph
    • .series: Object
      • <series_key>: Object
        • .coords: Array<Array<string, number, number>, Array<string, number, number>> - The coords/range of the series using the Spreadsheet Name for the [0] element.
        • .name: string - The name of the series, data column header value by default.
        • .pivot="column": string - Either 'column'/'row'.
        • .symbol: Object - Echarts bindings per series.
    • .table_value: Object - The ve.Spreadsheet value that can be used to restore both formulas and values.
  • arg1_options: Object
    • .dark_mode=true: boolean
Methods:
  • drawEditGraph()
  • drawEditSeriesHierarchy() | ve.Hierarchy
  • drawGraphs(arg0_resize_only:boolean)
  • getAllSeriesNames() | Object
  • getSeriesData(arg0_series_id:string) | Array<Array<Object>>
  • getSeriesName(arg0_series_obj:Object) | string
  • openEditGraph()
  • openEditSeries(arg0_series_obj:Object)
  • openEditScriptManager()
  • redraw()

Constructor

new ve.DatavisSuite()

Source:

Extends

Classes

ve.DatavisSuite.FillSymbol
ve.DatavisSuite.LabelSymbol

Members

v :Object

Returns the current DatavisSuite value as a JSON-compatible object.

  • Accessor of: ve.DatavisSuite
Source:
Type:

v :Object

Sets the current DatavisSuite value from a JSON-compatible object.

  • Accessor of: ve.DatavisSuite
Source:
Type:

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:

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

drawEditGraph()

Refreshes the edit graph window.

  • Method of: ve.DatavisSuite
Source:

drawEditSeriesHierarchy() → {ve.Hierarchy}

Refreshes the edit series window.

  • Method of: ve.DatavisSuite
Source:
Returns:
Type:
ve.Hierarchy

drawGraphs(arg0_resize_onlyopt)

Draws graphs and attempts to update them.

  • Method of: ve.DatavisSuite
Source:
Parameters:
Name Type Attributes Default Description
arg0_resize_only boolean <optional>
 false

getAllSeriesNames() → {Object}

Returns an Object of current series names.

  • Method of: ve.DatavisSuite
Source:
Returns:
Type:
Object

getSeriesData(arg0_series_id) → {Array.<Array.<Object>>}

Returns series data as a 2D array of objects.

  • Method of: ve.DatavisSuite
Source:
Parameters:
Name Type Description
arg0_series_id string
Returns:
Type:
Array.<Array.<Object>>

getSeriesName(arg0_series_obj) → {string}

Returns the series name from a given series object.

  • Method of: ve.DatavisSuite
Source:
Parameters:
Name Type Description
arg0_series_obj Object
Returns:
Type:
string

openEditGraph()

Opens the edit graph window.

  • Method of: ve.DatavisSuite
Source:

openEditSeries(arg0_series_obj)

Opens the edit series window.

  • Method of: ve.DatavisSuite
Source:
Parameters:
Name Type Description
arg0_series_obj

openEditSeriesHierarchy()

Opens the edit series hierarchy window.

  • Method of: ve.DatavisSuite
Source:

openScriptManager()

Opens the ve.ScriptManager widow for visual macro scripting.

  • Method of: ve.DatavisSuite
Source:

redraw()

Redraws the current ve.DatavisSuite component.

  • Method of: ve.DatavisSuite
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

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:

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.