@armyc2.c5isr.renderer/mil-sym-ts-web 2.2.4 → 2.4.0

package/C5Ren.d.ts

@@ -1,5 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { Canvas } from 'canvas';
+
 export type int = number;
 export type float = number;
 export type double = number;
@@ -1310,6 +1312,26 @@ export declare class MilStdAttributes {
 	 * default value is {@link RendererSettings#getPatternScale()}
 	 */
 	static readonly PatternScale: string;
+	/**
+	 * like "arial"
+	 */
+	static readonly FontFamily: string;
+	/**
+	 * Like Font.BOLD
+	 */
+	static readonly FontStyle: string;
+	static readonly FontSize: string;
+	/**
+	 * Strict ("0") for always placing their labels in the specified location
+	 * even if there's empty space from other labels that weren't populated
+	 * Flexible ("1") to collapse label vertically to the center to eliminate
+	 * empty space from labels that weren't populated.
+	 * Does not apply to Control Measures or METOCS
+	 * Set with values like:
+	 * RendererSettings.ModifierPlacement_STRICT ("0")
+	 * RendererSettings.ModifierPlacement_FLEXIBLE ("1")
+	 */
+	static readonly ModifierPlacement: string;
 	/**
 	 * No Longer relevant
 	 * @return
@@ -1592,12 +1614,22 @@ export declare class Modifiers {
 	 * <pre>
 	 * Lines - Unique Identifier or Primary Purpose
 	 * An amplifier that uniquely identifies a particular symbol or track number. Identifies acquisitions number when used with SIGINT symbology.
-	 * Format: Alphanumeric - {1,30}
-	 * Symbol Set: All
+	 * Format: Alphanumeric - Lines: {1,30}, Points: Alphanumeric - {1,7}
+	 * Symbol Set: 25
 	 * Remarks:
 	 * </pre>
 	 */
 	static readonly T1_UNIQUE_DESIGNATION_2: string;
+	/**
+	 * <pre>
+	 * Lines - Unique Identifier or Primary Purpose
+	 * An amplifier used to provide the designation of the Establishing Headquarters.
+	 * Format: Alphanumeric - {1,7}
+	 * Symbol Set: 25
+	 * Remarks: Used with Fire Support Control Measures only.
+	 * </pre>
+	 */
+	static readonly T2_UNIQUE_DESIGNATION_3: string;
 	/**
 	 * <pre>
 	 * Type
@@ -1772,9 +1804,10 @@ export declare class Modifiers {
 	 * An amplifier that depicts the speed and direction of movement of an object (see 5.3.7.13.3 and figure 18).
 	 * Format: Graphic
 	 * Symbol Set: 10, 15, 30, 35
-	 * Remarks:
-	 * Land units and equipment use the Direction of Movement and Speed amplifiers for this information.
-	 * Notes: Not implemented by the renderer
+	 * Remarks: Set as "[Speed] [unit of measure] [angle in degrees if 3 characters "045", and in mils if 4 characters "0150]" like [100 KPH 045]
+	 * Valid units of measure are: KPH, KPS, MPH, NMH, KTS
+	 * Notes: It is recommended users handle this amplifier within their map engine many maps always show icons in the upright position when the map
+	 * is rotated, invalidating the line that's render with the symbol.
 	 * </pre>
 	 */
 	static readonly AJ_SPEED_LEADER: string;
@@ -4033,6 +4066,22 @@ export declare class RendererSettings {
 	 * end of the staff
 	 */
 	private static _CenterOnHQStaff;
+	/**
+	 * Text modifiers/amplifiers are placed where they belong even if there's empty space
+	 * from other modifiers that weren't populated
+	 */
+	static ModifierPlacement_STRICT: number;
+	/**
+	 * Text modifiers/amplifiers will collapse vertically towards the center to eliminate
+	 * empty space from modifiers that weren't populated.
+	 */
+	static ModifierPlacement_FLEXIBLE: number;
+	/**
+	 * Same as flexible but the modifier letter is put at the beginning of the value string
+	 * to prevent confusion from modifiers not being in their strict location.
+	 * if P (IFF/SIF) is set to "2:1234", it would be rendered as "P:2:1234"
+	 */
+	private static _ModifierPlacementApproach;
 	static OperationalConditionModifierType_SLASH: int;
 	static OperationalConditionModifierType_BAR: int;
 	private static _OCMType;
@@ -4286,6 +4335,19 @@ export declare class RendererSettings {
 	 */
 	getMPLabelFont(): Font;
 	getKMLLabelScale(): float;
+	getSPModifierPlacement(): number;
+	/**
+	 * Strict (0) for always placing their labels in the specified location
+	 * even if there's empty space from other labels that weren't populated
+	 * Flexible (1) to collapse label vertically to the center to eliminate
+	 * empty space from labels that weren't populated.
+	 * Does not apply to Control Measures or METOCS
+	 * Set with values like:
+	 * RendererSettings.ModifierPlacement_STRICT (0)
+	 * RendererSettings.ModifierPlacement_FLEXIBLE (1)
+	 * @param modifierPlacementApproach
+	 */
+	setSPModifierPlacement(modifierPlacementApproach: number): void;
 	/**
 	 * the font name to be used for modifier labels
 	 * @return name of the label font
@@ -4312,7 +4374,7 @@ export declare class RendererSettings {
 	 * Set a boolean indicating between the use of supply routes labels in all segments (false) or
 	 * to only set 2 labels one at the north and the other one at the south of the graphic (true).
 	 * @param TwoLabelOnly
-	 * @deprecated
+	 * @deprecated functionally disabled
 	 */
 	setTwoLabelOnly(TwoLabelOnly: boolean): void;
 	/**
@@ -4603,6 +4665,8 @@ export declare class SymbolID {
 	static readonly StandardIdentity_Context_Reality: number;
 	static readonly StandardIdentity_Context_Exercise: number;
 	static readonly StandardIdentity_Context_Simulation: number;
+	static readonly StandardIdentity_Context_Restricted_Target_Reality: number;
+	static readonly StandardIdentity_Context_No_Strike_Entity_Reality: number;
 	static readonly StandardIdentity_Affiliation_Pending: number;
 	static readonly StandardIdentity_Affiliation_Unknown: number;
 	static readonly StandardIdentity_Affiliation_AssumedFriend: number;
@@ -4689,12 +4753,13 @@ export declare class SymbolID {
 	static readonly FrameShape_Space: string;
 	static readonly FrameShape_Air: string;
 	static readonly FrameShape_LandUnit: string;
-	static readonly FrameShape_LandEquipment_SeaSurface: string;
+	static readonly FrameShape_LandEquipment: string;
 	static readonly FrameShape_LandInstallation: string;
 	static readonly FrameShape_DismountedIndividuals: string;
 	static readonly FrameShape_SeaSubsurface: string;
 	static readonly FrameShape_Activity_Event: string;
 	static readonly FrameShape_Cyberspace: string;
+	static readonly FrameShape_SeaSurface: string;
 	/**
 	 * Attempts to resolve a bad symbol ID into a value that can be found in {@link MSLookup}.
 	 * If it fails, it will return the symbol code for a invalid symbol which is displayed as
@@ -4854,7 +4919,7 @@ export declare class SymbolID {
 	/**
 	 * Set Sector 1 Modifier at positions 17-18.
 	 * @param symbolID 30 Character string
-	 * @param mod1 number 0-255 or string "00" to "FF"
+	 * @param mod1 number 0-99 && 161-255 OR string "00" to "FF"
 	 * @return string
 	 */
 	static setModifier1(symbolID: string, mod1: number | string): string;
@@ -4883,7 +4948,7 @@ export declare class SymbolID {
 	 * @param mod2 number 0-255 or string "00" to "FF"
 	 * @return string
 	 */
-	static setModifier2(symbolID: string, mod2: number): string;
+	static setModifier2(symbolID: string, mod2: number | string): string;
 	/**
 	 * Get Common Sector 2 Modifier from position 22.
 	 * @param symbolID 30 Character string
@@ -4947,6 +5012,13 @@ export declare class SymbolID {
 	 * @return string (1 character)
 	 */
 	static getDefaultFrameShape(symbolID: string): string;
+	/**
+	 *
+	 * @param symbolID
+	 * @param frameShape like SymbolID.FrameShape_LandEquipment
+	 * @return
+	 */
+	static setFrameShape(symbolID: string, frameShape: string): string;
 	/**
 	 * Gets the Frame Shape override from position 23.
 	 * @param symbolID 30 Character string
@@ -6536,6 +6608,13 @@ export declare class RendererUtilities {
 	 * @return
 	 */
 	static colorToHexString(color: Color, withAlpha: boolean): string;
+	static getCanvas(width: number, height: number): OffscreenCanvas | Canvas;
+	/**
+	 *
+	 * @param canvas
+	 * @returns OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D
+	 */
+	static getContext(canvas: OffscreenCanvas | Canvas): any;
 	/**
 	 * Clients should use getTextBounds
 	 * @param {String} fontName like "Arial" or "Arial, sans-serif" so a backup is