Action
    Preparing search index...

    Class WmsLayer

    Web map service (WMS) layer.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    CacheImages Context Enabled Extent IncludeInAutoZoom IncludeInResetViewExtent IsAttached Legend LegendStyleImagesItem LegendTitleItem Projection ServiceBaseUri ShowWarnings Sublayers SupportsTransparency TiledRendering Title Transactions Transparency UseCredentials VisibleZoomLevelRange AutoConfigure ForEachNodeInSubTree

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get CacheImages(): boolean

      Gets or sets a value indicating whether images should be cached in the browser cache.

      Returns boolean

      2.0

    • set CacheImages(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Enabled(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.Maps.MapChartLayer is enabled.

      Returns boolean

      2.0

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IncludeInAutoZoom(): boolean

      Gets or sets a value indicating whether this layer's extent should be taken into account when auto-zooming.

      Returns boolean

      2.0

    • set IncludeInAutoZoom(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IncludeInResetViewExtent(): boolean

      Gets or sets a value indicating whether this layer's extent should be taken into account when resetting view extent.

      Returns boolean

      Tile and Wms layers are always false. Setting the property on these layers is always ignored.

      2.0

    • set IncludeInResetViewExtent(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get ServiceBaseUri(): null | Uri

      Gets or sets the base URI of the WMS.

      Returns null | Uri

      2.0

    • get ShowWarnings(): boolean

      Gets or sets a value indicating whether warnings for projection mismatch and missing tiles should be shown.

      Returns boolean

      2.0

    • set ShowWarnings(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SupportsTransparency(): boolean

      Gets a value indicating whether the layer supports transparency or not.

      Returns boolean

      2.0

    • get TiledRendering(): boolean

      Gets or sets a value indicating whether a tiled schema should be used when rendering.

      Returns boolean

      2.0

    • set TiledRendering(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Title(): string

      Gets or sets the title for this layer.

      Returns string

      2.0

    • set Title(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • get Transparency(): number

      Gets or sets the transparency.

      Returns number

      2.0

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get UseCredentials(): boolean

      Gets or sets a value indicating whether credentials are used for WMS layer. When false it might be because the authentication method currently used is OAuth.

      Returns boolean

      2.0

    • set UseCredentials(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability