Skip to content

Commit

Permalink
Added new marker methods getColorByIndex and setColorByIndex. Added S…
Browse files Browse the repository at this point in the history
…phinx requirements file.
  • Loading branch information
justintaylor-dev committed Feb 2, 2019
1 parent ec9f319 commit 28c1657
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
64 changes: 64 additions & 0 deletions 12 - Marker object/marker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,67 @@ None.
**Returns**

Returns a ``String`` containing the frame target, or **0** if unsuccessful.


----

.. _marker.getColorByIndex:

getColorByIndex
*********************************************

``marker.getColorByIndex(markerIndex)``

**Description**

Gets the marker color index. (added in CC 2019)

**Parameters**

=================== ==============================================

``markerIndex`` Index of the marker to be read.

=================== ==============================================

**Returns**

Returns the color index as an ``Integer``.


----

.. _marker.setColorByIndex:

setColorByIndex
*********************************************

``marker.setColorByIndex(colorIndex, markerIndex)``

**Description**

Sets the marker color by index. Color indexies listed below. (added in CC 2019)

* 0 = Green
* 1 = Red
* 2 = Purple
* 3 = Orange
* 4 = Yellow
* 5 = White
* 6 = Blue
* 7 = Cyan

**Parameters**

=================== ==============================================

``colorIndex`` Index of the color to apply to the marker.

``markerIndex`` Index of the marker to be set.

=================== ==============================================


**Returns**

Returns ``undefined``.
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinx
sphinx_rtd_theme

0 comments on commit 28c1657

Please sign in to comment.