SetLinkChartLayoutAsync(MapView,KnowledgeLinkChartLayoutAlgorithm,Boolean) Method

In This Topic

Sets the layout algorithm for the link chart map view. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public static Task SetLinkChartLayoutAsync( 
   MapView mapView,
   KnowledgeLinkChartLayoutAlgorithm algorithm,
   bool forceLayoutUpdate
)

Public Overloads Shared Function SetLinkChartLayoutAsync( _
   ByVal mapView As MapView, _
   ByVal algorithm As KnowledgeLinkChartLayoutAlgorithm, _
   ByVal forceLayoutUpdate As Boolean _
) As Task

Parameters

mapView
algorithm: The link chart layout algorithm
forceLayoutUpdate: Force an update to occur. Default value is false.

Exceptions

Exception	Description
System.ArgumentNullException	Map cannot be null.
System.ArgumentException	Map is not a link chart.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

Get and set the link chart layout

var mv = MapView.Active;

// a MapView can encapsulate a link chart IF it's map
// is of type MapType.LinkChart
var map = mv.Map;
var isLinkChart = map.MapType == MapType.LinkChart;
// or use the following
// var isLinkChart = map.IsLinkChart;

QueuedTask.Run(() =>
{
  if (isLinkChart)
  {
    // get the layout algorithm
    var layoutAlgorithm = mv.GetLinkChartLayout();

    // toggle the value
    if (layoutAlgorithm == KnowledgeLinkChartLayoutAlgorithm.Geographic_Organic_Standard)
      layoutAlgorithm = KnowledgeLinkChartLayoutAlgorithm.Organic_Standard;
    else
      layoutAlgorithm = KnowledgeLinkChartLayoutAlgorithm.Geographic_Organic_Standard;

    // set it
    mv.SetLinkChartLayoutAsync(layoutAlgorithm);

    // OR set it and force a redraw / update
    // await mv.SetLinkChartLayoutAsync(layoutAlgorithm, true);
  }
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.3 or higher.

Reference

KnowledgeGraphMappingExtensions Class
KnowledgeGraphMappingExtensions Members
Overload List

Send feedback