Class LayerSource

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

Hierarchy

APIScope
- LayerSource

Index

Constructors

constructor

new LayerSource($iApi): LayerSource
Parameters
- $iApi: InstanceAPI
Returns LayerSource
Overrides APIScope.constructor
- Defined in src/fixtures/wizard/store/layer-source.ts:26

Properties

`Readonly` $iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

layerCount

layerCount: number = 0

sublayerCount

sublayerCount: number = 0

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$element
- Defined in src/api/common.ts:31

$vApp

get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:27

Methods

createLayerHierarchy

createLayerHierarchy(layers, nested): SublayerInfo[]
Parameters
- layers: any[]
- nested: boolean
Returns SublayerInfo[]
- Defined in src/fixtures/wizard/store/layer-source.ts:213

fetchFileInfo

fetchFileInfo(url, fileType, fileData?): Promise<undefined | LayerInfo>
Get layer info from a file url or data
Parameters
- url: string
  
  a service url to load, name of file if file data is provided
- fileType: LayerType
  
  format of the file (layer type)
- Optional fileData: ArrayBuffer
  
  raw file data buffer
Returns Promise<undefined | LayerInfo>
LayerInfo object
- Defined in src/fixtures/wizard/store/layer-source.ts:38

fetchServiceInfo

fetchServiceInfo(url, serviceType, nested): Promise<undefined | LayerInfo>
Get layer info from a service url
Parameters
- url: string
  
  a service url to load
- serviceType: string
  
  type of layer
- nested: boolean
Returns Promise<undefined | LayerInfo>
LayerInfo object
- Defined in src/fixtures/wizard/store/layer-source.ts:147

getCsvInfo

getCsvInfo(url, fileData): Promise<LayerInfo>
Parameters
- url: string
- fileData: string | ArrayBuffer
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:93

getFeatureInfo

getFeatureInfo(url): Promise<LayerInfo>
Parameters
- url: string
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:168

getGeojsonInfo

getGeojsonInfo(url, fileData): Promise<LayerInfo>
Parameters
- url: string
- fileData: object | ArrayBuffer
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:65

getImageryInfo

getImageryInfo(url): Promise<LayerInfo>
Parameters
- url: string
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:292

getMapImageInfo

getMapImageInfo(url, nested): Promise<LayerInfo>
Gets MIL data from source, formats it as a tree, and returns a promise of the data with configuration
Parameters
- url: string
- nested: boolean
Returns Promise<LayerInfo>
data configuration
- Defined in src/fixtures/wizard/store/layer-source.ts:194

getShapfileInfo

getShapfileInfo(url, fileData): Promise<LayerInfo>
Parameters
- url: string
- fileData: ArrayBuffer
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:129

getTileInfo

getTileInfo(url): Promise<LayerInfo>
Parameters
- url: string
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:275

getWfsInfo

getWfsInfo(url): Promise<LayerInfo>
Parameters
- url: string
Returns Promise<LayerInfo>
- Defined in src/fixtures/wizard/store/layer-source.ts:309

getWmsInfo

getWmsInfo(url, nested): Promise<LayerInfo>
Gets WMS data from source, formats it, and returns a promise of the data with configuration
Parameters
- url: string
- nested: boolean
Returns Promise<LayerInfo>
data configuration
- Defined in src/fixtures/wizard/store/layer-source.ts:332

guessFormatFromURL

guessFormatFromURL(url): string
Guesses type of file or service given a URL
Parameters
- url: string
Returns string
file or layer type
- Defined in src/fixtures/wizard/store/layer-source.ts:394

mapWmsLayerList

mapWmsLayerList(layers, nested): any
Parameters
- layers: any
- nested: boolean
Returns any
- Defined in src/fixtures/wizard/store/layer-source.ts:354

Class LayerSource

Export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

$iApi: InstanceAPI

Returns LayerSource

Properties

Readonly $iApi

Memberof

layerCount

sublayerCount

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

Memberof

Methods

createLayerHierarchy

Parameters

layers: any[]

nested: boolean

Returns SublayerInfo[]

fetchFileInfo

Parameters

url: string

fileType: LayerType

Optional fileData: ArrayBuffer

Returns Promise<undefined | LayerInfo>

fetchServiceInfo

Parameters

url: string

serviceType: string

nested: boolean

Returns Promise<undefined | LayerInfo>

getCsvInfo

Parameters

url: string

fileData: string | ArrayBuffer

Returns Promise<LayerInfo>

getFeatureInfo

Parameters

url: string

Returns Promise<LayerInfo>

getGeojsonInfo

Parameters

url: string

fileData: object | ArrayBuffer

Returns Promise<LayerInfo>

getImageryInfo

Parameters

url: string

Returns Promise<LayerInfo>

getMapImageInfo

Parameters

url: string

nested: boolean

Returns Promise<LayerInfo>

getShapfileInfo

Parameters

url: string

fileData: ArrayBuffer

Returns Promise<LayerInfo>

getTileInfo

Parameters

url: string

Returns Promise<LayerInfo>

getWfsInfo

Parameters

url: string

Returns Promise<LayerInfo>

getWmsInfo

Parameters

`Readonly` $iApi

`Optional` fileData: ArrayBuffer