Class: IAnalysis

IAnalysis

IAnalysis class
This class could be considered a concrete implementation class.


new IAnalysis(mapper)

Create a new IAnalysis instance.

Parameters:
Name Type Description
mapper object

IMapper object to use of multiple maps (optional).

Source:

Methods


createBarAnalysis(typ, mouseclick)

Create bar analysis.

Parameters:
Name Type Description
typ string

Type of the region.

mouseclick function

The user defined function that is called when a bar analysis image is clicked.

Source:

createColoringAnalysis(typ, sym, styleScheme, mouseclick, hoverStyle)

Create map coloring analysis.

Parameters:
Name Type Description
typ string

Type of the region.

sym object

Style object.

styleScheme object

style scheme object.

mouseclick function

The user defined function that is called when a coloring analysis is clicked.

hoverStyle object

Color object for hover style create with mapper.createColorStyle(name, fillColor, fillOpacity, borderColor, borderOpacity, borderWidth).

Source:

createPieAnalysis(typ, mouseclick)

Create pie analysis.

Parameters:
Name Type Description
typ string

Type of the region.

mouseclick function

The user defined function that is called when a pie analysis image is clicked.

Source:
See:

createUsBarAnalysis(typ, mouseclick)

Create Us bar analysis.

Parameters:
Name Type Description
typ string

Type of the region.

mouseclick function

The user defined function that is called when a bar analysis image is clicked.

Source:

createUsColoringAnalysis(typ, sym, styleScheme, mouseclick)

Create Us map coloring analysis.

Parameters:
Name Type Description
typ string

Type of the region.

sym object

Style object.

styleScheme object

Style scheme object.

mouseclick function

The user defined function that is called when a coloring analysis is clicked.

Source:

createUsPieAnalysis(typ, mouseclick)

Create Us pie analysis.

Parameters:
Name Type Description
typ string

Type of the region.

mouseclick function

The user defined function that is called when a pie analysis image is clicked.

Source:

removeAnalysis()

Remove any analysis being shown.

Source:

setAnalysisBarData(typ, xml)

Set the data for the bar analysis in xml format.

Parameters:
Name Type Description
typ string

Required. The column to match non-spatial data with spatial data (e.g. 'id' or 'il_id').

xml string

Bar analysis data formatted in xml.

Source:
See:

setAnalysisBarStyle(style)

Set analysis bar style.

Parameters:
Name Type Description
style obj

Style object.

Source:

setAnalysisColoringData(typ, xml)

Set the data for the map coloring analysis in xml format.

Parameters:
Name Type Description
typ string

Required. The column to match non-spatial data with spatial data (e.g. 'id' or 'il_id').

xml string

Map coloring analysis data formatted in xml.

Source:
See:

setAnalysisPieData(typ, xml)

Set the data for the pie analysis in xml format.

Parameters:
Name Type Description
typ string

Required. The column to match non-spatial data with spatial data (e.g. 'id' or 'il_id').

xml string

Pie analysis data formatted in xml.

Source:
See:

setAnalysisPieStyle(style)

Set the style of pie analysis specifying names, colors and the radius of the pie image.

Parameters:
Name Type Description
style obj

The style of the pie images in json format.

Source:
See: