CKEDITOR.plugins.lineutils.locator

Properties

• readonly

  locations : ObjectCKEDITOR.plugins.lineutils.locator#locations

  See source

Methods

• since 4.3.0

  constructor( editor ) → locatorCKEDITOR.plugins.lineutils.locator#constructor

  See source

  Creates a Locator class instance.

  Parameters

  editor : editor

  Editor instance that Locator belongs to.

  Returns

  locator

  locate( relations ) → ObjectCKEDITOR.plugins.lineutils.locator#locate

  See source

  Locates the Y coordinate for all types of every single relation and stores them in an object.

  Parameters

  relations : Object

  CKEDITOR.plugins.lineutils.finder.relations.

  Returns

  Object

  locations.

  sort( y, [ howMany ] ) → ArrayCKEDITOR.plugins.lineutils.locator#sort

  See source

  Calculates distances from every location to given vertical coordinate and sorts locations according to that distance.

  Parameters

  y : Number

  The vertical coordinate used for sorting, used as a reference.

  [ howMany ] : Number

  Determines the number of "closest locations" to be returned.

  Returns

  Array

  Sorted, array representation of locations.

  store( uid, type, y )CKEDITOR.plugins.lineutils.locator#store

  See source

  Stores the location in a collection.

  Parameters

  uid : Number

  Unique identifier of the relation.

  type : Number

  One of CKEDITOR.LINEUTILS_BEFORE, CKEDITOR.LINEUTILS_AFTER and CKEDITOR.LINEUTILS_INSIDE.

  y : Number

  Vertical position of the relation.