Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestHelper

Helper class for dealing with REST data around layrs and layer definitions.

Hierarchy

  • RestHelper

Index

Properties

Methods

Properties

Static tokenDurationMinutes

tokenDurationMinutes: number

Methods

Static Private _convertSpatialRelationshipFromDotnetIndex

  • _convertSpatialRelationshipFromDotnetIndex(rel: number): string

  • Parameters

    • rel: number

    Returns string

Static Private _convertSpatialRelationshipToDotnet

  • _convertSpatialRelationshipToDotnet(rel: string): string

  • Parameters

    • rel: string

    Returns string

Static Private _createRestParametersFromQuery

  • _createRestParametersFromQuery(query: any): any

  • Parameters

    • query: any

    Returns any

Static getDynamicExpressionFromJson

  • getDynamicExpressionFromJson(json: string): string

  • Create a string from a dynamic definition in JSON format.

    Parameters

    • json: string

      A JSON string containing the dynamic definition.

    Returns string

    The definition expression (where clause).

Static getDynamicLayerInfoFromJson

  • getDynamicLayerInfoFromJson(json: string, id: string): DynamicLayerInfo

  • Create a DynamicLayerInfo from a dynamic definition in JSON format.

    Parameters

    • json: string

      A JSON string containing the dynamic definition.

    • id: string

      The ID to use if not specified in the dynamic definition.

    Returns DynamicLayerInfo

    The DynamicLayerInfo created.

Static getJsonObjectFromJsonString

  • getJsonObjectFromJsonString(json: string): any

  • Converts a JSON string into a JSON object.

    Parameters

    • json: string

      A JSON string containing the Dynamic Definition.

    Returns any

    The JSON object created.

Static getLayerDrawingOptionsFromJson

  • getLayerDrawingOptionsFromJson(json: string): LayerDrawingOptions

  • Create a LayerDrawingOptions object from a dynamic definition in JSON format.

    Parameters

    • json: string

      A JSON string containing the dynamic definition.

    Returns LayerDrawingOptions

Static getLayerSourceFromJsonObject

  • getLayerSourceFromJsonObject(sourceJson: any): any

  • Creates a layer source from a JSON object.

    Parameters

    • sourceJson: any

    Returns any

    Either an {esri.layers.LayerMapSource} or {esri.layers.LayerDataSource}.

Static processClientSideTokens

  • processClientSideTokens(site: Site, input: string): string

  • Replaces client side tokens in the supplied input string with their correct values. Client side tokens replaced are:

    • SiteRestUrl
    • VirtualDirectoryUrl
    • RestVirtualDirectoryUrl
    • HostUri
    • RestToken

    Parameters

    • site: Site

      the current Site for which tokens are to be replaced.

    • input: string

      The input string with tokens.

    Returns string

Static validateDynamicDefinition

  • validateDynamicDefinition(json: string): void

  • Validates a Dynamic Layer Definition, ensuring all relevant required fields are supplied.

    Parameters

    • json: string

      A JSON string containing the Dynamic Layer Definition.

    Returns void