ve.Timeline

ve.Component. ve.Timeline

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

Timeline with both ve.TimelineChronology and ve.TimelineVerticalBar views.

Constructor:
  • arg0_value=Date.getCurrentDate(): number|Object - The Date at which to start the ve.Timeline.
  • arg1_options: Object
    • .bar_options: Object
      • .layout="vertical": string - Either 'horizontal'/'vertical'.
      • .zoom=1: number
    • .chronology_options: Object
      • .page_sizes: Array<Object>
        • [n].date_window: Object - Whether to apply a date window. Supersedes .page_sizes.max_items.
        • [n].max_items=20: number
      • .starting_page: number
    • .filter: Object
      • .enabled=false: boolean
      • .date_window: Array<Object|number, Object|number> - The start_date, end_date window to display values from.
      • .groups: Array<string> - Group IDs to filter for.
      • .unique_timestamps=false: boolean - Ensures only unique timestamps are filtered for.
    • .groups: Object
      • <group_id>: Object
        • .key: string
        • .name: string
        • .colour: Array<number, number, number>|string
        • .types=["All"]: Array<string> - The types to use when rendering the filter.
    • .keyframes: Object
      • <timestamp>: Object
        • .groups: Array<string> - The Group IDs this keyframe belongs to.
        • .name: string
        • .description: string
    • .onkeyframeclick: function(v:Object, e:ve.Timeline)
    • .onkeyframedelete: function(v:Object, e:ve.Timeline)
    • .onkeyframemove: function(v:Object, e:ve.Timeline)
    • .multiselect=true: boolean
Instance:
Methods:
  • draw() -

Constructor

new ve.Timeline()

Source:

Extends

Members

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

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.