Symbol

Instance Constructors

new Symbol(SIDC: String, options: SymbolOptions = ???)

constructor
new Symbol()

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var XML: String

XML-string for the current marker
var additionalInformation: String

FieldID H - A text modifier for units, equipment, and installations; content is implementation specific.
FieldID H - A text modifier for units, equipment, and installations; content is implementation specific. 20 Characters
var alternateMedal: Boolean

MIL-STD-2525D lets you choose between MEDAL and alternate MEDAL icons for mine warefare symbols, the default in milsymbol is using MEDAL icons, but you can change this using setting this property to true.
var altitudeDepth: String

FieldID X - A text modifier for units, equipment, and installations, that displays either altitude flight level, depth for submerged objects; or height of equipment or structures on the ground.
FieldID X - A text modifier for units, equipment, and installations, that displays either altitude flight level, depth for submerged objects; or height of equipment or structures on the ground. 14 Characters
def asCanvas(ratio: Double = 1): Canvas

Draws the marker to a canvas element using native draw instructions and returns the canvas element.
def asDOM(): Element

Parses the XML and returns a DOM element.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asSVG(): String

This will return the SVG XML string and it will also be stored in the XML property, if autoSVG is set to true the will be called automatically when you call getMarker.
var bbox: BoundingBox

Contains the bounding box of the current marker
var civilianColor: Boolean

2525C specifics purple as an optional color for civilian symbols.
2525C specifics purple as an optional color for civilian symbols. Of corse we like color so we set this as default.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var colorMode: ColorMode

This is the option for setting what Color object to use for the fill of the symbols.
This is the option for setting what Color object to use for the fill of the symbols. You can use MS.colorMode to create a new color mode, or MS.getColorMode to get an existing color mode.
var colors: Array[ColorMode]

Contains the colors for the current marker
var combatEffectiveness: String

FieldID K - A text modifier for units and installations that indicates unit effectiveness or installation capability.
FieldID K - A text modifier for units and installations that indicates unit effectiveness or installation capability. 5 Characters
var commonIdentifier: String

FieldID AF - Example: "Hawk" for Hawk SAM system.
var direction: Double

FieldID Q - at the moment all directions should be in degrees and not in mils.
FieldID Q - at the moment all directions should be in degrees and not in mils. Set to an empty string to remove the direction arrow.
var dtg: String

FieldID W - A text modifier for units, equipment, and installations that displays DTG format: DDHHMMSSZMONYYYY or "O/O" for on order.
FieldID W - A text modifier for units, equipment, and installations that displays DTG format: DDHHMMSSZMONYYYY or "O/O" for on order. 16 Characters
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var equipmentTeardownTime: String

FieldID AE - Equipment teardown time in minutes.
var evaluationRating: String

FieldID J - A text modifier for units, equipment, and installations that consists of a one-letter reliability rating and a one-number credibility rating.
FieldID J - A text modifier for units, equipment, and installations that consists of a one-letter reliability rating and a one-number credibility rating. 2 Characters
var fill: Boolean

Should your symbol be filled with color.
var fillOpacity: Double

The opacity of the symbol fill color.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
var frame: Boolean

Should your symbol have a frame.
Should your symbol have a frame. All symbols support to be unframed, not just the ones specified in 2525B.
def getAnchor(): Anchor

returns an object with the x and y offset of the symbol.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getColors(): SymbolColor

This will return an object with several named properties, where each property is a Color object.
This will return an object with several named properties, where each property is a Color object. This represent all colors that can be used for the current marker.
def getMarker(): Symbol

When the getMarker() method is called, all properties of the Symbol Object is updated (getMarker() calls getProperties() and getColors()) and a marker is composed by all marker parts.
When the getMarker() method is called, all properties of the Symbol Object is updated (getMarker() calls getProperties() and getColors()) and a marker is composed by all marker parts. When this is done the Symbol Object itself is returned.
Note: not needed anymore, symbols are automatically updated when options are updated using setOptions().
def getOctagonAnchor(): Anchor

returns an object with the x and y offset of the octagon center.
def getProperties(): Properties

This will update and return the Properties Object for the current marker.
def getSize(): Size

returns an object with the width and height of the symbol.
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var headquartersElement: String

Example: Tactical Operations Centre put as 'TOC'.
var height: Double

Height of the current marker
var higherFormation: String

FieldID M - A text modifier for units that indicates number or title of higher echelon command (corps are designated by Roman numerals).
FieldID M - A text modifier for units that indicates number or title of higher echelon command (corps are designated by Roman numerals). 21 Characters
var hostile: String

FieldID N - A text modifier for equipment; letters "ENY" denote hostile symbols.
FieldID N - A text modifier for equipment; letters "ENY" denote hostile symbols. 3 Characters
var icon: Boolean

Should your symbol have an icon.
var iffSif: String

FieldID P - A text modifier displaying IFF/SIF Identification modes and codes.
FieldID P - A text modifier displaying IFF/SIF Identification modes and codes. 5 Characters
var infoFields: Boolean

If you have set some text fields and direction but don't want them to be displayed you can set infoFields to false.
If you have set some text fields and direction but don't want them to be displayed you can set infoFields to false. This makes it possible to initiate the object with all information you got but not display it.
var infoSize: Double

The size of the text fields surrounding the symbol.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var location: String

FieldID Y - A text modifier for units, equipment, and installations that displays a symbol's location in degrees, minutes, and seconds (or in UTM or other applicable display format).
FieldID Y - A text modifier for units, equipment, and installations that displays a symbol's location in degrees, minutes, and seconds (or in UTM or other applicable display format). 19 Characters
var markerAnchor: Anchor

The anchor point for the current marker, this is usually the center of the octagon, but for headquarters it's the end of the staf.
The anchor point for the current marker, this is usually the center of the octagon, but for headquarters it's the end of the staf. The coordinates are measured from the top left corner of the marker.
var monoColor: String

A color that is either a keyword or a numerical RGB specification.
A color that is either a keyword or a numerical RGB specification. If you set this the symbol will be monochrome and unfilled using the color provided.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var octagonAnchor: Anchor

The anchor point for the octagon for the current marker.
The anchor point for the octagon for the current marker. The coordinates are measured from the top left corner of the marker.
var platformType: String

FieldID AD - "ELNOT" or "CENOT"
var properties: Properties

Properties of the current marker
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
var quantity: String

FieldID C - A text modifier in an equipment symbol that identifies the number of items present.
FieldID C - A text modifier in an equipment symbol that identifies the number of items present. 9 Characters
var reinforcedReduced: String

FieldID F - A text modifier in a unit symbol that displays (+) for reinforced, (-) for reduced, (±) reinforced and reduced.
FieldID F - A text modifier in a unit symbol that displays (+) for reinforced, (-) for reduced, (±) reinforced and reduced. 3 Characters
def setOptions(options: SymbolOptions): Symbol

If you want to change the options of an existing symbol at the same time as you want to request it as a new marker, you can use setOptions(<Symbol options> options?) to update the options.
var sigint: String

FieldID R2 - M = Mobile, S = Static, or U = Uncertain.
var signatureEquipment: String

FieldID L - A text modifier for hostile equipment; "!" indicates detectable electronic signatures.
FieldID L - A text modifier for hostile equipment; "!" indicates detectable electronic signatures. 1 Characters
var size: Double

The L value for your symbol, where the L value is the width of the icon octagon.
var specialHeadquarters: String

FieldID AA - A text modifier for units; indicator is contained inside the frame; contains the name of the special C2 Headquarters.
FieldID AA - A text modifier for units; indicator is contained inside the frame; contains the name of the special C2 Headquarters. 9 Characters
var speed: String

FieldID Z - A text modifier for units and equipment that displays velocity as set forth in MIL-STD-6040.
FieldID Z - A text modifier for units and equipment that displays velocity as set forth in MIL-STD-6040. 8 Characters
var staffComments: String

FieldID G - A text modifier for units, equipment and installations; content is implementation specific.
FieldID G - A text modifier for units, equipment and installations; content is implementation specific. 20 Characters
var strokeWidth: Double

The stroke width of the symbol.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toDataURL(): String

Base 64 encodes the XML and returns the output as a SVG image stream that can be set as the source attribute on a image element.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
var type: String

FieldID V - A text modifier for equipment that indicates types of equipment.
FieldID V - A text modifier for equipment that indicates types of equipment. 24 Characters
var uniqueDesignation: String

FieldID T - A text modifier for units, equipment, and installations that uniquely identifies a particular symbol or track number.
FieldID T - A text modifier for units, equipment, and installations that uniquely identifies a particular symbol or track number. Identifies acquisitions number when used with SIGINT symbology. 21 Characters
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
var width: Double

Width of the current marker

Related Doc: package ms

class Symbol extends Object

Instance Constructors

new Symbol(SIDC: String, options: SymbolOptions = ???)

new Symbol()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var XML: String

var additionalInformation: String

var alternateMedal: Boolean

var altitudeDepth: String

def asCanvas(ratio: Double = 1): Canvas

def asDOM(): Element

final def asInstanceOf[T0]: T0

def asSVG(): String

var bbox: BoundingBox

var civilianColor: Boolean

def clone(): AnyRef

var colorMode: ColorMode

var colors: Array[ColorMode]

var combatEffectiveness: String

var commonIdentifier: String

var direction: Double

var dtg: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var equipmentTeardownTime: String

var evaluationRating: String

var fill: Boolean

var fillOpacity: Double

def finalize(): Unit

var frame: Boolean

def getAnchor(): Anchor

final def getClass(): Class[_]

def getColors(): SymbolColor

def getMarker(): Symbol

def getOctagonAnchor(): Anchor

def getProperties(): Properties

def getSize(): Size

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var headquartersElement: String

var height: Double

var higherFormation: String

var hostile: String

var icon: Boolean

var iffSif: String

var infoFields: Boolean

var infoSize: Double

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

var location: String

var markerAnchor: Anchor

var monoColor: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

var octagonAnchor: Anchor

var platformType: String

var properties: Properties

def propertyIsEnumerable(v: String): Boolean

var quantity: String

var reinforcedReduced: String

def setOptions(options: SymbolOptions): Symbol

var sigint: String

var signatureEquipment: String

var size: Double

var specialHeadquarters: String

var speed: String

var staffComments: String

var strokeWidth: Double

final def synchronized[T0](arg0: ⇒ T0): T0

def toDataURL(): String

def toLocaleString(): String

def toString(): String

var type: String

var uniqueDesignation: String