Class MarkerLayerVisualization

The visualization for map chart marker layers (see Spotfire.Dxp.Application.Visuals.Maps.MapChartDataLayer).

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ActiveGeocodingTableReference AdjustMarkerSizeToZoomLevel ColorAxis Context Data DefaultFontMetadata Description Details DrawingOrderAxis GeocodingTableReferences HorizontalLegend IsAttached LabelColumn LabelFontMetadata LabelImageSize LabelLayout LabelRenderer LabelVisibility Legend LegendItem LineConnection MarkerByAxis MarkerClass MarkerSize MaxNumberOfLabels PieMarker PositioningMethod RotationAxis ShapeAxis ShowDescription ShowEmptyLabels SizeAxis SupportsTransparency Title Transactions Transparency Trellis TrellisingFollowsMainLayer TypeId UseSeparateColorForMarkedItems Visual XAxis XJitter YAxis YJitter ApplyUserPreferences AutoConfigure AutoConfigureGeocoding IsConfigurationValid RefreshOnDemandData SetLabelRenderer TryGetFilterRules

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

ActiveGeocodingTableReference

  • get ActiveGeocodingTableReference(): null | DataTable

  • Gets the active data table used for the current geocoding configuration. May return null.

    Returns null | DataTable

    Since

    2.0

AdjustMarkerSizeToZoomLevel

  • get AdjustMarkerSizeToZoomLevel(): boolean

  • Gets or sets a value indicating whether marker size should be adjusted to current zoom level.

    Returns boolean

    Since

    2.0

  • set AdjustMarkerSizeToZoomLevel(value): void

  • Parameters

    • value: boolean

    Returns void

ColorAxis

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Data

DefaultFontMetadata

  • get DefaultFontMetadata(): FontMetadata

  • Gets or sets the default font for the plot.

    Returns FontMetadata

    Since

    2.0

  • set DefaultFontMetadata(value): void

  • Parameters

    Returns void

Description

  • get Description(): string

  • Gets or sets the plot description.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

Details

DrawingOrderAxis

GeocodingTableReferences

HorizontalLegend

  • get HorizontalLegend(): HorizontalLegend

  • Gets the horizontal legend object for this plot.

    Returns HorizontalLegend

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

LabelColumn

LabelFontMetadata

  • get LabelFontMetadata(): FontMetadata

  • Gets or sets the font metadata used for the labels.

    Returns FontMetadata

    Since

    2.0

  • set LabelFontMetadata(value): void

  • Parameters

    Returns void

LabelImageSize

  • get LabelImageSize(): number

  • Gets or sets the size of labels showing images.

    Returns number

    Since

    2.0

  • set LabelImageSize(value): void

  • Parameters

    • value: number

    Returns void

LabelLayout

LabelRenderer

LabelVisibility

Legend

  • get Legend(): Legend

  • Gets the legend object for this plot.

    Returns Legend

    Since

    2.0

LegendItem

LineConnection

MarkerByAxis

MarkerClass

  • get MarkerClass(): MarkerClass

  • Gets or sets the class type of the markers in this marker layer visualization. Using this property the markers can be switched between simple markers, tiled markers and separate charts (for example pies).

    Returns MarkerClass

    Since

    2.0

  • set MarkerClass(value): void

  • Parameters

    Returns void

MarkerSize

  • get MarkerSize(): number

  • Gets or sets the size of the markers.

    Returns number

    Since

    2.0

  • set MarkerSize(value): void

  • Parameters

    • value: number

    Returns void

MaxNumberOfLabels

  • get MaxNumberOfLabels(): number

  • Gets or sets a value indicating max number of drawn labels.

    Returns number

    Since

    2.0

  • set MaxNumberOfLabels(value): void

  • Parameters

    • value: number

    Returns void

PieMarker

  • get PieMarker(): PieMarker

  • Gets the pie marker settings to use when this plot is configured to show pies.

    Returns PieMarker

    Since

    2.0

PositioningMethod

RotationAxis

ShapeAxis

  • get ShapeAxis(): ShapeAxis

  • Gets the axis that can be used to alter the expression by which marker shapes are chosen.

    Returns ShapeAxis

    Since

    2.0

ShowDescription

  • get ShowDescription(): boolean

  • Gets or sets a flag indicating whether to show the description or not.

    Returns boolean

    Since

    2.0

  • set ShowDescription(value): void

  • Parameters

    • value: boolean

    Returns void

ShowEmptyLabels

  • get ShowEmptyLabels(): boolean

  • Gets or sets a value indicating whether a label with empty content should be shown or not.

    Returns boolean

    Since

    2.0

  • set ShowEmptyLabels(value): void

  • Parameters

    • value: boolean

    Returns void

SizeAxis

SupportsTransparency

  • get SupportsTransparency(): boolean

  • Gets a value indicating whether transparency is supported.

    Returns boolean

    Since

    2.0

Title

  • get Title(): string

  • Gets or sets the Visual's title.

    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 for the plot.

    Returns number

    Since

    2.0

  • set Transparency(value): void

  • Parameters

    • value: number

    Returns void

Trellis

  • get Trellis(): Trellis

  • Gets the trellis.

    Returns Trellis

    Since

    2.0

TrellisingFollowsMainLayer

  • get TrellisingFollowsMainLayer(): boolean

  • Gets or sets a value indicating whether this visualization should be trellised the same way as the main trellis layer in the map chart, see Spotfire.Dxp.Application.Visuals.Maps.MapChart.TrellisLayerReference. The default value is false.

    Returns boolean

    Since

    2.0

  • set TrellisingFollowsMainLayer(value): void

  • Parameters

    • value: boolean

    Returns void

TypeId

  • get TypeId(): TypeIdentifier

  • Gets the type identifier for the visual.

    Returns TypeIdentifier

    Since

    2.0

UseSeparateColorForMarkedItems

  • get UseSeparateColorForMarkedItems(): boolean

  • Gets or sets a value indicating whether to use a separate color for marked items.

    Returns boolean

    Since

    2.0

  • set UseSeparateColorForMarkedItems(value): void

  • Parameters

    • value: boolean

    Returns void

Visual

  • get Visual(): null | Visual

  • Gets the visual instance, or null if this instance is not owned by a visual.

    Returns null | Visual

    Since

    2.0

XAxis

XJitter

  • get XJitter(): number

  • Gets or sets the amount of jittering in the x-direction.

    Returns number

    Since

    2.0

  • set XJitter(value): void

  • Parameters

    • value: number

    Returns void

YAxis

YJitter

  • get YJitter(): number

  • Gets or sets the amount of jittering in the y-direction.

    Returns number

    Since

    2.0

  • set YJitter(value): void

  • Parameters

    • value: number

    Returns void

ApplyUserPreferences

AutoConfigure

  • AutoConfigure(): void

  • Configures a newly created visual with reasonable default values given the current data set.

    Returns void

    Since

    2.0

AutoConfigureGeocoding

  • AutoConfigureGeocoding(forceAutoload, allowChangeAxisExpression, applyColumnClassification): boolean

  • Automatically configures geocoding for this layer by (optionally) attempting to apply column classification, (optionally) changing the geocoding axis expression, and then applying automatic geocoding hierarchies.

    Parameters

    • forceAutoload: boolean | Boolean

      Force automatic loading of geocoding tables from the library.

    • allowChangeAxisExpression: boolean | Boolean

      truec> if the geocoding axis expression is allowed to be changed by automatic geocoding.

    • applyColumnClassification: boolean | Boolean

      If set to true, automatic column classification is applied.

    Returns boolean

    true if geocoding was applied to the layer, false otherwise.

    Since

    2.0

IsConfigurationValid

  • IsConfigurationValid(): boolean

  • Determines whether the current plot configuration is valid.

    Returns boolean

    true if the current plot configuration is valid; otherwise, false.

    Since

    2.0

RefreshOnDemandData

  • RefreshOnDemandData(): void

  • Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included.

    Returns void

    Since

    2.0

SetLabelRenderer

TryGetFilterRules

  • TryGetFilterRules(filterRules): boolean

  • Try to get the filter rules for the plot.

    Parameters

    Returns boolean

    false if this visualization does not support filter, rules, otherwise true.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability