forked from spatialillusions/milsymbol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
173 lines (160 loc) · 5.49 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
type ColorMode = {
Civilian: string;
Friend: string;
Hostile: string;
Neutral: string;
Unknown: string;
};
type SymbolOptions = {
additionalInformation?: string;
alternateMedal?: boolean;
altitudeDepth?: string;
auxiliaryEquipmentIndicator?: string;
civilianColor?: boolean;
colorMode?: ColorMode | string;
combatEffectiveness?: string;
commonIdentifier?: string;
country?: string;
direction?: string;
dtg?: string;
engagementBar?: string;
engagementType?: string;
equipmentTeardownTime?: string;
evaluationRating?: string;
fill?: boolean;
fillOpacity?: number;
fontfamily?: string;
frame?: boolean;
frameColor?: ColorMode;
guardedUnit?: string;
headquartersElement?: string;
higherFormation?: string;
hostile?: string;
hqStaffLength?: number;
icon?: boolean;
iconColor?: ColorMode | string;
iffSif?: string;
infoBackground?: ColorMode | string;
infoBackgroundFrame?: ColorMode | string;
infoColor?: ColorMode | string;
infoFields?: boolean;
infoOutlineColor?: string;
infoOutlineWidth?: number;
infoSize?: number;
installationComposition?: string;
location?: string;
monoColor?: string;
outlineColor?: ColorMode | string;
outlineWidth?: number;
padding?: number;
platformType?: string;
quantity?: string;
reinforcedReduced?: string;
sidc?: string;
sigint?: string;
signatureEquipment?: string;
simpleStatusModifier?: boolean;
size?: number;
specialDesignator?: string;
specialHeadquarters?: string;
speed?: string;
speedLeader?: number;
square?: boolean;
staffComments?: string;
standard?: string;
strokeWidth?: number;
type?: string;
uniqueDesignation?: string;
};
type SymbolMetadata = {
activity: boolean; // Is it an Activity
affiliation: string; // Affiliation it is shown as (Friend/Hostile...)
baseAffilation: string; // Affiliation it belongs to (Friend/Hostile...)
baseDimension: string; // Dimension it belongs to (Air/Ground...)
baseGeometry: Object; // Geometry is a combination of dimension and affiliation (AirFriend/GroundHostile...)
civilian: boolean; // Is it Civilian
condition: string; // What condition is it in
context: string; // Context of the symbol (Reality/Exercise...)
dimension: string; // Dimension it is shown as (Air/Ground...) for example Ground Equipment is shown with the same shape as Sea.
dimensionUnknown: boolean; // Is the dimension unknown
echelon: string; //What echelon (Platoon/Company...)
faker: boolean; // Is it a Faker
fenintDummy: boolean; // Is it a feint/dummy
fill: boolean; // Standard says it should be filled
frame: boolean; // Standard says it should be framed
functionid: string; // Part of SIDC referring to the icon.
headquarters: boolean; // Is it a Headquarters
installation: boolean; // Is it an Instalation
joker: boolean; // Is it a Joker
mobility: string; // What mobility (Tracked/Sled...)
notpresent: string; // Is it Anticipated or Pending
numberSIDC: boolean; // Is the SIDC number based
space: boolean; // Is it in Space
taskForce: boolean; // Is it a task force
};
type SymbolColors = {
black: string; // Black parts of the symbol.
fillColor: string; // Symbol fill color.
frameColor: string; // Symbol frame color.
iconColor: string; // Icon color.
iconFillColor: string; // Icon fill color.
none: string; // Transparent parts of the symbol.
white: string; // White parts of the symbol.
};
export class Symbol {
constructor(
code: string | SymbolOptions,
opts?: SymbolOptions,
style?: SymbolOptions
);
asCanvas(factor?: number): HTMLCanvasElement;
asDOM(): Element;
asSVG(): string;
getAnchor(): { x: number; y: number };
getColors(): SymbolColors;
getOctagonAnchor(): { x: number; y: number };
getOptions(includeStyle?: boolean): SymbolOptions;
getMetadata(): SymbolMetadata;
getSize(): { width: number; height: number };
getStyle(): SymbolOptions;
isValid(extended?: boolean): boolean | Object;
setOptions(opts: SymbolOptions): Symbol;
toDataURL(): string;
}
interface Box {
x1: number,
y1: number,
x2: number,
y2: number,
}
interface BBoxObject extends Box {
width(): number,
height(): number,
/** Merges one box with another returns the original box */
merge(box: Box): this
}
/** Creates a bounding box object */
export function BBox(box?: Partial<Box>): BBoxObject;
/** Creates a ColorMode Object with colors used for different affiliations. */
export function ColorMode(civilian: string, friend: string, hostile: string, neutral: string, unknown: string): ColorMode;
/** Gets a color mode that has been registred with setColorMode */
export function getColorMode(mode: string): ColorMode;
/** Register a ColorMode with a name or override an existing ColorMode. */
export function setColorMode(name: string, colormode: ColorMode): ColorMode;
/** Gets the length of the HQ staf used for HQ symbols. */
export function getHqStaffLength(): number;
/** Sets the length of the HQ staf used for HQ symbols. */
export function setHqStaffLength(staff_length: number): number;
interface DashObject {
pending: string,
anticipated: string,
feintDummy: string
}
/** Gets the diffrent dash arrays used for dashed lines. */
export function getDashArrays(): DashObject;
/** Sets the dash arrays used for dashed lines */
export function setDashArrays(pending: string, anticipated: string, feintDummy: string): DashObject;
// Gets the version of milsymbol.
export function getVersion(): string;
/** Sets the preferred standard. */
export function setStandard(standard: "2525" | "APP6"): boolean;