Class FileUtils

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

Export

Hierarchy

Constructors

constructor

Properties

$iApi

Accessors

$element $vApp

Methods

csvToGeoJson extractCsvFields extractGeoJsonFields fetchFileData filterCsvLatLonFields geoJsonToEsriJson inferType shapefileToGeoJson

Constructors

constructor

Properties

Readonly $iApi

$iApi: InstanceAPI

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

Memberof

APIScope

Accessors

$element

  • get $element(): App<Element>

  • Returns App<Element>

$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

Methods

csvToGeoJson

extractCsvFields

  • Extracts fields from csv file does no guesswork on property types and calls everything a string.

    Parameters

    • csvData: string
    • delimiter: string = ','

    Returns {
        name: string;
        type: FieldType;
    }[]

extractGeoJsonFields

  • Extracts fields from the first feature in the feature collection

    Parameters

    • geoJson: any

    Returns {
        name: string;
        type: string;
    }[]

fetchFileData

  • Fetch file data from remote URL.

    Parameters

    • url: string

      the URL to get the data from

    • fileType: LayerType

      the type of the file layer (csv, shape, or geoJson)

    Returns Promise<any>

filterCsvLatLonFields

  • Returns all the fields from csv file that can be possible lat/long fields

    Parameters

    • csvData: any

      the csv file data

    • delimiter: string = ','

      the delimiter in the data

    Returns {
        lat: any;
        lon: any;
    }

    • lat: any
    • lon: any

geoJsonToEsriJson

  • Convert GeoJSON to Esri json, a format that can be read by a feature layer constructor

    Parameters

    • geoJson: any

      {Object} a GeoJSON object

    • options: GeoJsonOptions

      {GeoJsonOptions} any options for the transformation

    Returns Promise<FeatureLayerProperties>

    feature layer constructor object

inferType

shapefileToGeoJson

  • Converts Shapefile data to geojson.

    Parameters

    • shapeData: ArrayBuffer

      an ArrayBuffer of the Shapefile in zip format

    Returns Promise<any>

    a promise resolving with geojson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc