\FML\Script\FeaturesGraphCurve

Script Feature adding a Curve to a Graph

Summary

Methods
Properties
Constants
collect()
prepare()
__construct()
getGraph()
setGraph()
getPoints()
addPoint()
addPoints()
setPoints()
removeAllPoints()
getSortPoints()
setSortPoints()
getColor()
setColor()
getStyle()
setStyle()
getWidth()
setWidth()
No public properties found
No constants found
getScriptText()
$graph
$points
$sortPoints
$color
$style
$width
N/A
No private methods found
No private properties found
N/A

Properties

$points

$points : array<mixed,array>

Type

array<mixed,array> — Points

$sortPoints

$sortPoints : boolean

Type

boolean — Sort points

$color

$color : array<mixed,float>

Type

array<mixed,float> — Color

$style

$style : string

Type

string — Style

$width

$width : float

Type

float — Width

Methods

collect()

collect() : array<mixed,\FML\Script\Features\ScriptFeature>

Collect the Script Features of the given objects

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

__construct(\FML\Controls\Graph  $graph = null, array<mixed,array>  $points = null) 

Construct a new Graph Curve

Parameters

\FML\Controls\Graph $graph

(optional) Graph

array<mixed,array> $points

(optional) Points

setGraph()

setGraph(\FML\Controls\Graph  $graph) : static

Set the Graph

Parameters

\FML\Controls\Graph $graph

Graph

Returns

static

getPoints()

getPoints() : array<mixed,array>

Get the points

Returns

array<mixed,array>

addPoint()

addPoint(float|array<mixed,float>  $coordX, float  $coordY = null) : static

Add point

Parameters

float|array<mixed,float> $coordX

X-coordinate or point

float $coordY

(optional) Y-coordinate

Returns

static

addPoints()

addPoints(array<mixed,array>  $points) : static

Add points

Parameters

array<mixed,array> $points

Points

Returns

static

setPoints()

setPoints(array<mixed,array>  $points) : static

Set the points

Parameters

array<mixed,array> $points

Points

Returns

static

removeAllPoints()

removeAllPoints() : static

Remove all points

Returns

static

getSortPoints()

getSortPoints() : boolean

Get if point should be sorted

Returns

boolean

setSortPoints()

setSortPoints(boolean  $sortPoints) : static

Set if point should be sorted

Parameters

boolean $sortPoints

If point should be sorted

Returns

static

getColor()

getColor() : array<mixed,float>

Get the color

Returns

array<mixed,float>

setColor()

setColor(array<mixed,float>  $color = null) : static

Set the color

Parameters

array<mixed,float> $color

(optional) Color

Returns

static

getStyle()

getStyle() : string

Get the style

Returns

string

setStyle()

setStyle(  $style) : static

Set the style

Parameters

$style

Returns

static

getWidth()

getWidth() : float

Get the width

Returns

float

setWidth()

setWidth(  $width) : static

Set the width

Parameters

$width

Returns

static

getScriptText()

getScriptText() : string

Get the script text

Returns

string