Class ImageLayer

An image layer in a Spotfire.Dxp.Application.Visuals.Maps.MapChart.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Enabled Extent IncludeInAutoZoom IncludeInResetViewExtent IsAttached PreserveSharpEdges Projection SupportsTransparency Title Transactions Transparency VisibleZoomLevelRange AutoConfigure SetExtent

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Enabled

  • get Enabled(): boolean

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

    Returns boolean

    Since

    2.0

  • set Enabled(value): void

  • Parameters

    • value: boolean

    Returns void

Extent

IncludeInAutoZoom

  • get IncludeInAutoZoom(): boolean

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

    Returns boolean

    Since

    2.0

  • set IncludeInAutoZoom(value): void

  • Parameters

    • value: boolean

    Returns void

IncludeInResetViewExtent

  • 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

    Since

    2.0

  • set IncludeInResetViewExtent(value): void

  • Parameters

    • value: boolean

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

PreserveSharpEdges

  • get PreserveSharpEdges(): boolean

  • Gets or sets a value indicating whether the sharp edges of this Spotfire.Dxp.Application.Visuals.Maps.ImageLayer should be preserved when it is up-scaled.

    Returns boolean

    Since

    2.0

  • set PreserveSharpEdges(value): void

  • Parameters

    • value: boolean

    Returns void

Projection

SupportsTransparency

  • get SupportsTransparency(): boolean

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

    Returns boolean

    Since

    2.0

Title

  • get Title(): string

  • Gets or sets the title for this layer.

    Returns string

    Since

    2.0

  • set Title(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Transparency

  • get Transparency(): number

  • Gets or sets the transparency.

    Returns number

    Since

    2.0

  • set Transparency(value): void

  • Parameters

    • value: number

    Returns void

VisibleZoomLevelRange

AutoConfigure

SetExtent

  • SetExtent(extent): void

  • Sets the extent.

    Parameters

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability