Constructor
new SpotfireMarkerLayer(layerDescription)
Represents a marker layer.
Parameters:
| Name | Type | Description |
|---|---|---|
[ layerDescription ]
|
Object | |
[ general ]
|
Object | |
name
|
String | The name of the layer. |
visible
|
String | Specifies whether or not the layer is visible. |
[ data ]
|
visualDataDescription ▼ | |
dataTable
|
String | Specifies the data table on which the visualization will work. |
marking
|
String | Specifies the marking that will be used to mark items in the visualization. |
limiting
|
Object | Settings used for limiting the data shown in the visualization. |
byMarkings
|
Object | Settings used for limiting the data shown in the visualization using the markings. |
markingNames
|
String | Array.<String> | Lists the available markings that can be used to limit what is shown in the visualization. This means that the visualization only displays data that has been marked in other visualizations (master visualizations). |
combinationBehavior
|
String | ['AND'|'OR'], specifies how the data in the markings should be combined if you have listed more than one marking. AND: to show the intersection of the selected markings; OR: to show the union of the selected markings. |
emptyBehavior
|
String | ['ALL','EMPTY','MESSAGE'], specifies what the visualization should show when no items have been marked in its master visualizations. ALL: to show all the data from the master visualizations that control the content, if no items have been marked in those visualizations; EMPTY: to display only the scales and axis selectors if no items have been marked in the master visualizations; MESSAGE: to display a message if no items have been marked in the master visualizations. The axis selectors will also be visible. |
emptyMessage
|
String | The message that will be displayed if no items have been marked in the master visualizations. |
byFilterings
|
Object | Defines how different filtering schemes in the analysis should affect the visualization. |
filteringNames
|
String | Array.<String> | Lists the available filtering schemes that can be used to limit what is shown in the visualization. |
useCurrentFilteringFromPage
|
Boolean | Specifies whether or not the visualization should utilize the filtering scheme that is used on the page where the visualization is located. If you move the visualization to a new page, then the visualization will automatically start reacting on the filtering scheme that is used on the new page. |
byExpression
|
String | Specifies the boolean expression to use for limiting the data in the visualization. |
[ appearance ]
|
Object | |
useSeparateColorForMarkedItems
|
Boolean | Specifies whether or not the marking color should be used to distinguish marked items in the visualization. |
transparency
|
Number | Specifies the transparency of the markers, between 0.0 and 1.0. |
includeInAutoZoom
|
Boolean | Specifies whether or not all filtered values in this layer remain visible upon auto-zooming. |
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]. |
[ fonts ]
|
Object | |
labels
|
visualFontDescription ▼ | To change the font settings of the labels. |
fontFamily
|
String | Specifies a specific font to use. |
size
|
Number | Specifies a specific font size to use. |
bold
|
Boolean | Specifies if the font style Bold should be used. |
italic
|
Boolean | Specifies if the font style Italic should be used. |
trellisHeaders
|
visualFontDescription ▼ | To change the font settings of the trellis headers. |
fontFamily
|
String | Specifies a specific font to use. |
size
|
Number | Specifies a specific font size to use. |
bold
|
Boolean | Specifies if the font style Bold should be used. |
italic
|
Boolean | Specifies if the font style Italic should be used. |
[ labels ]
|
Object | |
showLabelsFor
|
SpotfireLabelVisibilities | Determines whether to show labels on all markers ('All'), marked markers only ('Marked rows'), or not to show any labels at all ('None'). |
labelBy
|
SpotfireLabelOrientations {Enum} ▼ | Specifies the column or hierarchy whose values should be presented as labels in the layer. |
| Enum options: horizontal, vertical | ||
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. |
[ colors ]
|
SpotfireColorAxis | |
[ tooltip ]
|
SpotfireTooltip ▼ | |
tooltipItems
|
Array.<TooltipItemDescription> ▼ | |
[].expression
|
string | the expression to be used to create the tooltip item |
[].size
|
number | the size of the tooltip item |
[].renderer
|
RendererDescription | the renderer description to be used |
displayItems
|
Array.<String> | Specifies which tooltip items will be shown by their names (specified by "as [tooltip name]" in the expression field).
|
format
|
SpotfireTooltipFormats {Enum} ▼ | Specifies whether or not the name of the tooltip value should be included along with the value itself. |
| Enum options: valueNamesAndValues, visualizationPropertiesAndValues | ||
[ legend ]
|
Object | |
visible
|
Boolean | Specifies whether or not the legend should be shown in the visualization. |
legendItems
|
Array.<visualLegendItemDescription> ▼ | Defines how the legend items should be displayed. The available options vary between legend items. |
[].name
|
String | The name of the legend item to modify, as it is displayed in the user interface. |
[].visible
|
Boolean | Specifies whether or not the legend item should be shown. |
[].showTitle
|
Boolean | Specifies whether or not the legend item title should be shown. |
[].showAxisSelector
|
Boolean | Specifies whether or not the axis selector for the legend item should be shown. |
[ showHideItemsRules ]
|
Array.<visualShowHideItemsRuleDescription> ▼ | |
[].expression
|
String | Specifies which column the rule should be applied to. |
[].type
|
SpotfireShowHideItemsRulesTypes {Enum} ▼ | Specifies the rule type. Which types are available depends on the data type of the column the rule is applied to. |
| Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, string | ||
[].hideMatchedItems
|
String | Specifies whether or not the items that match the rule should be hidden. |
[].evaluatePerTrellis
|
String | If the visualization is trellised , specifies whether or not the rule should be applied once for each trellis panel. |
[].displayName
|
String | The name of the rule. |
[].enabled
|
Boolean | Specifies whether or not the rule should be active. |
[].ruleCondition
|
Object | |
comparisonOperator
|
String | |
threshold
|
Object | |
type
|
String | |
value
|
Number | |
stringValue
|
Object | |
type
|
String | |
value
|
Number | |
isBottom
|
Boolean | |
rank
|
Object | |
type
|
String | |
value
|
Number | |
startValue
|
Object | |
type
|
String | |
value
|
Number | |
endValue
|
Object | |
type
|
String | |
value
|
Number | |
expression
|
String | |
[ positioning ]
|
Object | |
method
|
SpotfirePositioningMethods {Enum} ▼ | 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. |
| Enum options: longitudeLatitude, identifier | ||
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 {Enum} ▼ | Specifies the markers appearance. |
| Enum options: simple, chart, tile | ||
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 {Enum} ▼ | Specifies whether the labels should be placed 'Inside pie' or 'Outside pie'. |
| Enum options: inside, outside | ||
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. |
[ markerBy ]
|
SpotfireGroupByAxis |