interface TimelineInterface in Views TimelineJS integration 7.3

Provides an interface for defining TimelineJS3 timelines.

Hierarchy

• interface \TimelineObjectInterface
  • interface \TimelineInterface

File

src/TimelineInterface.php, line 6

interface TimelineInterface extends TimelineObjectInterface {

  /**
   * Adds a new slide to the timeline's events array.
   *
   * @param TimelineSlideInterface $slide
   *   The new slide.
   */
  public function addEvent(TimelineSlideInterface $slide);

  /**
   * Returns the timeline's array of event slides.
   *
   * @return array
   *   An array of TimelineSlideInterface objects.
   */
  public function getEvents();

  /**
   * Adds a new era to the timeline's eras array.
   *
   * @param TimelineEraInterface $era
   *   The new era.
   */
  public function addEra(TimelineEraInterface $era);

  /**
   * Returns the timeline's array of eras.
   *
   * @return array
   *   An array of TimelineEraInterface objects.
   */
  public function getEras();

  /**
   * Sets the timeline's title slide.
   *
   * @param TimelineSlideInterface $slide
   *   The new slide.
   */
  public function setTitleSlide(TimelineSlideInterface $slide);

  /**
   * Returns the timeline's title slide.
   *
   * @return TimelineSlideInterface
   *   The title slide.
   */
  public function getTitleSlide();

  /**
   * Sets the timeline's scale to human.
   */
  public function setScaleToHuman();

  /**
   * Sets the timeline's scale to cosmological.
   */
  public function setScaleToCosomological();

  /**
   * Returns the timeline's scale.
   */
  public function getScale();

}

Members

Name	Modifiers	Type	Description	Overrides
TimelineInterface::addEra	public	function	Adds a new era to the timeline's eras array.	1
TimelineInterface::addEvent	public	function	Adds a new slide to the timeline's events array.	1
TimelineInterface::getEras	public	function	Returns the timeline's array of eras.	1
TimelineInterface::getEvents	public	function	Returns the timeline's array of event slides.	1
TimelineInterface::getScale	public	function	Returns the timeline's scale.	1
TimelineInterface::getTitleSlide	public	function	Returns the timeline's title slide.	1
TimelineInterface::setScaleToCosomological	public	function	Sets the timeline's scale to cosmological.	1
TimelineInterface::setScaleToHuman	public	function	Sets the timeline's scale to human.	1
TimelineInterface::setTitleSlide	public	function	Sets the timeline's title slide.	1
TimelineObjectInterface::buildArray	public	function	Creates an array representing the TimelineJS javascript object.	7