Interface RampLayerConfig

interface RampLayerConfig {
    caching?: boolean;
    catalogueUrl?: string;
    colour?: string;
    controls?: LayerControl[];
    cosmetic?: boolean;
    customRenderer?: any;
    disabledControls?: LayerControl[];
    drawOrder?: DrawOrder[];
    expectedDrawTime?: number;
    expectedLoadTime?: number;
    extent?: RampExtentConfig;
    featureInfoMimeType?: string;
    fieldMetadata?: RampLayerFieldMetadataConfig;
    fixtures?: any;
    geomClustering?: FeatureReductionCluster;
    id: string;
    identifyMode?: LayerIdentifyMode;
    imageFormat?: string;
    initialFilteredQuery?: string;
    labels?: RampLabelsConfig;
    latField?: string;
    layerType: LayerType;
    longField?: string;
    maptipArcade?: string;
    maptipField?: string;
    maxLoadTime?: number;
    metadata?: {
        name?: string;
        treatXmlAsMarkdown?: boolean;
        url: string;
        xmlType?: string;
    };
    mouseTolerance?: number;
    name?: string;
    nameArcade?: string;
    nameField?: string;
    permanentFilteredQuery?: string;
    rawData?: any;
    state?: RampLayerStateConfig;
    sublayers?: RampLayerMapImageSublayerConfig[] | RampLayerWmsSublayerConfig[];
    system?: boolean;
    tooltipArcade?: string;
    tooltipField?: string;
    touchTolerance?: number;
    url: string;
}

Properties

caching? catalogueUrl? colour? controls? cosmetic? customRenderer? disabledControls? drawOrder? expectedDrawTime? expectedLoadTime? extent? featureInfoMimeType? fieldMetadata? fixtures? geomClustering? id identifyMode? imageFormat? initialFilteredQuery? labels? latField? layerType longField? maptipArcade? maptipField? maxLoadTime? metadata? mouseTolerance? name? nameArcade? nameField? permanentFilteredQuery? rawData? state? sublayers? system? tooltipArcade? tooltipField? touchTolerance? url

Properties

Optionalcaching

caching?: boolean

OptionalcatalogueUrl

catalogueUrl?: string

Optionalcolour

colour?: string

Optionalcontrols

controls?: LayerControl[]

Optionalcosmetic

cosmetic?: boolean

OptionalcustomRenderer

customRenderer?: any

OptionaldisabledControls

disabledControls?: LayerControl[]

OptionaldrawOrder

drawOrder?: DrawOrder[]

OptionalexpectedDrawTime

expectedDrawTime?: number

OptionalexpectedLoadTime

expectedLoadTime?: number

Optionalextent

extent?: RampExtentConfig

OptionalfeatureInfoMimeType

featureInfoMimeType?: string

OptionalfieldMetadata

fieldMetadata?: RampLayerFieldMetadataConfig

Optionalfixtures

fixtures?: any

OptionalgeomClustering

geomClustering?: FeatureReductionCluster

id

id: string

OptionalidentifyMode

identifyMode?: LayerIdentifyMode

OptionalimageFormat

imageFormat?: string

OptionalinitialFilteredQuery

initialFilteredQuery?: string

Optionallabels

labels?: RampLabelsConfig

OptionallatField

latField?: string

layerType

layerType: LayerType

OptionallongField

longField?: string

OptionalmaptipArcade

maptipArcade?: string

OptionalmaptipField

maptipField?: string

OptionalmaxLoadTime

maxLoadTime?: number

Optionalmetadata

metadata?: {
    name?: string;
    treatXmlAsMarkdown?: boolean;
    url: string;
    xmlType?: string;
}

OptionalmouseTolerance

mouseTolerance?: number

Optionalname

name?: string

OptionalnameArcade

nameArcade?: string

OptionalnameField

nameField?: string

OptionalpermanentFilteredQuery

permanentFilteredQuery?: string

OptionalrawData

rawData?: any

Optionalstate

state?: RampLayerStateConfig

Optionalsublayers

sublayers?: RampLayerMapImageSublayerConfig[] | RampLayerWmsSublayerConfig[]

Optionalsystem

system?: boolean

OptionaltooltipArcade

tooltipArcade?: string

DEPRECATED #2595 Use maptipArcade

OptionaltooltipField

tooltipField?: string

DEPRECATED #2595 Use maptipField

OptionaltouchTolerance

touchTolerance?: number

url

url: string

Settings

Member Visibility

On This Page

Properties