@armyc2.c5isr.renderer/mil-sym-ts-web 2.5.0 → 2.6.1

package/C5Ren.d.ts

@@ -648,8 +648,8 @@ export declare class Rectangle2D {
 	isEmpty(): boolean;
 	setRect(r: Rectangle2D): void;
 	setRect(x1: double, y1: double, width1: double, height1: double): void;
-	grow(size: int): any;
-	grow(h: int, v: int): any;
+	grow(size: int): void;
+	grow(h: int, v: int): void;
 	stroke(context: OffscreenCanvasRenderingContext2D): void;
 	fill(context: OffscreenCanvasRenderingContext2D): void;
 	clone(): Rectangle2D;
@@ -3624,6 +3624,45 @@ export declare class MSLookup {
 	getIDList(version: number): Array<string>;
 	addCustomSymbol(msInfo: MSInfo): boolean;
 }
+/**
+ *
+ */
+export declare class SectorModUtils {
+	private static _instance;
+	private static _initCalled;
+	private static _isReady;
+	private static _sectorMods;
+	private static _sectorModLists;
+	private static smd;
+	private static sme;
+	/**
+	 *
+	 * @param url
+	 * @deprecated
+	 */
+	static setData(url: string): Promise<void>;
+	private constructor();
+	static getInstance(): SectorModUtils;
+	isReady(): boolean;
+	private init;
+	private loadData;
+	/**
+	 *
+	 * @param version like SymbolID.Version_2525Dch1 or SymbolID.Version_2525Ech1  Only tracks sector mods for these 2 versions.
+	 * @param symbolSet  like SymbolID.SymbolSet_Air; use 0 for Common Modifiers as they are not tied to a symbol set.
+	 * @param location 1 for top, 2 for bottom
+	 * @return and ArrayList of String[] like ["00","Unspecified"],["01","Attack/Strike"]
+	 */
+	getSectorModList(version: number, symbolSet: number, location: number): Array<string[]>;
+	/**
+	 *
+	 * @param version like SymbolID.Version_2525Dch1 or SymbolID.Version_2525Ech1  Only tracks sector mods for these 2 versions.
+	 * @param symbolSet  like SymbolID.SymbolSet_Air; use 0 for Common Modifiers as they are not tied to a symbol set.
+	 * @param location 1 for top, 2 for bottom
+	 * @param code like "01" or "100"
+	 */
+	getName(version: number, symbolSet: number, location: number, code: string): string;
+}
 export declare class SVGInfo {
 	private _ID;
 	private _Bbox;
@@ -4104,6 +4143,7 @@ export declare class RendererSettings {
 	private _TwoLabelOnly;
 	private _scaleMainIconWithoutSectorMods;
 	private _patternScale;
+	private _overscanScale;
 	private _friendlyUnitFillColor;
 	private _hostileUnitFillColor;
 	private _neutralUnitFillColor;
@@ -4395,6 +4435,15 @@ export declare class RendererSettings {
 	 */
 	setPatternScale(patternScale: double): void;
 	getPatternScale(): double;
+	/**
+	 * Optionally expand multipoint rendering outside bounding box by a scale factor.
+	 * Useful when panning map before rendering with updated bounding box.
+	 * Only referenced when bounding box is a valid rectangle.
+	 * For example, setting overscanScale to 3 would render all shapes within range 3 * the width and 3 * the height of the bounding box
+	 * @param overscanScale default is 1 and minimum is 1
+	 */
+	setOverscanScale(overscanScale: double): void;
+	getOverscanScale(): double;
 	/**
 	 * get the preferred fill affiliation color for units.
 	 *
@@ -4691,11 +4740,30 @@ export declare class SymbolID {
 	static readonly SymbolSet_Atmospheric: number;
 	static readonly SymbolSet_Oceanographic: number;
 	static readonly SymbolSet_MeteorologicalSpace: number;
+	/**
+	 * in 2525E+, there is only SymbolSet_SignalsIntelligence and the frame shape position is required to be populated.
+	 * Valid frames are space, air, land, land equipment, sea surface, sea subsurface and cyberspace.
+	 */
 	static readonly SymbolSet_SignalsIntelligence: number;
+	/**
+	 * 2525D/Dch1 only
+	 */
 	static readonly SymbolSet_SignalsIntelligence_Space: number;
+	/**
+	 * 2525D/Dch1 only
+	 */
 	static readonly SymbolSet_SignalsIntelligence_Air: number;
+	/**
+	 * 2525D/Dch1 only
+	 */
 	static readonly SymbolSet_SignalsIntelligence_Land: number;
+	/**
+	 * 2525D/Dch1 only
+	 */
 	static readonly SymbolSet_SignalsIntelligence_SeaSurface: number;
+	/**
+	 * 2525D/Dch1 only
+	 */
 	static readonly SymbolSet_SignalsIntelligence_SeaSubsurface: number;
 	static readonly SymbolSet_CyberSpace: number;
 	static readonly SymbolSet_InvalidSymbol: number;
@@ -6710,7 +6778,18 @@ export declare class RendererUtilities {
 	 */
 	static setSVGSPCMColors(symbolID: string, svg: string, strokeColor: Color, fillColor: Color, isOutline: boolean): string;
 	static findWidestStrokeWidth(svg: string): float;
+	static findInstIndIndex(svg: string): number;
 	static getDistanceBetweenPoints(pt1: Point2D, pt2: Point2D): int;
+	/**
+	 * A starting point for calculating map scale.
+	 * The User may prefer a different calculation depending on how their maps works.
+	 * @param mapPixelWidth Width of your map in pixels
+	 * @param eastLon East Longitude of your map
+	 * @param westLon West Longitude of your map
+	 * @param dpi Dots Per Inch of your device.  If not included, will use default renderer value.
+	 * @return Map scale value to use in the RenderSymbol function {@link armyc2.c5isr.web.render.WebRenderer#RenderSymbol(String, String, String, String, String, String, double, String, Map, Map, int)}
+	 */
+	static calculateMapScale(mapPixelWidth: number, eastLon: number, westLon: number, dpi?: number): number;
 	static scaleIcon(symbolID: string, icon: SVGInfo): SVGInfo;
 	static getData(path: string): Promise<any>;
 }