\Charcoal\Admin\Widget\GraphTimeGraphWidgetInterface

Graph Widget Interface

Summary

Methods

Constants

setHeight()
height()
setColors()
colors()
defaultColors()
categories()
categoriesJson()
series()
seriesJson()
setGroupingType()
groupingType()
setDateFormat()
dateFormat()
setSqlDateFormat()
sqlDateFormat()
setStartDate()
startDate()
setEndDate()
endDate()
setDateInterval()
dateInterval()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setHeight()

setHeight(mixed  $height) : \Charcoal\Admin\Widget\Graph\GraphWidgetInterface

Parameters

mixed

$height

Graph default height (for CSS).

Returns

\Charcoal\Admin\Widget\Graph\GraphWidgetInterface —

Chainable

height()

height() : mixed

Returns

mixed

setColors()

setColors(array<mixed,string>  $colors) : \Charcoal\Admin\Widget\Graph\GraphWidgetInterface

Parameters

array<mixed,string>

$colors

The graph colors (hexadecimal).

Returns

\Charcoal\Admin\Widget\Graph\GraphWidgetInterface —

Chainable

colors()

colors() : array<mixed,string>

Returns

array<mixed,string>

defaultColors()

defaultColors() : array<mixed,string>

Returns

array<mixed,string>

categories()

categories() : array

Returns

array —

Categories structure.

categoriesJson()

categoriesJson() : string

Returns

string —

JSONified categories structure.

series()

series() : array

Returns

array —

Series structure.

seriesJson()

seriesJson() : string

Returns

string —

JSONified series structure.

setGroupingType()

setGroupingType(string  $type) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string

$type

The group type.

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

groupingType()

groupingType() : string

Returns

string

setDateFormat()

setDateFormat(string  $format) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string

$format

The date format.

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

dateFormat()

dateFormat() : string

Returns

string

setSqlDateFormat()

setSqlDateFormat(string  $format) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string

$format

The date format.

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

sqlDateFormat()

sqlDateFormat() : string

Returns

string

setStartDate()

setStartDate(string|\Charcoal\Admin\Widget\Graph\DateTimeInterface  $ts) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string|\Charcoal\Admin\Widget\Graph\DateTimeInterface

$ts

The start date.

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

startDate()

startDate() : \Charcoal\Admin\Widget\Graph\DateTimeInterface

Returns

\Charcoal\Admin\Widget\Graph\DateTimeInterface

setEndDate()

setEndDate(string|\Charcoal\Admin\Widget\Graph\DateTimeInterface  $ts) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string|\Charcoal\Admin\Widget\Graph\DateTimeInterface

$ts

The end date.

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

endDate()

endDate() : \Charcoal\Admin\Widget\Graph\DateTimeInterface

Returns

\Charcoal\Admin\Widget\Graph\DateTimeInterface

setDateInterval()

setDateInterval(string|\Charcoal\Admin\Widget\Graph\DateInterval  $interval) : \Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface

Parameters

string|\Charcoal\Admin\Widget\Graph\DateInterval

$interval

The interval between each "category".

Returns

\Charcoal\Admin\Widget\Graph\TimeGraphWidgetInterface —

Chainable

dateInterval()

dateInterval() : \Charcoal\Admin\Widget\Graph\DateInterval

Returns

\Charcoal\Admin\Widget\Graph\DateInterval