Create a Double Fill Scale Bar

TomFlahive

I am trying to create a Double Fill Scale Bar in the ArcGIS Pro SDK..  I was able to create a default scale bar using the Esri snippets example (Pro Snippets for Layouts) which did not require specifying the type or styling for the scale bar.  But now I am looking to create a scale bar with a double fill format which means I do need to somehow specify the type and style of the scale bar.  I feel like I am getting close with the following code (just the relevant part of the code below), but it crashes ArcGIS Pro:

Task t <SPAN class="operator token">=</SPAN> QueuedTask<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Run</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN>
<SPAN class="punctuation token">{</SPAN>
&nbsp;&nbsp; Coordinate2D coord2D <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">Coordinate2D</SPAN><SPAN class="punctuation token">(</SPAN>xCoord<SPAN class="punctuation token">,</SPAN> yCoord<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp; CIMDoubleFillScaleBar myScaleBar <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">CIMDoubleFillScaleBar</SPAN>
&nbsp;&nbsp; <SPAN class="punctuation token">{</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Division <SPAN class="operator token">=</SPAN> <SPAN class="number token">4</SPAN> 
&nbsp;&nbsp; <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">;</SPAN> 
&nbsp;&nbsp; ScaleBarStyleItem scaleBarStyle <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">ScaleBarStyleItem</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp; scaleBarStyle<SPAN class="punctuation token">.</SPAN>ScaleBar <SPAN class="operator token">=</SPAN> myScaleBar<SPAN class="punctuation token">;</SPAN> 
&nbsp;&nbsp; LayoutElementFactory<SPAN class="punctuation token">.</SPAN>Instance<SPAN class="punctuation token">.</SPAN><SPAN class="token function">CreateScaleBar</SPAN><SPAN class="punctuation token">(</SPAN>activeLayout<SPAN class="punctuation token">,</SPAN> coord2D<SPAN class="punctuation token">,</SPAN> topMapFrame<SPAN class="punctuation token">,</SPAN> scaleBarStyle<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
 <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Does anyone know what I might be missing?  I'm not sure if I am using the CIMDoubleFillScaleBar and the ScaleBarStyleItem correctly.  Thanks.

CharlesMacleod

The problem is the style item. CreateScaleBar wants a ScaleBarStyleItem that will come from the project style file. By default this will be "ArcGIS 2D". You can see the available styles (in ArcGIS 2D) for scalebars when you use the "Scale Bar" button on the Insert tab.

Let's first look at listing out the ScaleBarStyleItems from the project style:

&nbsp;&nbsp; <SPAN class="keyword token">var</SPAN> arcgis_2d <SPAN class="operator token">=</SPAN> Project<SPAN class="punctuation token">.</SPAN>Current<SPAN class="punctuation token">.</SPAN>GetItems<SPAN class="operator token"><</SPAN>StyleProjectItem<SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">First</SPAN><SPAN class="punctuation token">(</SPAN>si <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN> si<SPAN class="punctuation token">.</SPAN>Name <SPAN class="operator token">==</SPAN> <SPAN class="string token">"ArcGIS 2D"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp; StringBuilder sb <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">StringBuilder</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp; <SPAN class="keyword token">await</SPAN> QueuedTask<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Run</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN>
&nbsp;&nbsp; <SPAN class="punctuation token">{</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">//Imperial Double Alternating Scale Bar</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">//Metric Double Alternating Scale Bar</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">//or just use empty string to list them all...</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">var</SPAN> scaleBarItems <SPAN class="operator token">=</SPAN> arcgis_2d<SPAN class="punctuation token">.</SPAN><SPAN class="token function">SearchScaleBars</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Double Alternating Scale Bar"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">foreach</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">var</SPAN> sbi <SPAN class="keyword token">in</SPAN> scaleBarItems<SPAN class="punctuation token">)</SPAN> <SPAN class="punctuation token">{</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; sb<SPAN class="punctuation token">.</SPAN><SPAN class="token function">AppendLine</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">"{sbi.Name}, {sbi.Category}, {sbi.Key}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="punctuation token">}</SPAN>
&nbsp;&nbsp; <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
&nbsp;&nbsp; System<SPAN class="punctuation token">.</SPAN>Diagnostics<SPAN class="punctuation token">.</SPAN>Debug<SPAN class="punctuation token">.</SPAN><SPAN class="token function">WriteLine</SPAN><SPAN class="punctuation token">(</SPAN>sb<SPAN class="punctuation token">.</SPAN><SPAN class="token function">ToString</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Now let's use one of the Double Alternating Scale Bar styles to create a scale bar:

&nbsp; <SPAN class="keyword token">var</SPAN> scaleBarStyle <SPAN class="operator token">=</SPAN> arcgis_2d<SPAN class="punctuation token">.</SPAN><SPAN class="token function">SearchScaleBars</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Imperial Double Alternating Scale Bar"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">First</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp; Coordinate2D coord <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">Coordinate2D</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="number token">10.0</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">7.0</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
&nbsp; MapFrame mf <SPAN class="operator token">=</SPAN> layout<SPAN class="punctuation token">.</SPAN><SPAN class="token function">FindElement</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Map Frame"</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="keyword token">as</SPAN> MapFrame<SPAN class="punctuation token">;</SPAN>
&nbsp; LayoutElementFactory<SPAN class="punctuation token">.</SPAN>Instance<SPAN class="punctuation token">.</SPAN><SPAN class="token function">CreateScaleBar</SPAN><SPAN class="punctuation token">(</SPAN>layout<SPAN class="punctuation token">,</SPAN> coord<SPAN class="punctuation token">,</SPAN> mf<SPAN class="punctuation token">,</SPAN> scaleBarStyle<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>