Interface CSVLayerJson

The CSV layer type references a CSV or TXT file from a publicly-accessible web server. It then dynamically loads into the map at run time. The CSV layer will maintain a reference to the CSV resource.

See https://developers.arcgis.com/web-map-specification/objects/csvLayer/ https://developers.arcgis.com/web-scene-specification/objects/csvLayer/.

interface CSVLayerJson {
    blendMode?:
        | "invert"
        | "normal"
        | "lighter"
        | "multiply"
        | "color"
        | "average"
        | "color-burn"
        | "color-dodge"
        | "darken"
        | "destination-atop"
        | "destination-in"
        | "destination-out"
        | "destination-over"
        | "difference"
        | "exclusion"
        | "hard-light"
        | "hue"
        | "lighten"
        | "luminosity"
        | "minus"
        | "overlay"
        | "plus"
        | "reflect"
        | "saturation"
        | "screen"
        | "soft-light"
        | "source-atop"
        | "source-in"
        | "source-out"
        | "vivid-light"
        | "xor";
    columnDelimiter?: string;
    disablePopup?: boolean;
    effect?: EffectJson;
    id?: string;
    itemId?: string;
    layerDefinition?: LayerDefinitionJson;
    layerType: "CSV";
    listMode?: LayerListMode;
    locationInfo?: LocationInfoJson;
    maxScale?: number;
    minScale?: number;
    opacity?: number;
    popupInfo?: PopupInfoJson;
    refreshInterval?: number;
    screenSizePerspective?: boolean;
    showLabels?: boolean;
    showLegend?: boolean;
    title?: string;
    type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
    url?: string;
    visibility?: boolean;
    visibilityTimeExtent?: [number, number];
}

Hierarchy (view full)

Properties

blendMode? columnDelimiter? disablePopup? effect? id? itemId? layerDefinition? layerType listMode? locationInfo? maxScale? minScale? opacity? popupInfo? refreshInterval? screenSizePerspective? showLabels? showLegend? title? type? url? visibility? visibilityTimeExtent?

Properties

OptionalblendMode

blendMode?:
    | "invert"
    | "normal"
    | "lighter"
    | "multiply"
    | "color"
    | "average"
    | "color-burn"
    | "color-dodge"
    | "darken"
    | "destination-atop"
    | "destination-in"
    | "destination-out"
    | "destination-over"
    | "difference"
    | "exclusion"
    | "hard-light"
    | "hue"
    | "lighten"
    | "luminosity"
    | "minus"
    | "overlay"
    | "plus"
    | "reflect"
    | "saturation"
    | "screen"
    | "soft-light"
    | "source-atop"
    | "source-in"
    | "source-out"
    | "vivid-light"
    | "xor"

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

OptionalcolumnDelimiter

columnDelimiter?: string

A string defining the character used to separate columns in a CSV file. You can set this property using any of the following: ",", " ", ";", "|", "\t". Used with CSV layers only.

OptionaldisablePopup

disablePopup?: boolean

Indicates whether to allow a client to ignore popups defined by the service item.

Optionaleffect

effect?: EffectJson

Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.

Optionalid

id?: string

A unique identifying string for the layer.

OptionalitemId

itemId?: string

Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.

OptionallayerDefinition

layerDefinition?: LayerDefinitionJson

A layerDefinition object defining the attribute schema and drawing information for the layer.

layerType

layerType

The type of layer.

OptionallistMode

listMode?: LayerListMode

Indicates how the layer should display in the table of contents. The known values are listed below. See support/esri!ListMode.

OptionallocationInfo

locationInfo?: LocationInfoJson

A LocationInfo object defining how location information will be retrieved from a CSV file. Used with CSV layers only.

OptionalmaxScale

maxScale?: number

A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.

OptionalminScale

minScale?: number

A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.

Optionalopacity

opacity?: number

The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.

OptionalpopupInfo

popupInfo?: PopupInfoJson

A PopupInfo object defining the content of pop-up windows when you click or query a feature.

OptionalrefreshInterval

refreshInterval?: number

When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm.

OptionalscreenSizePerspective

screenSizePerspective?: boolean

Apply perspective scaling to screen-size symbols.

OptionalshowLabels

showLabels?: boolean

Indicates whether to display labels for this layer. If true, labels will appear as defined in the labelingInfo property.

OptionalshowLegend

showLegend?: boolean

Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.

Optionaltitle

title?: string

A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.

Optionaltype

type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType

(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.

Optionalurl

url?: string

The URL to the CSV file that backs the layer.

Optionalvisibility

visibility?: boolean

Determines whether the layer is initially visible in the web map.

OptionalvisibilityTimeExtent

visibilityTimeExtent?: [number, number]

Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.

Settings

Member Visibility

On This Page

Properties