416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Map - Interactions and Methods

Hide navigation
RSS
Modified on Tue, 02 Apr 2013 10:36 AM
Click to return to: Documentation | Designing Dashboards | DV Controls | Map


Interactions

Click

The Click interaction lets you respond to mouse clicks on the control.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Context Click Interactions

The Context Click interactions fires when you right click on the map (before loading the context menu).

Arguments:


Custom Context Menu Commands

Context menu commands run when the corresponding item is selected from the context (right-click) menu.

ImageThis is an Advanced property.

Arguments:


Hover

The Hover interaction lets you respond to the user “hovering” their mouse over the control.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Mouse Enter

The Mouse Enter interaction lets you respond to the user moving the mouse into the control's area.

ImageThis is an Advanced property.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Mouse Leave

The Mouse Leave interaction lets you respond to the user moving the mouse out of the control's area.

ImageThis is an Advanced property.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Note: The Mouse Leave event occurs whenever the mouse is no longer directly over the control. For example, if you displayed a message (via the services.ShowMessage method) that appeared under the mouse, the Mouse Leave event would occur even though the mouse hasn't moved.

Mouse Move

The Mouse Move interaction lets you respond to mouse movements in the control's area.

ImageThis is an Advanced property.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Mouse Right Down

The Mouse Right Down interaction fires when the mouse right button is pressed.

ImageThis is an Advanced property.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

Mouse Up

The Mouse Up interaction fires when the left mouse button is unclicked.

ImageThis is an Advanced property.

Arguments:


The VisualElementArgs property of e is either a DashboardMapShape, DashboardMapPath or DashboardMapSymbol depending on which element fires the event.

On Data Changed

The On Data Changed interaction lets you respond to changes in the control's underlying data.

These interactions run when the data changes in this data visualization control. This could be from a parameter change, or a real-time update. The real-time updates will cause this interaction to fire on the timer, regardless of whether the actual data changed.

Tip: On Data Changed happens only once per update, not once per changed data point. It will also happen if no data changed.

ImageThis is an Advanced property.

Arguments:


On Layout Updated

The On Layout Updated interaction lets you respond when the layout is updated in this data visualization control. It is fired in the same scenarios as the On Data Changed Interactions with the exception that it is fired after the control has processed the updated data.

ImageThis is an Advanced property.

Arguments:


Viewport Changed Interactions

The Viewport Changed interaction fires when the viewport zoom or center point changes.

ImageThis is an Advanced property.

Arguments:


The PropertyName property of e indicates which property has changed ("Zoom", "CenterX", "CenterY"). The OldValue property of e indicates the old value for the property. The NewValue property of e indicates the new value for the property.

Methods

DataBind

Performs all of the databinding required based on the current map rules and attached fields.

  • void DataBind()
  • void DataBind(bool overWriteUserSettings)

Arguments:
  • overWriteUserSettings - Indicates whether the databinding should overwrite user-set properties.

GetCenterPoint

Gets the geographic center point of all elements in the map.

Point GetCenterPoint()

Arguments: None

GetExtents

Gets the geographic extents of all elements in the map.

Rect GetExtents()

Arguments: None

Invalidate

Invalidates the map control, causing it to completely re-draw.

  • void Invalidate()

Arguments: None

InvalidateLabeling

Helper function for script: Invalidates the labeling.

  • void InvalidateLabeling()

InvalidatePaths

Helper function for script: Invalidates all paths in the map control.

  • void InvalidatePaths(bool invalidateProjection)

Arguments:
  • invalidateProjection - Indicates whether the projection (and map grid) will be recalculated.

InvalidateShapes

Helper function for script: Invalidates all shapes in the map control.

  • void InvalidateShapes(bool invalidateProjection)

Arguments:
  • invalidateProjection - Indicates whether the projection (and map grid) will be recalculated.

InvalidateSymbols

Helper function for script: Invalidates all symbols in the map control.

  • void InvalidateSymbols(bool invalidateProjection)

Arguments:
  • invalidateProjection - Indicates whether the projection (and map grid) will be recalculated.

LoadMapByFullPath

Allows you to load a map resource in script using the map resource path.

  • void LoadMapByFullPath(string path)

Arguments:
  • path - Can be specified as "Shared Resources\\Maps\\US States\\Texas" for Shared maps, or "MyProject\\Maps\\US States\\Texas" for a project resource. Note that MyProject is the name of the project.

LoadMapById

Allows you to load a map resource in script by the map resource ID.

  • void LoadMapById(string guid)

Arguments:
  • guid - A string representing the map resource ID, such as "04cd251b-9ecb-46c9-bcd0-2f5b0de02bf1". Map resource IDs can be viewed through the map resource properties in the Design Explorer.

Related topics


Click to return to: Documentation | Designing Dashboards | DV Controls | Map

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.