datavizPlotSunburst
extends datavizPlot
in package
Table of Contents
Properties
- $layerId : mixed
- $layerXmlZero : SimpleXMLElement
- $title : mixed
- $type : mixed
- $aggregation : mixed
- $colorfields : mixed
- $colors : mixed
- $data : mixed
- $display_legend : mixed
- $horizontal : mixed
- $layout : mixed
- $lproj : null|Project
- $stacked : mixed
- $theme : mixed
- $traces : mixed
- $x_fields : mixed
- $x_mandatory : mixed
- $x_property_name : mixed
- $y_fields : mixed
- $y_mandatory : mixed
- $y_property_name : mixed
- $z_fields : mixed
- $z_property_name : mixed
Methods
- __construct() : mixed
- datavizPlot constructor.
- fetchData() : mixed
- getData() : array<string|int, mixed>|object
- getLayout() : array<string|int, mixed>|object
- getProject() : null|bool|Project
- getFieldAlias() : string
- getLayoutTemplate() : array<string|int, mixed>
- getTraceTemplate() : mixed
- parseLayer() : mixed
- Parse layer based on layer id provided by plotConfig.
- setData() : mixed
- setLayout() : mixed
- setTitle() : mixed
- Set the plot title from the plot config.
- parsePlotConfig() : mixed
Properties
$layerId
public
mixed
$layerId
$layerXmlZero
public
SimpleXMLElement
$layerXmlZero
$title
public
mixed
$title
$type
public
mixed
$type
= 'sunburst'
$aggregation
protected
mixed
$aggregation
$colorfields
protected
mixed
$colorfields
= array()
$colors
protected
mixed
$colors
= array()
$data
protected
mixed
$data
$display_legend
protected
mixed
$display_legend
$horizontal
protected
mixed
$horizontal
$layout
protected
mixed
$layout
$lproj
protected
null|Project
$lproj
$stacked
protected
mixed
$stacked
$theme
protected
mixed
$theme
$traces
protected
mixed
$traces
= array()
$x_fields
protected
mixed
$x_fields
= array()
$x_mandatory
protected
mixed
$x_mandatory
= array('scatter', 'bar', 'histogram', 'histogram2d', 'polar', 'sunburst', 'html')
$x_property_name
protected
mixed
$x_property_name
= 'labels'
$y_fields
protected
mixed
$y_fields
= array()
$y_mandatory
protected
mixed
$y_mandatory
= array('scatter', 'box', 'bar', 'pie', 'histogram2d', 'polar', 'sunburst', 'html')
$y_property_name
protected
mixed
$y_property_name
= 'values'
$z_fields
protected
mixed
$z_fields
= array()
$z_property_name
protected
mixed
$z_property_name
= 'parents'
Methods
__construct()
datavizPlot constructor.
public
__construct(string $repository, string $project, array<string|int, mixed> $plotConfig[, null $data = null ]) : mixed
Parameters
- $repository : string
- $project : string
- $plotConfig : array<string|int, mixed>
- $data : null = null
Tags
fetchData()
public
fetchData([mixed $method = 'wfs' ][, mixed $exp_filter = '' ]) : mixed
Parameters
- $method : mixed = 'wfs'
- $exp_filter : mixed = ''
getData()
public
getData([string $format = 'raw' ]) : array<string|int, mixed>|object
Parameters
- $format : string = 'raw'
-
the data format: raw or json
Return values
array<string|int, mixed>|objectgetLayout()
public
getLayout([string $format = 'raw' ]) : array<string|int, mixed>|object
Parameters
- $format : string = 'raw'
-
the data format: raw or json
Return values
array<string|int, mixed>|objectgetProject()
public
getProject(string $repository, string $project) : null|bool|Project
Parameters
- $repository : string
- $project : string
Tags
Return values
null|bool|ProjectgetFieldAlias()
protected
getFieldAlias(string $field) : string
Parameters
- $field : string
-
the field name
Return values
string —the field alias
getLayoutTemplate()
protected
getLayoutTemplate() : array<string|int, mixed>
Return values
array<string|int, mixed>getTraceTemplate()
protected
getTraceTemplate() : mixed
parseLayer()
Parse layer based on layer id provided by plotConfig.
protected
parseLayer() : mixed
setData()
protected
setData([null|array<string|int, mixed>|string $data = null ][, string $format = 'json' ]) : mixed
Parameters
- $data : null|array<string|int, mixed>|string = null
- $format : string = 'json'
-
the data format: array or json
setLayout()
protected
setLayout([null|array<string|int, mixed>|string $layout = null ][, string $format = 'array' ]) : mixed
Parameters
- $layout : null|array<string|int, mixed>|string = null
- $format : string = 'array'
-
the layout format: array or json
setTitle()
Set the plot title from the plot config.
protected
setTitle(string $title) : mixed
Parameters
- $title : string
parsePlotConfig()
private
parsePlotConfig(mixed $plotConfig) : mixed
Parameters
- $plotConfig : mixed