A set of optional parameters and functions to help you customize the visualization of military icons and symbols when constructing a MilitarySymbologyPainter.

Hierarchy

  • MilitarySymbologyPainterConstructorOptions

Properties

codeFunction: string | ((f) => string)

A pointer to where the military code (SIDC) for a feature can be found for a given feature. When declaring this as a function, your function will receive a feature as input parameter, and must supply the military code as a return value. If your code is a string, the string must point to the location of the code inside the feature properties. (Example: if your code is located at "feature.properties.my_custom_code_location", then the correct argument here would be "my_custom_code_location").

Type declaration

modifiers?: string | ((f) => any)

A pointer to where the modifiers for the feature can be found. The modifiers contain metadata on the feature. For an overview of possible modifiers, please refer to the class doc of this type or the MS2525/APP6 specifications. This parameter is optional. This parameter can be either a string or a function. When declaring this as a function, your function will receive the feature as input parameter, and must supply an object containing the modifiers as an output. If your modifiers parameter is a string, the string must point to the location of the modifiers inside the feature properties. (Example: if your modifiers are located at "feature.properties.my_geometry_properties", then the correct argument here would be "my_geometry_properties").

Type declaration

style?: string | ((f, p) => MilSymStyle)

A pointer to the styling of a feature. For an overview of styling properties for military icons and tactical graphics, see the documentation of MilSymStyle. This parameter can be either a string or a function:

  • style as string: the string must point to the location of the style inside the feature properties. (Example: if your style is located at "feature.properties.my_feature_style", then the correct argument here is "my_feature_style").
  • style as function: the function receives the feature and the paintState as input parameters, and must supply a MilSymStyle object containing the style parameters as an output.

Type declaration

symbologyServiceOptions?: {
    credentials?: boolean;
}

A set of optional parameters to help you customize the communication with the symbology service.

Type declaration

  • Optional credentials?: boolean

    Sets the value of the withCredentials flag on the XMLHttpRequest object. This can be set to true to include cookies as part of CORS requests to the symbology service, for example.

Deprecated

LuciadRIA now paints its own icons, the service options you provide will not be used.

symbologyServicePath?: string

The absolute path to the symbology service. This is an optional parameter that defaults to "/symbologyservice/", which is the default location of the symbology service when deployed straight from the LuciadRIA build. The symbology service is used to paint military icons.

Deprecated

LuciadRIA now paints its own icons, the service path you provide will not be used.

width?: string | ((f) => number)

A pointer to the arrow width of a feature. The arrow width is expressed in meters, and is only applicable to some tactical graphics. This is optional, and by default this will be 100 meters for all features. This parameter can be either a string or a function. When declaring this as a function, your function will receive the feature as input parameter, and should supply the width of the feature as a Number. If your width parameter is a string, the string should point to the location of the width inside the feature properties. (Example: if your width is located at "feature.properties.my_custom_width", then the correct argument here would be "my_custom_width").

Type declaration