1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. Amchart
  11. \
  12. AmchartGantt

AmchartGantt

class AmchartGantt extends AmchartChart

Constants

SYSTEM_TEMPLATE_UI_FOLDER

private MIN_HEIGHT

Properties

$xf_link from  UIComponent
$link_id from  UIComponent
array $GPvars from  UIComponent
Controller $mod from  UIComponent
protected array $local_template_marker from  UIComponent
protected bool $_overwrite_param_array from  UIComponent
protected bool|array|ModelCollection $marker_content from  UIComponent
string $mod_object_manager from  UIComponent
protected bool $_orig_marker_content from  UIComponent
protected array $_allowed_params_filter from  UIComponent
string $unique_dom_id from  UIComponent
protected string $uid from  UIComponent
string read-only $_content

When used in template this property will contain the XML/HTML within the XUI Nodes

 from  UIComponent
protected bool|stdClass $_chart from  AmchartChart
protected $_data from  AmchartChart
protected $_lib_path from  AmchartChart
protected $chart_options from  AmchartChart
protected $_processed from  AmchartChart
protected $_height from  AmchartChart
protected $uid_prefix from  AmchartChart
protected $unique_id from  AmchartChart
$colors from  AmchartChart
protected string $selected_map

Name of the country or area which map is loaded.

 from  AmchartChart
protected string $quality

Quality of the map: Low|High

 from  AmchartChart

Methods

__construct($chart_definition = null)

UIComponent constructor.

from  AmchartChart
string
__toString()

No description

from  UIComponent
_add_animation_time()

No description

from  AmchartChart
_add_system_colors()

No description

from  AmchartChart
_add_theme()

No description

from  AmchartChart
_apply_chart_options()

Applies all set chart options to the chart before rendering

from  AmchartChart
add_category($category)

No description

add_listener($method, string $event = 'init')

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

from  AmchartChart
add_segment(mixed $category, string $start_date, string $end_date, string $color = null, string $label = null, string $url = null, bool $treat_as_time = false, array $custom_data = [])

Add a segment to a category

enable_export()

Enables the export functionality for the graph

mixed
get($var)

Get Variable / Option

from  UIComponent
stdClass|bool
get_chart_definition()

Returns a reference to the chart definition passed to the constructor.

from  AmchartChart
get_js_block()

No description

from  AmchartChart
string
get_unique_dom_id()

Returns the unique dom ID for this chart.

from  AmchartChart
Template|null
get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

from  UIComponent
init()

put your comment there.

from  UIComponent
string
parse_template(string $template_content, array|bool $marker_array = false)

No description

from  UIComponent
string|null
parse_template_cb_wrapper(mixed $matches)

No description

from  UIComponent
mixed|string
parse_xtag($xml_source)

No description

from  UIComponent
process()

Create Chart object and apply default settings

render()

Render Chart

from  AmchartChart
mixed
render_xtag_element()

No description

from  UIComponent
void
reset_marker_content()

restores original content of marker_content

from  UIComponent
void
set(mixed $var, mixed $value = false)

Set Variable / Option

from  UIComponent
AmchartChart
setDataDateFormat(string $format = 'YYYY-MM-DD HH:MM:SS')

Sets the data format of dates so that AmChart knows how to parse date strings https://www.amcharts.com/docs/v3/reference/amstockchart/#dataDateFormat_property

from  AmchartChart
set_3d_depth(int $depth = 10)

Enable 3D and set the depth

from  AmchartChart
set_angle(int $angle = 30)

If 3D is enabled set the angle of the chart

from  AmchartChart
set_animation_time(int $time = 0)

Set chart animation time in seconds

from  AmchartChart
void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_balloon_text($string)

Set balloon text

from  AmchartChart
set_balloon_text_format($string)

Set balloon text

from  AmchartChart
set_colors(array $colors = array())

Set chart colors, if you don't want the system colors

from  AmchartChart
set_data($data)

No description

set_end_date(bool|string $date = false)

Set the end date

set_height(int $height)

No description

set_initial_zoom(string $start_date, string $end_date)

No description

set_label_text($string)

Set label text

from  AmchartChart
set_listener($method, string $event = 'init')

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

from  AmchartChart
set_map_quality($quality = 'low')

Set the map quality

from  AmchartChart
void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

from  UIComponent
set_mod(mixed $mod)

Set link to owning module

from  UIComponent
set_number_format($decimal_separator = ',', $thousands_separator = '.', $precision = -1)

Set number format for numeric values

from  AmchartChart
set_percent_format($decimal_separator = ',', $thousands_separator = '.', $precision = -1)

Set percent format for numeric values

from  AmchartChart
void
set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

from  UIComponent
set_size(string $size = 'normal')

Set Size

from  AmchartChart
set_start_date(bool|string $date = false)

Set the start date

set_theme(string $theme = 'xelos')

Set chart theme

from  AmchartChart
set_uid_prefix($prefix)

No description

from  AmchartChart

Details

in AmchartChart at line 47
__construct($chart_definition = null)

UIComponent constructor.

Parameters

$chart_definition

in UIComponent at line 324
string __toString()

No description

Return Value

string

in AmchartChart at line 415
protected _add_animation_time()

No description

in AmchartChart at line 353
protected _add_system_colors()

No description

in AmchartChart at line 409
protected _add_theme()

No description

in AmchartChart at line 426
protected _apply_chart_options()

Applies all set chart options to the chart before rendering

at line 56
add_category($category)

No description

Parameters

$category

in AmchartChart at line 115
add_listener($method, string $event = 'init')

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

Parameters

$method
string $event

Chart Events are: init, rendered, drawn, animationFinished, buildStarted, dataUpdated, clickGraphItem

at line 26
add_segment(mixed $category, string $start_date, string $end_date, string $color = null, string $label = null, string $url = null, bool $treat_as_time = false, array $custom_data = [])

Add a segment to a category

Parameters

mixed $category

Unique int or string used as identifier
string $start_date

Any date string
string $end_date

Any date string
string $color

Hexadecimal color code like #abc123
string $label

The label text on hover
string $url

URL if user clicks on segment
bool $treat_as_time

Should we treat the segment as Time or Date?
array $custom_data

Provide Custom Data which can be referenced in JS

at line 85
enable_export()

Enables the export functionality for the graph

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

in AmchartChart at line 229
stdClass|bool get_chart_definition()

Returns a reference to the chart definition passed to the constructor.

Return Value

stdClass|bool

in AmchartChart at line 243
get_js_block()

No description

in AmchartChart at line 278
string get_unique_dom_id()

Returns the unique dom ID for this chart.

Always use this method instead of $this->unique_id.

Return Value

string

in UIComponent at line 289
Template|null get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

in UIComponent at line 72
init()

put your comment there.

..

in UIComponent at line 221
string parse_template(string $template_content, array|bool $marker_array = false)

No description

Parameters

string $template_content

HTML Template
array|bool $marker_array

Markers and Values

Return Value

string

Parsed HTML Content

in UIComponent at line 234
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

in UIComponent at line 260
mixed|string parse_xtag($xml_source)

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

at line 106
process()

Create Chart object and apply default settings

in AmchartChart at line 289
render()

Render Chart

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

in UIComponent at line 106
void set(mixed $var, mixed $value = false)

Set Variable / Option

Parameters

mixed $var

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $value

Value of Variable

Return Value

void

in AmchartChart at line 76
AmchartChart setDataDateFormat(string $format = 'YYYY-MM-DD HH:MM:SS')

Sets the data format of dates so that AmChart knows how to parse date strings https://www.amcharts.com/docs/v3/reference/amstockchart/#dataDateFormat_property

Parameters

string $format

date data format string

Return Value

AmchartChart

in AmchartChart at line 86
set_3d_depth(int $depth = 10)

Enable 3D and set the depth

Parameters

int $depth

Depth of the 3D effect. Recommended between 0 and 70

in AmchartChart at line 95
set_angle(int $angle = 30)

If 3D is enabled set the angle of the chart

Parameters

int $angle

Angle value. Recommended between 0 and 90

in AmchartChart at line 149
set_animation_time(int $time = 0)

Set chart animation time in seconds

Parameters

int $time

Seconds

in UIComponent at line 122
void set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

Parameters

mixed $member_array

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $vars

Value of Variable

Return Value

void

in AmchartChart at line 202
set_balloon_text($string)

Set balloon text

Parameters

$string

in AmchartChart at line 212
set_balloon_text_format($string)

Set balloon text

Parameters

$string

in AmchartChart at line 139
set_colors(array $colors = array())

Set chart colors, if you don't want the system colors

Parameters

array $colors

Hex values like ['#fee', '#04d6a1']

at line 10
set_data($data)

No description

Parameters

$data

at line 76
set_end_date(bool|string $date = false)

Set the end date

Parameters

bool|string $date

Any date format, default is the end of the current year

at line 183
set_height(int $height)

No description

Parameters

int $height

Chart height in pixel

at line 94
set_initial_zoom(string $start_date, string $end_date)

No description

Parameters

string $start_date

Date in Mysql or JS Notation, e.g. 2016-01-01
string $end_date

Date in Mysql or JS Notation, e.g. 2016-12-31

in AmchartChart at line 221
set_label_text($string)

Set label text

Parameters

$string

in AmchartChart at line 105
set_listener($method, string $event = 'init')

https://docs.amcharts.com/3/javascriptcharts/AmChart#events

Parameters

$method
string $event

Chart Events are: init, rendered, drawn, animationFinished, buildStarted, dataUpdated

in AmchartChart at line 159
set_map_quality($quality = 'low')

Set the map quality

Parameters

$quality

in UIComponent at line 165
void set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

in AmchartChart at line 189
set_number_format($decimal_separator = ',', $thousands_separator = '.', $precision = -1)

Set number format for numeric values

Parameters

$decimal_separator
$thousands_separator
$precision

in AmchartChart at line 177
set_percent_format($decimal_separator = ',', $thousands_separator = '.', $precision = -1)

Set percent format for numeric values

Parameters

$decimal_separator
$thousands_separator
$precision

in UIComponent at line 135
void set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

Parameters

mixed $input_params

Return Value

void

in AmchartChart at line 64
set_size(string $size = 'normal')

Set Size

Parameters

string $size

Possible values: micro, small, normal, large

at line 65
set_start_date(bool|string $date = false)

Set the start date

Parameters

bool|string $date

Any date format, default is the start of the current year

in AmchartChart at line 124
set_theme(string $theme = 'xelos')

Set chart theme

Parameters

string $theme

Possible values are 'xelos', 'default', 'light', 'dark', 'black', 'chalk'

in AmchartChart at line 55
set_uid_prefix($prefix)

No description

Parameters

$prefix