Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Network

Hierarchy

Index

Properties

dataElement

dataElement: any

The full network definition, accessible only when the network is loaded.

Read more...

Readonly datasetName

datasetName: string

The physical dataset name of the network as defined in the backend database.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly featureServiceUrl

featureServiceUrl: string

Returns the root feature service url which this network is part of.

Read more...

fullExtent

fullExtent: Extent

The full extent of the network, defined from the service territory used to create the network.

Read more...

id

id: string

Random unique id (UUID) to identify a network as defined in the webmap spec.

Read more...

initialized

initialized: boolean

Readonly layerId

layerId: number

The layer id of the network.

Read more...

layerUrl

layerUrl: string

The full url to the network layer id as defined in the webmap spec.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the network instance has loaded.

Read more...

Readonly networkServiceUrl

networkServiceUrl: string

Returns the url of network server.

Read more...

Readonly owner

owner: string

The portal user owner of the network.

Read more...

Readonly parsedUrl

parsedUrl: string

Converts url to a url object

Read more...

Readonly schemaGeneration

schemaGeneration: number

The schema version of the network.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the network, defined at the creation of the network, usually from the service territory class.

Read more...

title

title: string

The name of the network as defined in the webmap spec.

Read more...

Readonly type

type: "utility" | "trace"

The type of the dataset.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Network
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Network

cancelLoad

  • cancelLoad(): void
  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getLayerIdBySourceId

  • getLayerIdBySourceId(id: number): number
  • The network consists of sources (classes) and each source has a unique Id.

    Read more...

    Parameters

    • id: number

    Returns number

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

load

  • load(): Promise<any>
  • Triggers the loading of the network instance.

    Read more...

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Network

  • Parameters

    Returns Network

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc