Action
    Preparing search index...

    Class MarkerLayerVisualization

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

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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

    • 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 ActiveGeocodingTableReference(): null | DataTable

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

      Returns null | DataTable

      2.0

    • get AdjustMarkerSizeToZoomLevel(): boolean

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

      Returns boolean

      2.0

    • set AdjustMarkerSizeToZoomLevel(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DefaultFontMetadata(): FontMetadata

      Gets or sets the default font for the plot.

      Returns FontMetadata

      2.0

    • set DefaultFontMetadata(value: FontMetadata): void

      Parameters

      Returns void

    • get Description(): string

      Gets or sets the plot description.

      Returns string

      2.0

    • set Description(value: string): void

      Parameters

      • value: string

      Returns void

    • get HorizontalLegend(): HorizontalLegend

      Gets the horizontal legend object for this plot.

      Returns HorizontalLegend

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LabelImageSize(): number

      Gets or sets the size of labels showing images.

      Returns number

      The labels size is expressed as a percentage of the size of the panel in the range of minimum 15 pixels and maximum the least of the width or height. I.e. a value of 0 will allow images as large as 15 x 15 pixels, and a value of 100 will allow images as large as the least of the width or the height of the panel.

      2.0

    • set LabelImageSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get MarkerSize(): number

      Gets or sets the size of the markers.

      Returns number

      The size is expressed in percent of the height or width of the plot. A value of 100 means that a marker will occupy the full height or width of the plot (whichever is smallest).

      2.0

    • set MarkerSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get MaxNumberOfLabels(): number

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

      Returns number

      2.0

    • set MaxNumberOfLabels(value: number): void

      Parameters

      • value: number

      Returns void

    • get PieMarker(): PieMarker

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

      Returns PieMarker

      2.0

    • get ShapeAxis(): ShapeAxis

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

      Returns ShapeAxis

      2.0

    • get ShowDescription(): boolean

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

      Returns boolean

      2.0

    • set ShowDescription(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowEmptyLabels(): boolean

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

      Returns boolean

      2.0

    • set ShowEmptyLabels(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SupportsTransparency(): boolean

      Gets a value indicating whether transparency is supported.

      Returns boolean

      2.0

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

      Returns number

      2.0

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get Trellis(): Trellis

      Gets the trellis.

      Returns Trellis

      2.0

    • 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

      2.0

    • set TrellisingFollowsMainLayer(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get TypeId(): TypeIdentifier

      Gets the type identifier for the visual.

      Returns TypeIdentifier

      2.0

    • get UseSeparateColorForMarkedItems(): boolean

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

      Returns boolean

      2.0

    • set UseSeparateColorForMarkedItems(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Visual(): null | Visual

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

      Returns null | Visual

      2.0

    • get XJitter(): number

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

      Returns number

      2.0

    • set XJitter(value: number): void

      Parameters

      • value: number

      Returns void

    • get YJitter(): number

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

      Returns number

      2.0

    • set YJitter(value: number): void

      Parameters

      • value: number

      Returns void

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

      Returns void

      This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
      Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

      2.0

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

      This will attempt to configure geocoding with reasonable defaults. The behavior may change in future releases.

      2.0

    • Determines whether the current plot configuration is valid.

      Returns boolean

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

      2.0

    • 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

      This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability