Inheritance diagram for TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel:

Public Member Functions
	HeatMapLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator, IHeatMapLayerViewFactory heatMapLayerViewFactory)

override void	HandleInputEvent (GeoInputEventArgs inputEventArgs)
	Called to forward events to the layer.

override void	Update ()
	Event called at regular intervals to update contents of the layer.

Public Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
	GeoLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator)

abstract void	HandleInputEvent (GeoInputEventArgs inputEventArgs)
	Called to forward events to the layer.

virtual void	Generate ()
	Requests that the layer generates it's view.

abstract void	Update ()
	Event called at regular intervals to update contents of the layer.

virtual void	SetDirty (bool isDirty)
	Sets a boolean value indicating the need for an update of the contents of a layer.

void	SetDirty (object sender)
	Sets dirty flag and stores sender, use to avoid cyclic dirtying.

virtual bool	IsDirty ()

Public Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
void	Dispose ()
	Invoked when this object is being removed from the application and will be subject to garbage collection.

void	HandleInputEvent (GeoInputEventArgs inputEventArgs)
	Called to forward events to the layer.

void	Generate ()
	Requests that the layer generates it's view.

void	Update ()
	Event called at regular intervals to update contents of the layer.

void	SetDirty (bool isDirty)
	Sets a boolean value indicating the need for an update of the contents of a layer.

void	SetDirty (object dirtySource)
	Sets dirty flag and stores sender, use to avoid cyclic dirtying.

bool	IsDirty ()

Properties
HeatMapSettings	HeatMapSettings `[get]`
	HeatMapSettings contain global settings and a default group setting that is used when no settings are available for a heat map group.

KernelRadiusUnitEnum	KernelRadiusUnit `[get, set]`
	Sets kernel radius unit (meters or pixels)

int	GridCellSize `[get, set]`
	Smaller grid cell sizes yield higher quality heat maps. Larger grid cell sizes are quicker. Typical range is 1-10.

KernelShapeEnum	KernelShape `[get, set]`
	Sets kernel shape. The kernel shape controls how values are smoothed in the HeatMap. See https://en.wikipedia.org/wiki/Kernel_(statistics)#Kernel_functions_in_common_use.

double	KernelRadius `[get, set]`
	Kernel radius, unit controlled by KernelRadiusUnit.

double	MaxPixelRadius `[get, set]`
	Max pixel radius used when applying kernel. This is relevant when setting the kernel unit to "meters" and is used to limit demanding calculations.

double	ValueScale `[get, set]`
	Multiplier is applied to all values prior to applying the kernel.

bool	ShowStatisticsInMap `[get, set]`
	If set, basic heat map statistics are displayed in the map.

ObservableCollection< HeatMapGroup >	HeatMapGroups `[get]`
	Heat map data is organized in HeatMapGroups. Each group contains clusters of heat map data. Separate settings and color palettes can be set for each group. Note that the heat map property setters are applied to both default settings and to all groups. For detailed, individual group settings control, access elements in the HeatMapGroups directly.

ICommand	LoadHeatMapData `[get]`

ICommand	ClearHeatMapData `[get]`

ICommand	ChangedHeatMapData `[get]`

Properties inherited from TPG.GeoFramework.Core.GeoLayerViewModel
IGeoControlViewModel	GeoControlViewModel `[get, set]`
	Get or set geo control view model.

UIElement	Tooltip `[get, set]`
	Get or set tooltip UI element.

string	Name `[get]`
	A name representing the type of layer.

bool	Visible `[get, set]`
	Gets or sets the visibility of the layer.

IGeoContext	GeoContext `[get, set]`
	Gets or sets the `GeoContext` related to the layer.

IGeoNavigator	GeoNavigator `[get, set]`
	Gets or sets the `GeoNavigator` related to the GeoControl.

IGeoLayerViewFactory	GeoLayerViewFactory `[get, set]`
	Gets a factory responsible for creating a `IGeoLayerViewFactory` view.

IGeoLayerView	GeoLayerView `[get, set]`
	Gets or sets the view associated with this view model.

ClipMargins	ClipMargins `[get, set]`
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.

HashSet< object >	DirtySources `[get]`
	All contributors to current dirty.

Properties inherited from TPG.GeoFramework.Core.ViewModelBase
virtual string	DisplayName `[get, protected set]`
	Returns the user-friendly name of this object. Child classes can set this property to a new value, or override it to determine the value on-demand.

Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase
string	DisplayName `[get]`

Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
string	Name `[get]`
	A name representing the type of layer.

bool	Visible `[get, set]`
	Gets or sets the visibility of the layer.

IGeoContext	GeoContext `[get, set]`
	Gets or sets the `GeoContext` related to the layer.

IGeoLayerViewFactory	GeoLayerViewFactory `[get]`
	Gets a factory responsible for creating a `IGeoLayerViewFactory` view.

IGeoLayerView	GeoLayerView `[get, set]`
	Gets or sets the view associated with this view model.

IGeoNavigator	GeoNavigator `[get, set]`
	Gets or sets the `GeoNavigator` related to the GeoControl.

IGeoControlViewModel	GeoControlViewModel `[get, set]`
	Get or set geo control view model.

ClipMargins	ClipMargins `[get, set]`
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.

HashSet< object >	DirtySources `[get]`
	All contributors to current dirty.

UIElement	Tooltip `[get, set]`
	Get or set tooltip UI element.

Properties inherited from TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel
ObservableCollection< HeatMapGroup >	HeatMapGroups `[get]`
	Heat map data is organized in HeatMapGroups. Each group contains clusters of heat map data. Separate settings and color palettes can be set for each group. Note that the heat map property setters are applied to both default settings and to all groups. For detailed, individual group settings control, access elements in the HeatMapGroups directly.

HeatMapSettings	HeatMapSettings `[get]`
	HeatMapSettings contain global settings and a default group setting that is used when no settings are available for a heat map group.

KernelRadiusUnitEnum	KernelRadiusUnit `[get, set]`
	Sets kernel radius unit (meters or pixels)

double	KernelRadius `[get, set]`
	Kernel radius, unit controlled by KernelRadiusUnit.

KernelShapeEnum	KernelShape `[get, set]`
	Sets kernel shape. The kernel shape controls how values are smoothed in the HeatMap. See https://en.wikipedia.org/wiki/Kernel_(statistics)#Kernel_functions_in_common_use.

double	MaxPixelRadius `[get, set]`
	Max pixel radius used when applying kernel. This is relevant when setting the kernel unit to "meters" and is used to limit demanding calculations.

double	ValueScale `[get, set]`
	Multiplier is applied to all values prior to applying the kernel.

int	GridCellSize `[get, set]`
	Smaller grid cell sizes yield higher quality heat maps. Larger grid cell sizes are quicker. Typical range is 1-10.

bool	ShowStatisticsInMap `[get, set]`
	If set, basic heat map statistics are displayed in the map.

Additional Inherited Members
Protected Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
virtual void	SetVisible (bool value)

override void	OnDispose (bool disposing)
	Make sure that all layers disconnect their shared GeoContexts.

Protected Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
virtual void	OnDispose (bool disposing)
	Child classes can override this method to perform clean-up logic, such as removing event handlers.

void	NotifyPropertyChanged< TProperty > (Expression< Func< TProperty > > property, INotifyPropertyChanged sender)

void	NotifyPropertyChanged (string propertyName)

virtual void	OnPropertyChanged ([CallerMemberName] string propertyName=null)

Protected Attributes inherited from TPG.GeoFramework.Core.GeoLayerViewModel
string	_name = null

Events inherited from TPG.GeoFramework.Core.GeoLayerViewModel
VisibleChangedEventHandler	VisibleChanged = delegate { }

LayerChangedEventHandler	LayerChanged = delegate { }

Events inherited from TPG.GeoFramework.Core.ViewModelBase
PropertyChangedEventHandler	PropertyChanged = delegate { }
	Raised when a property on this object has a new value.

Events inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
VisibleChangedEventHandler	VisibleChanged
	Visibility changed.

LayerChangedEventHandler	LayerChanged
	Layer changed.

Member Function Documentation

◆ HandleInputEvent()

override void TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.HandleInputEvent ( GeoInputEventArgs inputEventArgs )

inlinevirtual

Called to forward events to the layer.

Parameters

inputEventArgs

If the layer handles the event, it must set the Handled property to true.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

◆ Update()

override void TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.Update ( )

inlinevirtual

Event called at regular intervals to update contents of the layer.

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

Property Documentation

◆ GridCellSize

int TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.GridCellSize

getset

Smaller grid cell sizes yield higher quality heat maps. Larger grid cell sizes are quicker. Typical range is 1-10.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ HeatMapGroups

ObservableCollection<HeatMapGroup> TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.HeatMapGroups

get

Heat map data is organized in HeatMapGroups. Each group contains clusters of heat map data. Separate settings and color palettes can be set for each group. Note that the heat map property setters are applied to both default settings and to all groups. For detailed, individual group settings control, access elements in the HeatMapGroups directly.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ HeatMapSettings

HeatMapSettings TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.HeatMapSettings

get

HeatMapSettings contain global settings and a default group setting that is used when no settings are available for a heat map group.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ KernelRadius

double TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.KernelRadius

getset

Kernel radius, unit controlled by KernelRadiusUnit.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ KernelRadiusUnit

KernelRadiusUnitEnum TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.KernelRadiusUnit

getset

Sets kernel radius unit (meters or pixels)

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ KernelShape

KernelShapeEnum TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.KernelShape

getset

Sets kernel shape. The kernel shape controls how values are smoothed in the HeatMap. See https://en.wikipedia.org/wiki/Kernel_(statistics)#Kernel_functions_in_common_use.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ MaxPixelRadius

double TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.MaxPixelRadius

getset

Max pixel radius used when applying kernel. This is relevant when setting the kernel unit to "meters" and is used to limit demanding calculations.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ ShowStatisticsInMap

bool TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.ShowStatisticsInMap

getset

If set, basic heat map statistics are displayed in the map.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

◆ ValueScale

double TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel.ValueScale

getset

Multiplier is applied to all values prior to applying the kernel.

Implements TPG.GeoFramework.HeatMapLayer.IHeatMapLayerViewModel.

The documentation for this class was generated from the following file:

Src/Layers/Heatmap/TPG.GeoFramework.HeatmapLayer/HeatMapLayerViewModel.cs

Public Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ HandleInputEvent()

◆ Update()

Property Documentation

◆ GridCellSize

◆ HeatMapGroups

◆ HeatMapSettings

◆ KernelRadius

◆ KernelRadiusUnit

◆ KernelShape

◆ MaxPixelRadius

◆ ShowStatisticsInMap

◆ ValueScale