Documentation

IMapChartProperties

Type interface

Defines properties for MapChart.

Inheritance

IMapChartProperties extends ISerialChartProperties.

IMapChartProperties is extended by IMapChartAdapters.

Properties

align
#

Type Align

Inherited from ISpriteProperties
alwaysShowTooltip
#

Type boolean

Inherited from ISpriteProperties
centerMapOnZoomOut
#

Type boolean

Default true

Specifies if the map should be centered when zooming out

@since 4.7.12

clickable
#

Type boolean

Inherited from ISpriteProperties
colors
#

Type ColorSet

Inherited from ISerialChartProperties

A set of colors to be used for chart elements, like Series, Slices, etc.
contentAlign
#

Type Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.
contextMenuDisabled
#

Type boolean

Inherited from ISpriteProperties
deltaGamma
#

Type number

Degrees to rotate the map around horizontal "Z" - an axis that goes from the center of the globe directly to the viewer.

@since 4.3.0

deltaLatitude
#

Type number

Degrees to rotate the map around horizontal axis (X).

E.g. setting this to -90 will put Antarctica directly in the center of the map.

@since 4.3.0

deltaLongitude
#

Type number

Degrees to rotate the map around vertical axis (Y).

E.g. if set to -160, the longitude 20 will become a new center, creating a Pacific-centered map.
disabled
#

Type boolean

Inherited from ISpriteProperties
draggable
#

Type boolean

Inherited from ISpriteProperties
dx
#

Type number

Inherited from ISpriteProperties
dy
#

Type number

Inherited from ISpriteProperties
fill
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
fillModifier
#

Type ColorModifier

Inherited from ISpriteProperties
fillOpacity
#

Type number

Inherited from ISpriteProperties
fixedWidthGrid
#

Type boolean

Default false

Inherited from IContainerProperties

If set to true, all columns of the container with layout type "grid" will be equally sized.
focusable
#

Type boolean

Inherited from ISpriteProperties
fontFamily
#

Type string

Inherited from IContainerProperties

Font family for the text.
fontSize
#

Type number

Inherited from IContainerProperties

Font size for the text.
fontWeight
#

Type FontWeight

Default "normal"

Inherited from IContainerProperties

Default font weight.
height
#

Type number | Percent

Inherited from ISpriteProperties
hidden
#

Type boolean

Inherited from ISpriteProperties
homeGeoPoint
#

Type IGeoPoint

A map will start centered on this geographical point.
homeZoomLevel
#

Type number

A map will start zoomed to this level.
horizontalCenter
#

Type HorizontalCenter

Inherited from ISpriteProperties
hoverOnFocus
#

Type boolean

Inherited from ISpriteProperties
hoverable
#

Type boolean

Inherited from ISpriteProperties
id
#

Type string

Inherited from ISpriteProperties
inert
#

Type boolean

Inherited from ISpriteProperties
interactionsEnabled
#

Type boolean

Inherited from ISpriteProperties
isActive
#

Type boolean

Inherited from ISpriteProperties
isHover
#

Type boolean

Inherited from ISpriteProperties
layout
#

Type ContainerLayout

Default "absolute"

Inherited from IContainerProperties

Container layout.

Options: "absolute" (default), "vertical", "horizontal", or "grid".
marginBottom
#

Type number

Inherited from ISpriteProperties
marginLeft
#

Type number

Inherited from ISpriteProperties
marginRight
#

Type number

Inherited from ISpriteProperties
marginTop
#

Type number

Inherited from ISpriteProperties
maxColumns
#

Type number

Inherited from IContainerProperties

Maximum number of columns (when using "grid" layout).
maxHeight
#

Type number

Inherited from ISpriteProperties
maxPanOut
#

Type number

Default 0.7

Maximum portion of the map's width/height to allow panning "off screen".

A value of 0 (zero) will prevent any portion of the the map to be panned outside the viewport.

0.5 will allow half of the map to be outside viewable area.
maxWidth
#

Type number

Inherited from ISpriteProperties
maxX
#

Type number

Inherited from ISpriteProperties
maxY
#

Type number

Inherited from ISpriteProperties
maxZoomCount
#

Type number

Default 0 (no limit)

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Limits how many categories or base intervals can be shown at the same time.

If there are more items in the chart, the chart will auto-zoom.
maxZoomFactor
#

Type number

Inherited from IComponentProperties

Maximum zoom factor of a component.
minHeight
#

Type number

Inherited from ISpriteProperties
minWidth
#

Type number

Inherited from ISpriteProperties
minX
#

Type number

Inherited from ISpriteProperties
minY
#

Type number

Inherited from ISpriteProperties
minZoomCount
#

Type number

Default 1

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Allows restricting zoom in beyond certain number of categories or base intervals.

The chart will not zoom in beyond this number of items.
mouseWheelBehavior
#

Type "zoom" | "none"

Specifies what should chart do if when mouse wheel is rotated.
nonScaling
#

Type boolean

Inherited from ISpriteProperties
nonScalingStroke
#

Type boolean

Inherited from ISpriteProperties
opacity
#

Type number

Inherited from ISpriteProperties
paddingBottom
#

Type number

Inherited from ISpriteProperties
paddingLeft
#

Type number

Inherited from ISpriteProperties
paddingRight
#

Type number

Inherited from ISpriteProperties
paddingTop
#

Type number

Inherited from ISpriteProperties
panBehavior
#

Type "move" | "rotateLat" | "rotateLong" | "rotateLongLat"

Default "move"

What "dragging" map does.

Available values:

  • "move" (default): changes position of the map.
  • "rotateLat": changes deltaLatitude (rotates the globe vertically).
  • "rotateLong": changes deltaLongitude (rotates the globe horizontally).
  • "rotateLongLat": changes both deltaLongitude and deltaLatitude (rotates the globe in any direction).

@since 4.3.0

path
#

Type string

Inherited from ISpriteProperties
patterns
#

Type PatternSet

Inherited from ISerialChartProperties

A set of patterns to use for fills, like Series, Slices, etc.

@since 4.7.5

pixelPerfect
#

Type boolean

Inherited from ISpriteProperties
projection
#

Type Projection

Projection to be used when drawing the map.
readerChecked
#

Type boolean

Inherited from ISpriteProperties
readerControls
#

Type string

Inherited from ISpriteProperties
readerDescribedBy
#

Type string

Inherited from ISpriteProperties
readerDescription
#

Type string

Inherited from ISpriteProperties
readerHidden
#

Type boolean

Inherited from ISpriteProperties
readerLabelledBy
#

Type string

Inherited from ISpriteProperties
readerLive
#

Type AriaLive

Inherited from ISpriteProperties
readerOrientation
#

Type string

Inherited from ISpriteProperties
readerTitle
#

Type string

Inherited from ISpriteProperties
readerValueNow
#

Type string

Inherited from ISpriteProperties
readerValueText
#

Type string

Inherited from ISpriteProperties
resizable
#

Type boolean

Inherited from ISpriteProperties
reverseGeodata
#

Type boolean

Default false

Indicates whether GeoJSON geodata supplied to the chart uses ESRI (clockwise) or non-ESRI (counter-clockwise) order of the polygon coordinates.

MapChart supports only ESRI standard, so if your custom maps appears garbled, try setting reverseGeodata = true.

@since 4.10.11

reverseOrder
#

Type boolean

Default false

Inherited from IContainerProperties

If set to true, the children of the container will be drawn in reverse order.
role
#

Type Roles

Inherited from ISpriteProperties
rotation
#

Type number

Inherited from ISpriteProperties
scale
#

Type number

Inherited from ISpriteProperties
setStateOnChildren
#

Type boolean

Default false

Inherited from IContainerProperties

Specifies if, when state is applied on this container, the same state should be applied to container's children as well as background.
shapeRendering
#

Type ShapeRendering

Inherited from ISpriteProperties
showOnInit
#

Type boolean

Inherited from ISpriteProperties
showTooltipOn
#

Type "hover" | "hit" | "always"

Inherited from ISpriteProperties
stroke
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
strokeDasharray
#

Type string

Inherited from ISpriteProperties
strokeDashoffset
#

Type number

Inherited from ISpriteProperties
strokeLinecap
#

Type "butt" | "square" | "round"

Inherited from ISpriteProperties
strokeLinejoin
#

Type "miter" | "round" | "bevel"

Inherited from ISpriteProperties
strokeModifier
#

Type ColorModifier

Inherited from ISpriteProperties
strokeOpacity
#

Type number

Inherited from ISpriteProperties
strokeWidth
#

Type number

Inherited from ISpriteProperties
swipeable
#

Type boolean

Inherited from ISpriteProperties
tabindex
#

Type number

Inherited from ISpriteProperties
textDecoration
#

Type TextDecoration

Default "none"

Inherited from IContainerProperties

Default font decoration.
togglable
#

Type boolean

Inherited from ISpriteProperties
tooltipHTML
#

Type string

Inherited from ISpriteProperties
tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteProperties
tooltipText
#

Type string

Inherited from ISpriteProperties
tooltipX
#

Type number | Percent

Inherited from ISpriteProperties
tooltipY
#

Type number | Percent

Inherited from ISpriteProperties
trackable
#

Type boolean

Inherited from ISpriteProperties
url
#

Type string

Inherited from ISpriteProperties
urlTarget
#

Type string

Inherited from ISpriteProperties
userClassName
#

Type string

Inherited from ISpriteProperties
valign
#

Type VerticalAlign

Inherited from ISpriteProperties
verticalCenter
#

Type VerticalCenter

Inherited from ISpriteProperties
visible
#

Type boolean

Inherited from ISpriteProperties
wheelable
#

Type boolean

Inherited from ISpriteProperties
width
#

Type number | Percent

Inherited from ISpriteProperties
x
#

Type number | Percent

Inherited from ISpriteProperties
y
#

Type number | Percent

Inherited from ISpriteProperties
zIndex
#

Type number

Inherited from ISpriteProperties
zoomStep
#

Type number

Default 2

When user zooms in or out current zoom level is multiplied or divided by value of this setting.
There are 104 inherited items currently hidden from this list.