Class

SpotfireMarkerLayer

SpotfireMarkerLayer(layerDescription)

Represents a marker layer.

Constructor

new SpotfireMarkerLayer(layerDescription)

Parameters:
Name Type Description
layerDescription Object
[ appearance ] Object
xJittering Number

Specifies the amount of jittering to use in the X direction. Valid values are in the range [0.0, 0.5].

yJittering Number

Specifies the amount of jittering to use in the Y direction. Valid values are in the range [0.0, 0.5].

[ positioning ] Object
method SpotfirePositioningMethods

Specifies if markers should be positioned by matching columns to a geocoding hierarchy or by specifying columns containing X and Y coordinates in the data table.

longitudeLatitude String

Positioning using longitude/latitude values.

identifier String

Positioning using identifiers (geocoding).

xAxis SpotfireScaleAxis
yAxis SpotfireScaleAxis
[ size ] Object
markerSize Number

Specifies the marker size within the visualization area.

sizeBy String

Sizes the markers according to the values in the specified column.

scaleRange Object

Determines what scale to use for the size of the markers.

min Number

Minimum limit that should be mapped to the marker size. Leave null to set it to "Automatic".

max Number

Maximum limit that should be mapped to the marker size. Leave null to set it to "Automatic".

[ shape ] Object
markerShape SpotfireMarkerClasses

Specifies the markers appearance.

simple String

Simple shapes are used as markers.

chart String

Separate charts are used as markers.

tile String

Tiled rectangles are used as markers.

sectorSizeBy Array.<String>

[Available if markerShape is "Pies".] Specifies a column or hierarchy whose categories will determine the size of the pie sectors. This is always an aggregated measure.

labels Object

[Available if markerShape is "Pies".]

showSectorPercentage Boolean

Specifies whether ot not to display labels showing the percentage of the total that each sector represents.

showSectorValue Boolean

Specifies whether or not to display the value of the sector. For example, sum of sales for apples, if the sector size is defined by sum of sales and the color is defined by fruit or vegetable type.

showSectorCategory Boolean

Specifies whether or not to display the category defining the sector. For example, "apples", if the sector color is defined by fruit or vegetable type.

labelPosition SpotfireLabelPositions

Specifies whether the labels should be placed 'Inside pie' or 'Outside pie'.

inside String

The label is placed inside the marker.

outside String

The label is placed outside the marker.

sectorPercentageThreshold Number

Excludes the labels for the sectors whose percentage falls below the specified threshold value.

sectorPercentageDecimals Number

Specifies the number of decimals to display for the percentage value. The number specified here will also affect the number of decimals shown for pie sectors in the tooltip.

sortSectorsBySize Boolean

Sorts the pie sectors by size.

[ labels ] Object
maxNumberOfLabels Number

Specifies the maximum number of labels to be shown. If the number is smaller than the available number of markers, the labels will be equally distributed.

centerLabelsOnItems Boolean

Places the label right on top of the marker instead of drawing a line from the marker to the label, which is the default behavior. This can be a way to use your own images as markers.

showEmptyLabels Boolean

Determines whether or not to show the labels that have no content.

showAs Object

These settings are used when you choose to display anything other than plain text in your labels. For example, the labels could contain web links or images.

type SpotfireRendererTypes

Allows you to decide how the data in the selected column should be interpreted. For example, use 'Text' for plain text labels. Use 'Image' if there are binary images in your data that you want to use as labels. Use 'Link' if the text should be interpreted as a web link. Use 'Image from URL' if the image is picked from a web resource location.

url String

The URL syntax so that it fits your current data.

size Number

Size of labels showing images (available if the selected label output is some kind of image). Between 0 and 100: 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.

[ markerBy ] SpotfireGroupByAxis