Beginning Editing Edit Operations and Inspector. Charlie Macleod

Transcription

1 Beginning Editing Edit Operations and Inspector Charlie Macleod

2 Beginning Editing - Overview Edit Operation - Basic Workflows and Usage Inspector - Alternative to Edit Operation - Geared toward modifying an existing feature

3 Edit Operation - Overview EditOperation is the primary pattern for Editing in the Pro API - Performs 3 key functions: - Provides a coarse grained API for editing. - Consolidate multiple edits into a single operation - Invalidates underlying caches for MapMembers edited by the operation

4 Edit Operation - Overview Combine multiple datasets from the same datastore or different datastores - EditOperation ensures the required underlying edit sessions are established Call Execute or ExecuteAsync to execute the individual operations - Execute, ExecuteAsync can only be called once!

5 Edit Operation - Usage Instantiate with new : var editop = new EditOperation(); Configure: - Name: String used in the Undo/Redo stack - ErrorMessage: Error string to show to the user on failure - ProgressMessage: String to show user during execution - ShowProgressor: True to show a progressor - SelectNewFeatures: True to select features after Create - SelectModifiedFeatures: True to select features after updates var editop = new EditOperation(){ Name = Simple edit operation, ErrorMessage = Simple edit failed, SelectNewFeatures = true, SelectModifiedFeatures = true };

6 Edit Operation - Usage Specify operation methods to be performed in any combination: - Creates, Updates, Deletes - Create, Modify, Scale, Move, Rotate, Transform, Clip, Reshape, Planarize, Cut, Split, Explode, Planarize, Delete, etc. - Provide relevant params typically some combination of: - MapMember, Dataset + oid(s) and/or geometry as params - Lots of overloads - Each operation method specified must be independent of any other - (Cover dependent operations in Advanced Session) editop.create(polylayer1.gettemplates().first(), poly_geom); editop.modify(linelayer1, oid, line_geom); editop.move(mapview.active.map.getselection(), 15.0, 15.0); //Execute the operations - Execute requires QueuedTask.Run! editop.execute();

7 Edit Operation Call Execute: - All specified operation methods are executed (in a predefined order ) - Order is not important Check status (as needed) - IsDone: Indicates EditOperation has been executed (set immediately) - IsSucceeded: True if the EditOperation executed successfully - Return value: True on success, False on failure //execute the operations, check status //await editop.executeasync() editop.execute(); if (editop.issucceeded) if (editop.execute()) { { } }

8 Edit Operation Usage var editop = new EditOperation(); editop.name = Create operation"; //Add three points show different Create() options var start_pt =...; editop.create(pointslayer1, start_pt); //simplest form editop.create(pointslayer1.gettemplates().first(), GeometryEngine.Instance.Move(start_pt, distance, 0.0)); //use defaults from template var attribs = new Dictionary<string, object>(); attribs["shape"] = GeometryEngine.Instance.Move(start_pt, distance * 2, 0.0); attribs["facilityid"] = " "; editop.create(pointslayer1, attribs); //using dictionary //Execute the operations editop.execute();

9 Edit Operation Usage cont d var editop = new EditOperation() { Name = "Simple edit2", ErrorMessage = "'Simple edit2' failed", CancelMessage = "'Simple edit2' cancelled", SelectModifiedFeatures = true }; editop.modify(polylayer1, 1, buffer); editop.reshape(polylayer2, 1, reshape_poly); editop.modify(pointslayer1, 28, MapPointBuilder.CreateMapPoint( , )); //Execute the operations editop.execute(); if (editop.issucceeded) {...

10 Edit Operation demo

11 Edit Operation Dependent Edits Considerations*: - To execute dependent operations, create a new edit operation - Can execute operations dependent on a previous edit operation - Conditional logic can check return value or IsSucceeded //General pattern for executing two operations where the second operation is //dependent on the first var editop1 = new EditOperation();... //execute the first operation, check return or status via IsSucceeded if (editop1.execute()) { var editop2 = new EditOperation();... editop2.execute(); //execute the 2nd operation } - *In Advanced session we cover Chaining edit operations

12 Inspector - Overview Convenient utility class for MapMember feature attribute access and editing - Three primary uses: - Get existing feature attributes (to include SHAPE) - Set existing feature attributes (to include SHAPE) - Preferred mechanism for editing annotation properties - Copy attributes to new or edited features - Use an existing feature as a substitute for a template

13 Inspector - Overview Typical Usage - Instantiate instance with new - Call Load, LoadAsync to load attributes (bypasses Search(), RowCursor, Row) - Field values loaded into an Attribute Dictionary in the Inspector - Attributes are of type ArcGIS.Desktop.Editing.Attributes.Attribute - Also loads attributes that are JOINed - Make changes via dictionary-style semantics for feature attributes - Inspector[ BUILDING_ID ] = 2700; //getter and setter - Commit changes with Apply or ApplyAsync - Also integrates with EditOperation via various operation overloads

14 Inspector - Usage Get and Set existing feature attributes: - Instantiate an inspector: using ArcGIS.Desktop.Editing.Attributes; var inspector = new Inspector(); - Load the feature attributes: inspector.load(pointslayer1, 28); //or LoadAsync - Make the change(s) and Apply: inspector["facilityid"] = " "; //Use dictionary-style setters inspector["name"] = "BLDG 52"; inspector["descript"] = inspector["name"]; inspector.apply(); //or ApplyAsync

15 Inspector Usage Cont d Enumerate Inspector attributes - Inspector supports IEnumerable for LINQ style access of its attribute dictionary - Use attributes to examine metadata about the fields they represent: - Name, FieldType, Subtype, Nullable, Editable, Geometry, Dirty, Alias, etc. public sealed class Inspector : IEnumerable<Attribute>, IEnumerable { public IEnumerator<Attribute> GetEnumerator();... inspector.load(... //edit attribute values, etc. var edited_values = new List<string>(); foreach (var attrib in inspector) { if (attrib.isdirty) { var orig = attrib.originalvalue?.tostring()?? "null"; var now = attrib.currentvalue?.tostring()?? "null"; edited_values.add($"{attrib.fieldname}: {orig} -> {now})");

16 Inspector Usage Cont d Use Load(MapMember, IEnumerable<long>) to load more than one feature: - Attribute values are conflated (into the attribute dictionary). - Attribute values that are different across features are set to System.DBNull in the dictionary - *Geometry, Blob, Raster values will be null (not DBNull) var names = inspector.where(a => a.currentvalue == System.DBNull).Select(a => a.fieldname); - Setting attribute values applies the change to all (loaded) feature records //select and load all the pointslayer1 features inspector.load(pointslayer1, pointslayer1.select().getobjectids()); inspector["facilityid"] = " "; //Change FACILITYID for ~all~ selected features inspector.apply();

17 Inspector Usage Cont d Integrate with EditOperation to combine with other edits: - Use the relevant overload that takes an Inspector - Typically EditOperation.Modify - Use EditOperation.Execute() var inspector = new Inspector(); inspector.load(pointslayer1, 28); inspector["facilityid"] = " "; inspector["name"] = "BLDG 52"; var editop = new EditOperation() { Name = "Modify Facility Points", CancelMessage = "Modify Facility Points canceled" }; editop.modify(inspector);... editop.execute();

18 Inspector demo

19 Inspector - Copy attributes to new or existing features - Set defaults using loaded attributes in-lieu of a template - Usage - Load the desired feature attributes - Modify loaded attributes as needed (eg Shape) - Call the desired overload on EditOperation - Create call Create(MapMember member, Inspector inspector) overload - Create, Modify flavors with Dictionary<string, object> values/attributes parameter

20 Inspector - Using Create(MapMember member, Inspector inspector) //load feature inspector.load(pointslayer1, 28); inspector.shape = pt1; //change geometry if needed editop.create(pointslayer1, inspector); Use foreach and copy var attribs = new Dictionary<string, object>(); foreach(var a in inspector) attribs[a.fieldname] = a.isgeometryfield? pt : a.currentvalue; editop.create(pointslayer1, attribs); - Using Create/Modify with Dictionary<string, object> parameters - Use LINQ to convert inspector attributes editop.modify(pointslayer1, 24, inspector.todictionary(a => a.fieldname, a => a.currentvalue));

21 Inspector demo2

22 Beginning Editing - Summary Edit Operation - Coarse grained API - Combine multiple operations into a single execute - Each operation must be independent of any other - Can be executed once Inspector - Alternative to Edit Operation - Convenient API for modifying selected feature(s) attributes - Overloads on Edit Operation consume inspector - Copy attributes to new or edited features

23 Beginning Editing Questions?

24 Thank You to Our Sponsors

25

26 Inspector - EmbeddableControl if (_theinspector == null) { _theinspector = new Inspector(); var tuple = _theinspector.createembeddablecontrol(); _vm.inspectorview = tuple.item2; _vm.inspectorviewmodel = tuple.item1; } <Grid MaxHeight="400" MaxWidth="300"> <Border BorderBrush="DarkGray" BorderThickness="2"> <DockPanel LastChildFill="true" Margin="2"> <ContentPresenter Content="{Binding InspectorView} /> </DockPanel> </Border> </Grid>

27 Edit Templates // get the current template var mytemplate = ArcGIS.Desktop.Editing.Templates.EditingTemplate.Current; // get templates by name ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() => { var map = MapView.Active.Map; var maintemplate = map.findlayers("main").first().gettemplate("distribution"); var mhtemplate = map.findlayers("manhole").first().gettemplate("active"); // activate the default tool and make template current mhtemplate.activatedefaulttoolasync(); });

28 Edit Templates To create or modify templates, must use the Template Definition from the CIM Can only change persisted templates (AutoGenerateFeatureTemplates = false) //get CIM layer definition var layerdef = polygonlayer.getdefinition() as CIMFeatureLayer; // can't make anything stick if this is still true if (layerdef.autogeneratefeaturetemplates) layerdef.autogeneratefeaturetemplates = false; var mytemplatedef = new CIMFeatureTemplate(); mytemplatedef.name = "My template"; mytemplatedef.writetags(new[] { "Polygon" }); //get all templates on this layer var layertemplates = layerdef.featuretemplates.tolist(); //add the new template to the layer template list layertemplates.add(mytemplatedef); //set the layer definition templates from the list layerdef.featuretemplates = layertemplates.toarray(); //and commit polygonlayer.setdefinition(layerdef);

29 Setting a Construction Tool as the Default Tool on a Template Add a GUID for the tool in the Config.daml <controls> <tool id="simpleconstructiontool" categoryrefid="esri_editing_construction_point" caption="simpleconstructiontool" classname="simpleconstructiontool" loadonclick="true" smallimage="images\genericbuttonred16.png" largeimage="images\genericbuttonred32.png"> <tooltip heading="arcgis Pro SDK">Default construction tool.<disabledtext /></tooltip> <content guid="de7d77d b-b718-3fc0c43f6090" /> </tool> <controls> var templatedef = template.getdefinition(); templatedef.toolprogid ="DE7D77D B-B718-3FC0C43F6090 ; template.setdefinition(templatedef);

30 Edit Templates Use CIMFeatureTemplate.ToXml() of an existing template to determine structure //<CIMFeatureTemplate xsi:type="typens:cimfeaturetemplate"> // <Description>Template for Polygon 1</Description> // <Name>Polygon 1</Name> // <Tags>Polygon</Tags> // <ToolProgID>8f79967b-66a0-4a1c-b884-f44bc7e26921</ToolProgID> // <DefaultValues xsi:type="typens:propertyset"> // <PropertyArray xsi:type="typens:arrayofpropertysetproperty"> // <PropertySetProperty xsi:type="typens:propertysetproperty"> // <Key>notetype</Key> // <Value xsi:type="xs:short">1</value> // </PropertySetProperty> // </PropertyArray> // </DefaultValues> //</CIMFeatureTemplate> Extension methods available to create or modify templates will be available in 2018.

31