Class RendererUtilities

Index

Constructors

Methods

calculateMapScale colorToHexString findInstIndIndex findWidestStrokeWidth getColorFromHexString getData getDistanceBetweenPoints getIdealOutlineColor getRecommendedTextOutlineWidth imgToBase64String increaseStrokeWidth measureText scaleIcon setAffiliationDashArray setColorAlpha setSVGFrameColors setSVGSPCMColors

Constructors

constructor

new RendererUtilities(): RendererUtilities
Returns RendererUtilities

Methods

`Static`calculateMapScale

calculateMapScale(mapPixelWidth, eastLon, westLon, dpi?): number
A starting point for calculating map scale. The User may prefer a different calculation depending on how their maps works.
Parameters
- mapPixelWidth: number
  Width of your map in pixels
- eastLon: number
  East Longitude of your map
- westLon: number
  West Longitude of your map
- dpi: number = -1
  Dots Per Inch of your device. If not included, will use default renderer value.
Returns number
Map scale value to use in the RenderSymbol function armyc2.c5isr.web.render.WebRenderer#RenderSymbol(String, String, String, String, String, String, double, String, Map, Map, int)
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:615

`Static`colorToHexString

colorToHexString(color, withAlpha): string
Parameters
- color: Color
- withAlpha: boolean
Returns string
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:110

`Static`findInstIndIndex

findInstIndIndex(svg): number
Parameters
- svg: string
Returns number
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:544

`Static`findWidestStrokeWidth

findWidestStrokeWidth(svg): number
Parameters
- svg: string
Returns number
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:529

`Static`getColorFromHexString

getColorFromHexString(hexValue): Color
Parameters
- hexValue: string
  String representing hex value (formatted "0xRRGGBB" i.e. "0xFFFFFF") OR formatted "0xAARRGGBB" i.e. "0x00FFFFFF" for a color with an alpha value I will also put up with "RRGGBB" and "AARRGGBB" without the starting "0x" or "#"
Returns Color
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:205

`Static`getData

getData(path): Promise<any>
Parameters
- path: string
Returns Promise<any>
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:683

`Static`getDistanceBetweenPoints

getDistanceBetweenPoints(pt1, pt2): number
Parameters
- pt1: Point2D
- pt2: Point2D
Returns number
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:600

`Static`getIdealOutlineColor

getIdealOutlineColor(color): Color
Parameters
- color: Color
  {String} color like "#FFFFFF"
Returns Color
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:35

`Static`getRecommendedTextOutlineWidth

getRecommendedTextOutlineWidth(): number
Returns number
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:268

`Static`imgToBase64String

imgToBase64String(img): Promise<string>
Parameters
- img: any
Returns Promise<string>
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:18

`Static`increaseStrokeWidth

increaseStrokeWidth(svgString, increaseBy): string
Searches an SVG string and increments all stroke-width values by the increaseBy value.
Parameters
- svgString: string
  The input SVG content as a string.
- increaseBy: number
  the number to add to the current stroke value
Returns string
A new SVG string with updated stroke-width values.
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:577

`Static`measureText

measureText(fontName, fontSize, fontStyle, text, context): Rectangle2D
Clients should use getTextBounds
Parameters
- fontName: string
  like "Arial" or "Arial, sans-serif" so a backup is available in case 'Arial' is not present.
- fontSize: number
  like 12
- fontStyle: string
  like "bold"
- text: string
  include if you want a width value.
- context: any
Returns Rectangle2D
{width:Number,height:Number,descent:Number,fullHeight:Number}
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:128
measureText(font, text, context): Rectangle2D
Parameters
- font: string
- text: string
- context: any
Returns Rectangle2D
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:129
measureText(text, context): Rectangle2D
Parameters
- text: string
- context: any
Returns Rectangle2D
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:130

`Static`scaleIcon

scaleIcon(symbolID, icon): SVGInfo
Parameters
- symbolID: string
- icon: SVGInfo
Returns SVGInfo
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:645

`Static`setAffiliationDashArray

setAffiliationDashArray(symbolID, siIcon): SVGInfo
Sets SVG stroke-dasharray when action points are in planned status
Parameters
- symbolID: string
- siIcon: SVGInfo
Returns SVGInfo
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:504

`Static`setColorAlpha

setColorAlpha(color, alpha): Color
Create a copy of the {@Color } object with the passed alpha value.
Parameters
- color: Color
  {@Color } object used for RGB values
- alpha: number
  {@float } value between 0 and 1
Returns Color
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:73

`Static`setSVGFrameColors

setSVGFrameColors(symbolID, svg, strokeColor, fillColor): string
For Renderer Use Only Assumes a fresh SVG String from the SVGLookup with its default values
Parameters
- symbolID: string
- svg: string
- strokeColor: Color
  hex value like "#FF0000";
- fillColor: Color
  hex value like "#FF0000";
Returns string
SVG String
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:283

`Static`setSVGSPCMColors

setSVGSPCMColors(symbolID, svg, strokeColor, fillColor, isOutline?): string
For Renderer Use Only Changes colors for single point control measures
Parameters
- symbolID: string
- svg: string
- strokeColor: Color
  hex value like "#FF0000";
- fillColor: Color
  hex value like "#FF0000";
- isOutline: boolean = false
  default false; true if this represents a thicker outline to render first beneath the normal symbol (the function must be called twice)
Returns string
SVG String
- Defined in src/main/ts/armyc2/c5isr/renderer/utilities/RendererUtilities.ts:414

Class RendererUtilities

Index

Constructors

Methods

Constructors

constructor

Returns RendererUtilities

Methods

StaticcalculateMapScale

Parameters

Returns number

StaticcolorToHexString

Parameters

Returns string

StaticfindInstIndIndex

Parameters

Returns number

StaticfindWidestStrokeWidth

Parameters

Returns number

StaticgetColorFromHexString

Parameters

Returns Color

StaticgetData

Parameters

Returns Promise<any>

StaticgetDistanceBetweenPoints

Parameters

Returns number

StaticgetIdealOutlineColor

Parameters

Returns Color

StaticgetRecommendedTextOutlineWidth

Returns number

StaticimgToBase64String

Parameters

Returns Promise<string>

StaticincreaseStrokeWidth

Parameters

Returns string

StaticmeasureText

Parameters

Returns Rectangle2D

Parameters

Returns Rectangle2D

Parameters

Returns Rectangle2D

StaticscaleIcon

Parameters

Returns SVGInfo

StaticsetAffiliationDashArray

Parameters

Returns SVGInfo

StaticsetColorAlpha

Parameters

Returns Color

StaticsetSVGFrameColors

Parameters

Returns string

StaticsetSVGSPCMColors

Parameters

Returns string

Settings

On This Page

`Static`calculateMapScale

`Static`colorToHexString

`Static`findInstIndIndex

`Static`findWidestStrokeWidth

`Static`getColorFromHexString

`Static`getData

`Static`getDistanceBetweenPoints

`Static`getIdealOutlineColor

`Static`getRecommendedTextOutlineWidth

`Static`imgToBase64String

`Static`increaseStrokeWidth

`Static`measureText

`Static`scaleIcon

`Static`setAffiliationDashArray

`Static`setColorAlpha

`Static`setSVGFrameColors

`Static`setSVGSPCMColors