The documentation is incomplete. The Vae Soli! team works hard to make it as exhaustive as possible with tons of useful examples and easy to understand explanations.
On top of that, we have decided to use our own tool to generate the documentation you read. This also takes time to fine-tune. Our goal is have better documentation, easier to read, easier to use, completely integrated with our site.
Even though NOT finalized, you can now link back to our documentation pages as we have decided once and for all about the structure of our documents and where they all reside on our server.
Thank you very much
The Vae Soli! team.
Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 13:09:56 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!
Assertions count: 0
Assertions successful: 0
Assertion failures: 0
LS_TIMELINE_CLASS_PWH
: Define "LS" Timeline class (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSTimeline
extends LSMotherNature
Creates and renders a stacked timelineName | Visibility | Type | Description |
---|---|---|---|
$aMarkers |
public | array | An array of events/periods to represent on the timeline |
$szWidth |
public | string | The overall width of the timeline |
$xEnd |
public | mixed | The end of the timeline |
$xStart |
public | mixed | The start of the timeline |
LSMotherNature
)Name | Type |
---|---|
Cargo |
NULL |
GodStamp |
string |
Shelter |
NULL |
__LS_Consciousness |
NULL |
cargo |
NULL |
fPerf |
double |
fPerfThreshold |
double |
id |
NULL |
oApp |
NULL |
oTracer |
NULL |
szNow |
NULL |
szToday |
NULL |
__construct()
: Class constructor__construct( $xStart,$xEnd,$szWidth,$szClass )
Name | Type | Description |
---|---|---|
$xStart |
mixed | Start of the timeline. Usually a float or an int. All start, stop must be expressed int the same unit. Optional parameter. |
$xEnd |
mixed | Stop of the timeline. Usually a float or an int. All start, stop must be expressed int the same unit. Optional parameter. |
$szWidth |
string | Width of the timeline. Optional parameter. |
$szClass |
string | Optional CSS class assigned to the timeline. Optional parameter. |
__construct()
uses 4 parameters whereas the suggested limit is 3.
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
__toString()
: Renders the timeline as a string (HTML code)See [c]Render()[/c]
__toString()
None
(string) The HTML code that corresponds to the timeline
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Add()
: Adds an event to the timelineAdd( $xStart,$xEnd,$szCaption )
Name | Type | Description |
---|---|---|
$xStart |
mixed | Start of the event. Usually a float or an int. All start, stop must be expressed in the same unit as the one used to create the timeline |
$xEnd |
mixed | Stop of the event. Usually a float or an int. All start, stop must be expressed in the same unit as the one used to create the timeline |
$szCaption |
string | Caption of the event |
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Clear()
: Clears the internal array of markersClear()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Render()
: Renders the timelinePlease notice that for the timeline to render as expected few CSS instructions must be issued. Here's an example of such instructions: [pre] ol { list-style-type : none; margin: 0; padding:2em; background: rgba( 255,144,0,0.4); max-height: 300px; overflow:auto; } ol li { border: 3px solid #fff; border-radius: 1.5em; box-shadow: 0 0 0.6em 0.4em rgba(100,100,100,0.5); background: #08a; color:#fff; height: 1.5em; min-height:1.5em; max-height:1.5em; line-height:1.5em; vertical-align:middle; overflow:hidden; margin-top: 0.6em; margin-bottom: 0.3em; padding: 0.3em; position:relative; text-align:center; font: 0.7em/1.1em arial,verdana,sans-serif; } [/pre]
Render()
None
(string) The HTML code that corresponds to the timeline
- Thalès
- Pythagore
- Héraclite
- Anaxagore
- Socrate
- Aristippe de Cyrène
- Platon
- Aristote
- Épicure
- Euclide
- Aristarque de Samos
- Archimède
- Ératosthène
- Ptolémée
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
LSMarker
extends LSMotherNature
Creates a marker (an event, a period, ...) to be rendered in
the LSTimeline containerName | Visibility | Type | Description |
---|---|---|---|
$szCaption |
public | string | The caption associated with the marker |
$xEnd |
public | mixed | Stop of the event. Usually a float or an int. All start, stop must be expressed in the same unit as the one used to create the timeline |
$xStart |
public | mixed | Start of the event. Usually a float or an int. All start, stop must be expressed in the same unit as the one used to create the timeline |
LSMotherNature
)Name | Type |
---|---|
Cargo |
NULL |
GodStamp |
string |
Shelter |
NULL |
__LS_Consciousness |
NULL |
cargo |
NULL |
fPerf |
double |
fPerfThreshold |
double |
id |
NULL |
oApp |
NULL |
oTracer |
NULL |
szNow |
NULL |
szToday |
NULL |
__construct()
: Creates a marker to be inserted in a LSTimeline container__construct( $xStart,$xEnd,$szCaption )
Name | Type | Description |
---|---|---|
$xStart |
mixed | Start of the marker. Usually a float or an int. All start, stop must be expressed in the same unit as the one used in the container timeline |
$xEnd |
mixed | Stop of the timeline. Usually a float or an int. All start, stop must be expressed in the same unit as the one used in the container timeline |
$szCaption |
string | Caption of the event |
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).