Class SharedUtilsAPI

Index

Constructors

Methods

controlAvailable convertImageToCanvas convertImagetoDataURL generateUUID parseUrlIndex

Constructors

constructor

new SharedUtilsAPI(): SharedUtilsAPI
Returns SharedUtilsAPI

Methods

controlAvailable

controlAvailable(
control: LayerControl,
config: { controls?: string[]; disabledControls?: string[] } | undefined,
): boolean
Determines whether the provided control is enabled for the bound layer, based on the config provided
Parameters
- control: LayerControl
  the control we want to determine the availability of
- config: { controls?: string[]; disabledControls?: string[] } | undefined
  an object containing information regarding enabled/disabled controls for the bound layer
Returns boolean
whether the control is available
- Defined in src/geo/api/utils/shared-utils.ts:125

convertImageToCanvas

convertImageToCanvas(
    url: string,
    canvas?: HTMLCanvasElement,
    crossOrigin?: boolean,
): Promise<any>
Convert an image to a canvas element
Parameters
- url: string
  image url to convert (result from the esri print task)
- Optionalcanvas: HTMLCanvasElement
  [optional = undefined] canvas to draw the image upon; if not supplied, a new canvas will be made
- crossOrigin: boolean = true
  [optional = true] when set, tries to fetch an image with crossOrigin = anonymous
Returns Promise<any>
conversion promise resolving into a canvas of the image
- Defined in src/geo/api/utils/shared-utils.ts:33

convertImagetoDataURL

convertImagetoDataURL(imageUri: string, imageType?: string): Promise<string>
Function
Loads an image (as crossing) and converts it to dataURL. If a supplied imageUri is already a dataURL, just return it. If an image fails to load with the crossing attribute, return the original imageUri

convertImagetoDataURL
Parameters
- imageUri: string
  url of the image to load and convert
- imageType: string = 'image/png'
  [optional = 'image/png'] format of the image representation
Returns Promise<string>
promise resolving with the dataURL of the image
- Defined in src/geo/api/utils/shared-utils.ts:69

generateUUID

generateUUID(): string
Get a 'good enough' uuid. For backup purposes if client does not supply its own unique layer id

Returns string
a uuid

Method
generateUUID
- Defined in src/geo/api/utils/shared-utils.ts:12

parseUrlIndex

parseUrlIndex(url: string): ArcGisServerUrl
Function
Splits an indexed map server url into an object with .rootUrl and .index properties.

parseUrlIndex
Parameters
- url: string
  an indexed map server url
Returns ArcGisServerUrl
the url split into the server root and the index.
- Defined in src/geo/api/utils/shared-utils.ts:94