Class MilitarySymbol

Allows retrieving and manipulating modifiers of a military symbol, without having to worry whether the properties are encoded in the symbol code or in textual modifiers.

The modifiers of a military symbol are partly encoded in its symbol code (e.g. the MIL-STD 2525b symbology encodes the affiliation in the second digit of the symbol code) and partly encoded as additional metadata called text modifiers (usually a key-value map). This class exposes all these modifiers as enumerable, modifiable JavaScript properties.

It does not represent a Feature or domain object, and does not cover the geometry. To generate a Shape that corresponds to a military symbol, please use the SymbologyNode.createTemplates method.

Example usages

Query and configure a symbol

  // 1) create a MIL-STD 2525b "rescue" symbol based on the code from the specification or a SymbologyNode
  var codedRescueSymbol = new MilitarySymbol(MIL_STD_2525b, "G*G*GPAR--****X");
  // codedRescueSymbol has properties for all applicable code and text modifiers.
  // Mask characters have been replaced from the symbol code. Hence, the following statement is true:
  // codedRescueSymbol.code === "GUG-GPAR------X"

  // 2) query the available modifiers
  console.log("available modifiers:");
  for (var modifier in codedRescueSymbol) {
    if (codedRescueSymbol.hasOwnProperty(modifier) ) {
      console.log(modifier); // this outputs, among others, "affiliation" and "additionalInformation"
    }
  }

  // 3) query the possible values of the "affiliation" modifier
  codedRescueSymbol.possibleValues("affiliation"); // returns an array containing, among others, the value "Friend"

  // 4) change the "affiliation" modifier.
  codedRescueSymbol.affiliation = "Friend";
  // The properties of a MilitarySymbol object are read-write and immediately update the values for the code and
  // text modifiers. The "affiliation" modifier is encoded in the symbol code, so the following statement is true:
  // codedRescueSymbol.code === "GFG-GPAR------X"

  // 5) change the "additionalInformation" modifier.
  codedRescueSymbol.additionalInformation = "this is an example symbol"; // adds a new entry to codedRescueSymbol.textModifiers
  // the "additional information" modifier is encoded as a text modifier

  // 6) create a domain object with the encoded modifiers
  var rescueDomainObject = new Feature(
    myRescueGeometry,
    {
     code : codedRescueSymbol.code, // "GFG-GPAR------X"
     textModifiers : codedRescueSymbol.textModifiers
    },
    1
  );
Copy

Change a modifier of an existing object

  // Change the value for the status modifier of an existing object
  var codedExistingSymbol = new MilitarySymbol(MIL_STD_2525b, existingDomainObject.code, existingDomainObject.textModifiers);
  codedExistingSymbol.status = "present";
  existingDomainObject.code = codedExistingSymbol.code;
  existingDomainObject.textModifiers = codedExistingSymbol.textModifiers;
Copy

Available modifiers

Depending on the used symbol, a different set of modifiers is exposed as a properties of the MilitarySymbol object. There is a difference between modifiers that get encoded in the symbol code (SIDC) and modifiers that get encoded as text (TEXT). For a full overview of all modifiers for all symbologies, have a look at the article overview of military symbol modifiers.