MapDataPlot Class

MapDataPlot Class

DataPA OpenAnalytics API Reference

Object that represents a data plot on map.

Inheritance Hierarchy

SystemObject
DataPAEnterpriseDashboardMapDataPlot

Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class MapDataPlot : MapDataPlot_MapDataPlot, 
	ISerializable, PartialSummaryParent, DrillDownParent

<SerializableAttribute>
Public Class MapDataPlot
	Implements MapDataPlot_MapDataPlot, ISerializable, PartialSummaryParent, DrillDownParent

[SerializableAttribute]
public ref class MapDataPlot : MapDataPlot_MapDataPlot, 
	ISerializable, PartialSummaryParent, DrillDownParent

DataPAEnterpriseDashboard.MapDataPlot = function();

Type.createClass(
	'DataPAEnterpriseDashboard.MapDataPlot',
	null,
	DataPAEnterpriseDashboard.MapDataPlot._MapDataPlot,
	DataPASerialization.ISerializable,
	DataPAEnterpriseDashboard.PartialSummaryParent,
	DataPAEnterpriseDashboard.DrillDownParent);

The MapDataPlot type exposes the following members.

Constructors

	Name	Description
	MapDataPlot	Creates and return a new MapDataPlot object
	MapDataPlot(String)	Creates and return a new MapDataPlot object

Top

Methods

	Name	Description
	Build	Builds this data plot
	CancelBuild
	DrillDownParent	Returns a drilldown parent object based on the ID provided
	GetObjectData
	ProcessBuild
	Reset	Resets this MapDataPlot so next time it is rendered it is completely rebuilt
	Reset(Boolean)	Resets this MapDataPlot so next time it is rendered it is completely rebuilt
	SetObjectData

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	ActualSummaryBuildThreshold	Gets and sets the threshold value used to decide whether or not to build a partial summary for this object
	AddressColumns	Gets and sets the address columns for this mapping object
	ColorPlotType	Gets and sets the colour plot type for this map
	ContainingFeaturesFound	Gets and sets the number of locations for which the containg feature was found
	DataTag	Gets and sets the data tag property for this mapping object
	Drilldown	Gets and sets the drill down object for this data plot
	EnableDrilldown	Gets and sets a value that indicates whether this data plot has a drill down
	FillOpacity	Gets and sets the opacity used to fill features
	Filter	Gets and sets the filter for this mapping object
	GeoJson	Gets and sets the name of the GeoJson shapes file to plot the data against
	GeoJsonString	Gets the geoJson string for the GeoJson object this data is plotted against
	Guid	Gets and sets the Guid that uniquely identifies this data plot item
	HasLocationResults	Gets a value that indicates if location search results are available for this data plot
	HighValueColor	Gets and sets the color that represents high values on the chart (or all values if color plot type is single color)
	ID	Gets a unique ID that identifies this data plot item
	IsBuilding	Gets a value that indicates whether this MapDataPlot is currently building data for the map
	LabelColumn	Gets and sets a string that identifies the column used in labels for this data plot
	LastFilterUsed	Gets and sets the last filter used to build this plot
	LegendRangeColors	Gets a list of string values that represents the range labels to display in the legend
	LegendRangeLabels	Gets a list of string values that represents the range labels to display in the legend
	LegendRangeValues	Gets a list of decimal values that represents the range of values to display in the legend
	LocationsFound	Gets and sets the number of locations that were found
	LowValueColor	Gets and sets the color that represents Low values on the chart
	MapDataPlotType	Gets and sets a value that indicates how the map data plot will be represented on the map
	MaxCircleRadius	Gets and sets the maximum circle radius for circles plotted on the map
	MinCircleRadius	Gets and sets the minimum circle radius for circles plotted on the map
	Name	Gets and sets the name of this map data plot
	ObjectSizes	Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
	Parent	Gets and sets the parent of this MapDataPlot
	ParentDashboardObject	Gets the parent dashboard object for this map data plot
	PartialSummary	Gets and sets the partial summary provider for this mapping object
	PartialSummarySumColumns
	PlotParameters	Gets a string with the parameters required to plot this feature
	PlotValues	Gets the plot values json string for this map data plot
	RebuildRequired	Gets or sets a value that indicates whether or not the object has been modified since the last call to refreshXML.
	RequiresSourceData	Gets a property that indicates if this object requires the dashboard to load source data
	ScaleToZero	Gets and sets a value that indicates whether the plot on this map should be scaled from zero
	ShowLegend	Gets and sets a value that indicates whether this data plot should shoiw a legend in the map
	SourceDataRequirement	Gets a value that indicates why this object requires source data
	SourceDataTable	Gets the source datatable for this map data plot
	StrokeColor	Gets and sets the stroke colour used to draw features on the map
	StrokeDashArray	Gets and sets an array of integers that defines the stroke dash pattern.
	StrokeOpacity	Gets and sets the stroke opacity used to draw features on the map
	StrokeWeight	Gets and sets the width in pixels of the stroke used to draw features on the map
	SummaryBuildThreshold	Gets and sets the threshold value used to decide whether or not to build a partial summary for this object
	SummaryBuildThresholdApplied	Gets a value that indicates a partial summary is not available for this object due to the summary build threshold being met
	SummaryColumn	Gets and sets the Summary Column for this mapping object
	TotalLocations	Gets and sets the total number of locations

Top

Events

	Name	Description
	AddressSearchComplete	Event fires when a search for address locations ends
	AddressSearchProgress	Event fires when a search for address locations processes an address
	AddressSearchStarted	Event fires when a search for address locations begins
	BuildProcessCancelled	Event fires when the build process for this data plot is cancelled
	BuildProcessComplete	Event fires when the build process for this data plot is completed
	BuildProcessFailed	Event fires when the build process for this data plot fails
	ContainingFeatureSearchComplete	Event fires when a search for containing features locations ends
	ContainingFeatureSearchStarted	Event fires when a search for address containing features begins
	DataPlotUpdated	Event fires when this data plot has changed and needs to be re-applied to the map
	NumberOfContainingFeaturesUpdated	Event fires when the number of locations for which the containing feature has been found changes
	StartBuildProcess	Event fires when the build process for this data plot begins

Top

Remarks

Reference

DataPAEnterpriseDashboard Namespace

Send comments on this topic to info@datapa.com