Choose an item

Chart Attributes

  • a
  • b
  • c
  • d
  • e
  • f
  • g
  • h
  • i
  • j
  • k
  • l
  • m
  • n
  • o
  • p
  • q
  • r
  • s
  • t
  • u
  • v
  • w
  • x
  • y
  • z
  • Area 2D
  • Bar 2D
  • Bar 3D
  • Box and Whisker 2D
  • Bubble Chart
  • Candlestick Chart
  • Chord
  • Column 2D
  • Column 3D
  • Doughnut 2D
  • Doughnut 3D
  • Drag Node Chart
  • Drag-able Area 2D Chart
  • Drag-able Column 2D Chart
  • Drag-able Line 2D Chart
  • Error Bar Chart
  • Error Line 2D Chart
  • Error Scatter Chart
  • Funnel Chart
  • Gantt Chart
  • Heat Map Chart
  • Horizontal Bullet Graph
  • Horizontal LED
  • Inverse Y-axis Area Chart
  • Inverse Y-axis Column 2D Chart
  • Inverse Y-axis Line 2D Chart
  • Kagi Chart
  • Line 2D
  • Logarithmic Column 2D Chart
  • Logarithmic Line 2D Chart
  • Marimekko
  • Multi-axis Line Chart
  • Multi-level Pie Chart
  • Multi-series 2D Dual Y Combination Chart (Column + Line + Area + Spline)
  • Multi-series 2D Single Y Combination Chart (Column + Line + Area + Spline)
  • Multi-series 3D Dual Y Combination Chart (Column + Line + Area + Spline)
  • Multi-series 3D Single Y Combination Chart (Column + Line + Area + Spline)
  • Multi-series Area 2D
  • Multi-series Bar 2D
  • Multi-series Bar 3D
  • Multi-series Column 2D
  • Multi-series Column 3D
  • Multi-series Column 3D + Line Dual Y Axis
  • Multi-series Column 3D + Line Single Y-axis
  • Multi-series Line 2D
  • Multi-series Spline
  • Multi-series Spline Area
  • Multi-series Stacked Column 2D
  • Multi-series Stacked Column 2D + Line Dual Y Axis
  • Overlapped Column 2D
  • Overlapped Bar 2D
  • Pareto 2D
  • Pareto 3D
  • Pie 2D
  • Pie 3D
  • Pyramid Chart
  • Radar Chart
  • Real-time Angular
  • Real-time Area
  • Real-time Bulb
  • Real-time Column
  • Real-time Cylinder
  • Real-time Horizontal Linear
  • Real-time Line
  • Real-time Line (Dual Y)
  • Real-time Stacked Area
  • Real-time Stacked Column
  • Real-time Thermometer
  • Sankey Diagram
  • Scatter Chart
  • Scroll Area 2D
  • Scroll Bar 2D
  • Scroll Column 2D
  • Scroll Combination 2D (Dual Y)
  • Scroll Combination 2D (Single Y)
  • Scroll Line 2D
  • Scroll Multi-series Stacked Column 2D
  • Scroll Multi-series Stacked Column 2D + Line (Dual Y)
  • Scroll Stacked Bar 2D
  • Scroll Stacked Column 2D
  • Select-scatter Chart
  • Single-series Spline 2D
  • Single-series Spline Area 2D
  • Spark Column
  • Spark Line
  • Spark Win/Loss
  • Stacked 2D Column + Line Single Y-axis
  • Stacked 3D Column + Line Single Y-axis
  • Stacked Area 2D
  • Stacked Area 2D Line Dual Y-axis Chart
  • Stacked Bar 2D
  • Stacked Bar 3D
  • Stacked Column 2D
  • Stacked Column 2D Line Dual Y-axis Chart
  • Stacked Column 3D
  • Stacked Column 3D + Line Dual Y Axis
  • Step Line Charts
  • Sunburst
  • Tree Map Chart
  • Vertical Bullet Graph
  • Vertical LED
  • Waterfall / Cascade Chart
  • Zoom Line
  • Zoom Line Dual Y-axis
  • Zoom Scatter
JavaScript alias: sankey
See all attributes
  • json
  • xml
{
    "chart": {
        "caption": "Immigrant Flow for Last Month (In Millions)",
        "legendPosition": "bottom",
        "linkcolor": "blend",
        "theme": "fusion"
    },
    "nodes": [
        {
            "label": "Netherlands"
        },
        {
            "label": "Canada"
        },
        {
            "label": "Belgium"
        },
        {
            "label": "Italy"
        },
        {
            "label": "Mexico"
        },
        {
            "label": "Russia"
        },
        {
            "label": "Spain"
        },
        {
            "label": "South Korea"
        },
        {
            "label": "Germany"
        },
        {
            "label": "China"
        },
        {
            "label": "European Union"
        },
        {
            "label": "Japan"
        },
        {
            "label": "United Kingdom"
        },
        {
            "label": "United States"
        },
        {
            "label": "France"
        },
        {
            "label": "Hong Kong"
        },
        {
            "label": "Switzerland"
        },
        {
            "label": "Austria"
        },
        {
            "label": "Sweden"
        }
    ],
    "links": [
        {
            "from": "Netherlands",
            "to": "European Union",
            "value": 798744
        },
        {
            "from": "Germany",
            "to": "European Union",
            "value": 1468990
        },
        {
            "from": "European Union",
            "to": "France",
            "value": 745931
        },
        {
            "from": "European Union",
            "to": "United States",
            "value": 660541
        },
        {
            "from": "Canada",
            "to": "United States",
            "value": 594546
        },
        {
            "from": "Belgium",
            "to": "European Union",
            "value": 628796
        },
        {
            "from": "China",
            "to": "Hong Kong",
            "value": 400571
        },
        {
            "from": "China",
            "to": "United States",
            "value": 526454
        },
        {
            "from": "European Union",
            "to": "United Kingdom",
            "value": 520318
        },
        {
            "from": "China",
            "to": "European Union",
            "value": 560536
        },
        {
            "from": "Italy",
            "to": "European Union",
            "value": 539556
        },
        {
            "from": "Mexico",
            "to": "United States",
            "value": 492715
        },
        {
            "from": "Russia",
            "to": "European Union",
            "value": 385778
        },
        {
            "from": "Spain",
            "to": "European Union",
            "value": 365191
        },
        {
            "from": "China",
            "to": "Japan",
            "value": 312062
        },
        {
            "from": "European Union",
            "to": "Switzerland",
            "value": 328609
        },
        {
            "from": "South Korea",
            "to": "China",
            "value": 229073
        },
        {
            "from": "European Union",
            "to": "Austria",
            "value": 244913
        },
        {
            "from": "Japan",
            "to": "United States",
            "value": 206091
        },
        {
            "from": "European Union",
            "to": "Sweden",
            "value": 204849
        },
        {
            "from": "Germany",
            "to": "United States",
            "value": 184287
        }
    ]
}
<chart caption="Immigrant Flow for Last Month (In Millions)" legendposition="bottom" linkcolor="blend" theme="fusion">
    <nodes label="Netherlands" />
    <nodes label="Canada" />
    <nodes label="Belgium" />
    <nodes label="Italy" />
    <nodes label="Mexico" />
    <nodes label="Russia" />
    <nodes label="Spain" />
    <nodes label="South Korea" />
    <nodes label="Germany" />
    <nodes label="China" />
    <nodes label="European Union" />
    <nodes label="Japan" />
    <nodes label="United Kingdom" />
    <nodes label="United States" />
    <nodes label="France" />
    <nodes label="Hong Kong" />
    <nodes label="Switzerland" />
    <nodes label="Austria" />
    <nodes label="Sweden" />
    <links from="Netherlands" to="European Union" value="798744" />
    <links from="Germany" to="European Union" value="1468990" />
    <links from="European Union" to="France" value="745931" />
    <links from="European Union" to="United States" value="660541" />
    <links from="Canada" to="United States" value="594546" />
    <links from="Belgium" to="European Union" value="628796" />
    <links from="China" to="Hong Kong" value="400571" />
    <links from="China" to="United States" value="526454" />
    <links from="European Union" to="United Kingdom" value="520318" />
    <links from="China" to="European Union" value="560536" />
    <links from="Italy" to="European Union" value="539556" />
    <links from="Mexico" to="United States" value="492715" />
    <links from="Russia" to="European Union" value="385778" />
    <links from="Spain" to="European Union" value="365191" />
    <links from="China" to="Japan" value="312062" />
    <links from="European Union" to="Switzerland" value="328609" />
    <links from="South Korea" to="China" value="229073" />
    <links from="European Union" to="Austria" value="244913" />
    <links from="Japan" to="United States" value="206091" />
    <links from="European Union" to="Sweden" value="204849" />
    <links from="Germany" to="United States" value="184287" />
</chart>

Chart Atributes

Functional Attributes

These attributes let you control a variety of functional elements on the chart. For example, you can opt to show/hide data labels, data values. You can also set chart limits and extended properties.

chart : {
orientation : String [+] 3.15.0

This attribute lets you specify whether the Sankey Diagram should have a vertical or horizontal orientation.

Default value: horizontal

Range: vertical / horizontal

animation : Boolean [+]

This attribute gives you the option to control animation in your charts. If you do not want to animate any part of the chart, set this as 0.

Range: 0/1

animationDuration : Number [+]

This attribute sets the animation duration of the chart. animationDuration attribute is applicable only if animation of the chart is enabled.

Default value: 1 sec

Range: In seconds

palette : Number [+]

FusionCharts XT uses the concept of Color Palettes. Each chart has 5 pre-defined color palettes which you can choose from. Each palette renders the chart in a different color theme.

Range: 1-5

paletteColors : String [+]

While the palette attribute allows to select a palette theme that applies to chart background, canvas, font and tool-tips, it does not change the colors of data items (i.e., column, line, pie etc.). Using paletteColors attribute, you can specify your custom list of hex colors for the data items. The list of colors have to be separated by comma e.g., "paletteColors": "#FF0000, #0372AB, #FF5904...". The chart will cycle through the list of specified colors and then render the data plot accordingly. To use the same set of colors throughout all your charts in a web application, you can store the list of palette colors in your application globally and then provide the same in each chart JSON.

Range: List of hex color codes separated by comma

theme : String [+]

This attribute changes the theme of the chart. There are 7 types of themes which have been made according to the different color combinations.

Range: 'fusion', 'gammel', 'candy', 'ocean', 'zune', 'carbon', 'umber'

enableDrag : Boolean [+] 3.15.0

This attribute allows you to enable/disable dragging of nodes in a chart.

Range: 0/1

}

These attributes let you set and configure custom chart messages, using text as well as images. These attributes are supported in FusionCharts constructor (FusionCharts({ })).

FusionCharts : {
baseChartMessageFont : String [+] 3.5.0

This attribute allows to set a custom font for all chart messages.

baseChartMessageFontSize : Number [+] 3.5.0

This attribute allows to set a custom font size for all chart messages.

Range: In pixels

baseChartMessageColor : Color [+] 3.5.0

This attribute allows to set a custom font color for all chart messages.

Range: Hex Color Code

baseChartMessageImageHAlign : String [+] 3.7.0

This attribute allows to set a custom horizontal alignment for all images displayed as chart messages.

Default value: middle

Range: left, middle, right

baseChartMessageImageVAlign : String [+] 3.7.0

This attribute allows to set a custom vertical alignment for all images displayed as chart messages.

Default value: middle

Range: top, middle, bottom

baseChartMessageImageAlpha : Number [+] 3.7.0

This attribute allows to set a transparency for all images displayed as chart messages.

Default value: 100

Range: 0 - 100

baseChartMessageImageScale : Number [+] 3.7.0

This attribute allows to set a scale for magnifying all images displayed as chart messages.

Default value: 100

Range: 0-300

loadMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed when a chart begins to load. To display an image as the chart message, prefix I- to the image URL.

loadMessageFont : String [+] 3.5.0

This attribute allows to set the font for the message displayed when a chart begins to load.

Range: Font Name

loadMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed when a chart begins to load.

Range: In pixels

loadMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed when a chart begins to load.

Range: Hex Color Code

loadMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart loadMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

loadMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart loadMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

loadMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart loadMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

loadMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart loadMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

typeNotSupportedMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed when the specified chart type is not supported. To display an image as the chart message, prefix I- to the image URL.

typeNotSupportedMessageFont : String [+] 3.5.0

This attribute allows to set the font for the message displayed when the specified chart type is not supported.

Range: Font Name

typeNotSupportedMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed when the specified chart type is not supported.

Range: In pixels

typeNotSupportedMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed when the specified chart type is not supported.

Range: Hex Color Code

typeNotSupportedMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart typeNotSupportedMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

typeNotSupportedMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart typeNotSupportedMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

typeNotSupportedMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart typeNotSupportedMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

typeNotSupportedMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart typeNotSupportedMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

renderErrorMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed if an error is encountered while rendering the chart. To display an image as the chart message, prefix I- to the image URL.

renderErrorMessageFont : String [+] 3.5.0

This attribute allows to set a font for the message displayed if an error is encountered while rendering the chart.

Range: Font Name

renderErrorMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed if an error is encountered while rendering the chart.

Range: In pixels

renderErrorMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed if an error is encountered while rendering the chart.

Range: Hex Color Code

renderErrorMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart renderErrorMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

renderErrorMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart renderErrorMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

renderErrorMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart renderErrorMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

renderErrorMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart renderErrorMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

dataLoadStartMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed when chart data begins loading. To display an image as the chart message, prefix I- to the image URL.

dataLoadStartMessageFont : String [+] 3.5.0

This attribute allows to set a font for the message displayed when chart data begins loading.

Range: Font Name

dataLoadStartMessageFontSize : String [+] 3.5.0

This attribute allows to set the font size for the message displayed when chart data begins loading.

Range: In pixels

dataLoadStartMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed when chart data begins loading.

Range: Hex Color Code

dataLoadStartMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart dataLoadStartMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

dataLoadStartMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart dataLoadStartMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

dataLoadStartMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart dataLoadStartMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

dataLoadStartMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart dataLoadStartMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

dataEmptyMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed if the data loaded for a chart is empty. To display an image as the chart message, prefix I- to the image URL.

dataEmptyMessageFont : String [+] 3.5.0

This attribute allows to set the font for the message displayed if the data loaded for a chart is empty

Range: Font Name

dataEmptyMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed if the data loaded for a chart is empty.

Range: In pixels

dataEmptyMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed if the data loaded for a chart is empty.

Range: Hex Color Code

dataEmptyMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart dataEmptyMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

dataEmptyMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart dataEmptyMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

dataEmptyMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart dataEmptyMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

dataEmptyMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart dataEmptyMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

dataLoadErrorMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed if an error is encountered while loading chart data. To display an image as the chart message, prefix I- to the image URL.

dataLoadErrorMessageFont : String [+] 3.5.0

This attribute allows to set a font for the message displayed if an error is encountered while loading chart data.

Range: Font Name

dataLoadErrorMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed if an error is encountered while loading chart data.

Range: In pixels

dataLoadErrorMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed if an error is encountered while loading chart data.

Range: Hex Color Code

dataLoadErrorMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart dataLoadErrorMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

dataLoadErrorMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart dataLoadErrorMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

dataLoadErrorMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart dataLoadErrorMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

dataLoadErrorMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart dataLoadErrorMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

dataInvalidMessage : String [+] 3.7.0

This attribute allows to set the message to be displayed if the data to be loaded for the chart is invalid. To display an image as the chart message, prefix I- to the image URL.

dataInvalidMessageFont : String [+] 3.5.0

This attribute allows to set the font for the message displayed if the specified chart data is invalid.

Range: Font Name

dataInvalidMessageFontSize : Number [+] 3.5.0

This attribute allows to set the font size for the message displayed if the specified chart data is invalid.

Range: In pixels

dataInvalidMessageColor : Color [+] 3.5.0

This attribute allows to set the font color for the message displayed if the specified chart data is invalid.

Range: Hex Color Code

dataInvalidMessageImageHAlign : String [+] 3.7.0

If an image is displayed as the chart dataInvalidMessage, this attribute allows to set a custom horizontal alignment for the image.

Default value: value assigned to the baseChartMessageImageHAlign attribute

Range: left, middle, right

dataInvalidMessageImageVAlign : String [+] 3.7.0

If an image is displayed as the chart dataInvalidMessage, this attribute allows to set a custom vertical alignment for the image.

Default value: value assigned to the baseChartMessageImageVAlign attribute

Range: top, middle, bottom

dataInvalidMessageImageAlpha : Number [+] 3.7.0

If an image is displayed as the chart dataInvalidMessage, this attribute allows to set the transparency of the image.

Default value: 100

Range: 0 - 100

dataInvalidMessageImageScale : Number [+] 3.7.0

If an image is displayed as the chart dataInvalidMessage, this attribute allows to set the scale for magnifying the image.

Default value: 100

Range: 0-300

}
Chart Caption Cosmetics

These attributes let you configure the cosmetics of chart caption and sub-caption.

chart : {
captionAlignment : String [+]

Sets horizontal alignment of caption

Range: "left", "center", "right"

captionOnTop : Boolean [+]

Whether caption should be on top of the data plot area

Range: 0/1

captionFontSize : Number [+]

Sets the caption font size in pixels. Besides pixels (px) values can also be defined in rem, %, em, and vw.

Range: 6 - 72

subCaptionFontSize : Number [+]

Sets the sub-caption font size (in pixels). Besides pixels (px) values can also be defined in rem, %, em, and vw.

Range: 6 - 72

captionFont : String [+]

Sets the caption font family

Range: Font Name

subCaptionFont : String [+]

Sets the sub-caption font family

Range: Font Name

captionFontColor : Color [+]

Sets the caption font color

Range: Hex Color Code

subCaptionFontColor : Color [+]

Sets the sub-caption font color

Range: Hex Color Code

captionFontBold : Boolean [+]

Whether the caption font should be displayed in bold

Range: 0/1

subCaptionFontBold : Boolean [+]

Whether the sub caption font should be displayed in bold

Range: 0/1

alignCaptionWithCanvas : Boolean [+]

Whether the caption is aligned with the canvas. Else, it will be aligned with the entire chart area

Range: 0/1

captionHorizontalPadding : Number [+]

If caption is not centre aligned, lets you configure the padding (in pixels) from either edge. Will be ignored if caption is centre aligned.

Range: In Pixels

}
Chart Cosmetics

The following attributes let you configure chart cosmetics like background color, background alpha, canvas color & alpha etc.

chart : {
bgColor : Color [+]

This attribute sets the background color for the chart. You can set any hex color code as the value of this attribute. To specify a gradient as background color, separate the hex color codes of each color in the gradient using comma. Example: #FF5904, #FFFFFF.

Range: Hex Color Code

bgAlpha : Number [+]

Sets the alpha (transparency) for the background. If you've opted for gradient background, you need to set a list of alpha(s) separated by comma.

Range: 0 - 100

showBorder : Boolean [+]

Whether to show a border around the chart or not.

Range: 0/1

borderColor : Color [+]

Border color of the chart.

Range: Hex Color Code

borderThickness : Number [+]

Border thickness of the chart.

Range: In Pixels

borderAlpha : Number [+]

Border alpha of the chart.

Range: 0 - 100

}
Node Label Configuration

The attributes in this section let you customize several functional aspects of a node label.

chart : {
inheritLabelColorFromNode : Boolean [+] 3.15.0

This attribute allows you to enforce whether or not a label should inherit its color from the corresponding node.

Default value: 1

Range: 0/1

nodeLabelPadding : Number [+] 3.15.0

This attribute lets you set the spacing between the label and the node. It is not applicable when a node label is placed inside the node.

Range: In pixels

nodeSpacing : Number [+] 3.15.0

This attribute lets you set the spacing between two labels in a column. It is not applicable if nodeRelaxation is enabled.

Range: In pixels

nodeWidth : Number [+] 3.15.0

This attribute allows you to set the width of a node.

Range: In Pixels

nodeRelaxation : Boolean [+] 3.15.0

This attribute allows you to specify whether nodes in the chart will automatically be repositioned to create an organized look.

Default value: 1

Range: 0 / 1

nodeLinkPadding : Number [+] 3.15.0

This attribute allows you to set the space between a node and the corresponding link.

Range: In Pixels

showNodeLabels : Boolean [+] 3.15.0

This attribute lets you specify whether or not node labels should be displayed.

Default value: 1

Range: 0 / 1

showNodeValues : Boolean [+] 3.15.0

This attribute lets you specify whether or not node values should be displayed.

Default value: 1

Range: 0 / 1

rotateNodeLabels : Boolean [+] 3.15.0

This attribute lets you specify whether or not node labels should be rotated and displayed.

Default value: 1

Range: 0 / 1

nodeLabelPosition : String [+] 3.15.0

This attribute lets you position the labels with respect to the nodes.

Default value: end

Range: start, inside, end

nodeColor : Color [+] 3.15.0

This attribute allows you to specify the color of the node.

Range: Hex Color Code

nodeAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node between 0 for transparent and 100 for opaque.

Range: 0 - 100

}
Node Label Cosmetics

The attributes in this section let you customize several cosmetic aspects of a node label.

chart : {
nodeLabelFont : String [+] 3.15.0

This attribute lets you set the font family for the node label text.

Range: Font Name

nodeLabelFontColor : Color [+] 3.15.0

This attribute lets you set the font color for the node label text.

Range: Hex Color Code

nodeLabelAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node label between 0 for transparent and 100 for opaque.

Range: 0 - 100

nodeLabelBgColor : Color [+] 3.15.0

This attribute allows you to set the background color of the node label.

Range: Hex Color Code

nodeLabelBorderColor : Color [+] 3.15.0

This attribute allows you to set the color of the node label border.

Range: Hex Color Code

nodeLabelBorderThickness : Number [+] 3.15.0

This attribute allows you to set the thickness of the node label border.

Range: In pixels

nodeLabelFontSize : Number [+] 3.15.0

This attribute lets you set the font size of the node label text.

Range: 0 - 72

nodeLabelFontBold : Boolean [+] 3.15.0

This attribute lets you specify whether or not the node label text should be displayed in bold.

Default value: 0

Range: 0 / 1

nodeLabelFontItalic : Boolean [+] 3.15.0

This attribute lets you specify whether or not the node label text should be displayed in italic.

Default value: 0

Range: 0 / 1

nodeLabelborderradius : Number [+] 3.15.0

This attribute lets you set the radius of the node label border.

Range: In pixels

nodeLabelBorderPadding : Number [+] 3.15.0

This attribute lets you set the space between the node label border and the node label.

Range: In Pixels

nodeLabelBorderDashed : Boolean [+] 3.15.0

This attribute lets you specify whether or not the border of the node label should be dashed.

Default value: 0

Range: 0 / 1

nodeLabelBorderDashlen : Number [+] 3.15.0

This attribute allows you to set the length of every dash in the border of the node label. It only works if the value of nodeLabelBorderDashed attribute is set to 1.

Range: In pixels

nodeLabelBorderDashgap : Number [+] 3.15.0

This attribute allows you to set the space between two consecutive dashes in the border of the node label. It only works if the value of nodeLabelBorderDashed attribute is set to 1.

Range: In pixels

}

The attributes in this section let you customize several functional and cosmetic aspects of a link.

chart : {
linkColor : Color [+] 3.15.0

This attribute allows you to specify the color of the link.

Range: Hex Color Code

linkAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the link between 0 for transparent and 100 for opaque.

Range: 0 - 100

linkCurvature : Number [+] 3.15.0

This attribute lets you specify whether the link should be drawn straight or curved.

Range: 0 - 1

}
Legend Properties

In multi-series charts, the series name of each dataset shows up in the legend of the chart. If you do not need the legend, you can opt to hide the same. Also, the legend can be placed at the bottom of the chart or to the right of the chart. Using the attributes below, you can configure the functional and cosmetic properties of the legend.

chart : {
showLegend : Boolean [+]

Whether to show legend on the chart.

Range: 0/1

legendItemFontBold : Boolean [+]

Whether legend keys should be displayed in bold

Range: 0/1

legendItemFont : String [+]

Sets legend item font

Range: Font Name

legendItemFontSize : Number [+]

Sets legend item font size

Range: 6 - 72

legendItemFontColor : Color [+]

Sets legend item font color

Range: Hex Color Code

legendItemHoverFontColor : Color [+]

Sets legend item font color on hover

Range: Hex Color Code

legendPosition : String [+]

The legend can be plotted at different positions with respect to the chart. Note that if the value of legendPosition is set to absolute, you also need to set the coordinates of the legend. You can do that using the attributes legendXPosition and legendYPosition, both of which accept absolute or percentage values.

Range: bottom, right, top, top-left, top-right, bottom-left, bottom-right, left, left-top, left-bottom, right, right-top, right-bottom, and absolute

legendXPosition : Number [+]

When the value of legendPosition is set to absolute, use this attribute to set the X-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to 0.

Range: 0 to chart width (in pixels)

legendYPosition : Number [+]

When the value of legendPosition is set to absolute, use this attribute to set the Y-coordinate of the legend. It accepts absolute or percentage values. By default, its value is set to 0.

Range: 0 to chart height (in pixels)

legendNumRows : Number [+]

Sets the number of rows the legend should display.

legendNumColumns : Number [+]

Sets the number of columns the legend should display.

legendCaptionAlignment : String [+]

Sets the legend caption horizontal alignment .

Range: "left", "center", "right"

legendCaptionFontBold : Boolean [+]

Whether legend caption should be displayed in bold

Range: 0/1

legendCaptionFont : String [+]

Sets legend caption font

Range: Font Name

legendCaptionFontSize : Number [+]

Sets legend caption font size

Range: 6 - 72

legendCaptionFontColor : Color [+]

Sets legend caption font color

Range: Hex Color Code

legendCaption : String [+]

You can add a caption for the entire legend by setting the same here.

Range:  

legendItemHiddenColor : Color [+]

Sets the color that applies on both text font and icon when they are in a disabled / hidden state

Range: Hex Color Code

legendIconScale : Number [+] 3.2

Scaling of legend icon is possible in FusionCharts XT. This attribute lets you control the size of legend icon.

Range: 1-5

legendBgColor : Color [+]

Background color for the legend.

Range: Hex Color Code

legendBgAlpha : Number [+]

Background alpha for the legend.

Range: 0 - 100

legendBorderColor : Color [+]

Border Color for the legend.

Range: Hex Color Code

legendBorderThickness : Number [+]

Border thickness for the legend.

Range: In Pixels

legendBorderAlpha : Number [+]

Border alpha for the legend.

Range: 0 - 100

legendShadow : Boolean [+]

Whether to show a shadow for legend.

Range: 0/1

legendAllowDrag : Boolean [+]

The legend can be made drag-able by setting this attribute to 1. End viewers of the chart can drag the legend around on the chart.

Range: 0/1

legendScrollBgColor : Color [+]

If you've too many items on the legend, a scroll bar shows up on the same. This attribute lets you configure the background color of the scroll bar.

Range: Hex Color Code

reverseLegend : Boolean [+]

You can reverse the ordering of datasets in the legend by setting this attribute to 1.

Range: 0/1

legendNumColumns : Number [+] 3.2

If your chart contains multiple series, the legend is displayed as a grid comprising of multiple legend keys. With the help of this attribute you can specify the number of columns that are to be displayed in the legend.

Range: Positive Integer

minimiseWrappingInLegend : Boolean [+] 3.2

Whether to minimize legend item text wrapping.

Range: 0/1

drawCustomLegendIcon : Boolean [+] 3.8.0

Specifies whether drawing a custom legend icon will be enabled. All legend icon customization attributes will work only if this feature is enabled.

Default value: 0 (disabled)

Range: 0/1

legendIconBorderColor : Color [+] 3.8.0

Sets the border color for the legend icon.

Default value: Data plot border color

Range: Hex Color Code

legendIconBgColor : Color [+] 3.8.0

Sets the background color for the legend icon.

Default value: Data plot fill color

Range: Hex Color Code

legendIconAlpha : Number [+] 3.8.0

Sets the legend icon transparency.

Default value: 100

Range: 0 - 100

legendIconBgAlpha : Number [+] 3.8.0

Sets the legend icon background transparency.

Default value: 100

Range: 0 - 100

legendIconSides : Number [+] 3.8.0

Sets the number of sides for the legend icon.

Default value: 4

legendIconBorderThickness : Number [+] 3.8.0

Sets the thickness of the legend icon border.

Default value: 1

Range: 1-5

legendIconStartAngle : Number [+] 3.8.0

Sets the starting angle of for drawing the legend icon.

Default value: 45

alignLegendWithCanvas : Boolean [+] 3.10.0

This attribute if set to 0, the legend box will be center aligned with respect to the entire width of the chart only if the total width of the legend box is more than the canvas width. By default, the legend box is center aligned with respect to the canvas width and it remains the same if the width of the legend box is less than the canvas width.

Range: 0/1

}
Number Formatting

FusionCharts XT offers you a lot of options to format your numbers on the chart. Using the attributes below, you can control a myriad of options like: Formatting of commas and decimals Number prefixes and suffixes Decimal places to which the numbers will round to Scaling of numbers based on a user defined scale Custom number input formats

chart : {
formatNumber : Boolean [+]

This configuration determines whether the numbers displayed on the chart will be formatted using commas, e.g., 40,000 if 'formatNumber': '1'; and 40000 if 'formatNumber': '0';.

Range: 0/1

formatNumberScale : Boolean [+]

Configuration whether to add K (thousands) and M (millions) to a number after truncating and rounding it - e.g., if formatNumberScale is set to 1, 1043 will become 1.04K (with decimals set to 2 places). Same with numbers in millions - an M will be added at the end.

Range: 0/1

defaultNumberScale : String [+]

The default unit of the numbers that you're providing to the chart.

numberScaleUnit : String [+]

Unit of each block of the scale.

numberScaleValue : String [+]

Range of the various blocks that constitute the scale.

forceNumberScale : Boolean [+] 3.9.0

If a data value is less than the lowest given number is the number scale, this attribute forces the lower value of the numberScaleUnit to be applied to that data value. This attribute works only when “formatNumberScale”: “1” and the defaultNumberScale attribute is not defined.

For example, if “numberScaleUnit”: “K, M”, “numberScaleValue”: “1000, 1000”, and “forceNumberScale”: “1”, a data value of 400 will be rendered as 0.40K.

Range: 0/1

scaleRecursively : Boolean [+] 3.2.2 - SR3

Whether recursive scaling should be applied.

Range: 0/1

maxScaleRecursion : Number [+] 3.2.2 - SR3

How many recursions to complete during recursive scaling? -1 completes the entire set of recursion.

scaleSeparator : String [+] 3.2.2 - SR3

What character to use to separate the scales that are generated after recursion?

numberPrefix : String [+]

Using this attribute, you could add prefix to all the numbers visible on the graph. For example, to represent all dollars figure on the chart, you could specify this attribute to $ to show like $40000, $50000.

Range: Character

numberSuffix : String [+]

Using this attribute, you could add a suffix to all the numbers visible on the graph. For example, to represent all figures quantified as per annum on the chart, you could specify this attribute to '/a' to show like 40000/a, 50000/a.

Range: Character

decimalSeparator : String [+]

This attribute helps you specify the character to be used as the decimal separator in a number.

Range: Character

thousandSeparator : String [+]

This attribute helps you specify the character to be used as the thousands separator in a number.

Range: Character

thousandSeparatorPosition : Number [+] 3.2.2 - SR3

This option helps you specify the position of the thousand separator.

Range:  

inDecimalSeparator : String [+]

In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, FusionCharts XT accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the decimal separator.

Range: Character

inThousandSeparator : String [+]

In some countries, commas are used as decimal separators and dots as thousand separators. In XML, if you specify such values, it will give an error while converting to number. So, FusionCharts XT accepts the input decimal and thousand separator from user, so that it can convert it accordingly into the required format. This attribute lets you input the thousand separator.

Range: Character

decimals : Number [+]

Number of decimal places to which all numbers on the chart will be rounded to.

Range: 0-10

forceDecimals : Boolean [+]

Whether to add 0 padding at the end of decimal numbers. For example, If you limit the maximum number of decimal digits to 2, a number like 55.345 will be rounded to 55.34. This does not mean that all numbers will be displayed with a fixed number of decimal places. For instance 55 will not be displayed as 55.00 and 55.1 will not become 55.10. In order to have fixed number of decimal places attached to all the numbers, set this attribute to 1.

Range: 0/1

}
Font Properties

Using the attributes below, you can define the generic font properties for all the text on the chart. These attributes allow you a high level control over font properties. If you intend to specify font properties for individual chart elements (like Caption, sub-caption etc.), you'll need to use the Styles feature of FusionCharts XT. Using Styles, you can also specify advanced font properties like Bold, Italics, HTML Mode etc.

chart : {
baseFont : String [+]

This attribute lets you set the font face (family) of all the text (data labels, values etc.) on chart. If you specify the outCnvBaseFont attribute also, then this attribute controls only the font face of text within the chart canvas bounds.

Range: Font Name

baseFontSize : Number [+]

This attribute sets the base font size of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font size provided here. Besides pixels (px) values can also be defined in rem, %, em, and vw.

Range: 6 - 72

baseFontColor : Color [+]

This attribute sets the base font color of the chart i.e., all the values and the names in the chart which lie on the canvas will be displayed using the font color provided here.

Range: Hex Color Code

}
Tooltip Attributes

These attributes let you control the tooltip. You can set the background color, border color, separator character and few other details.

chart : {
showToolTip : Boolean [+]

Whether to show tool tip on chart.

Range: 0/1

toolTipBgColor : Color [+]

Background color for tool tip.

Range: Hex Color Code

toolTipColor : Color [+]

Font color for the tool-tip.

Range: Hex Color Code

toolTipBorderColor : Color [+]

Border color for tool tip.

Range: Hex Color Code

tooltipBorderAlpha : Number [+]

Sets the border transparency for tool tip.

Range: 0 - 100

toolTipSepChar : String [+]

The character specified as the value of this attribute separates the name and value displayed in tool tip.

showToolTipShadow : Boolean [+]

Whether to show shadow for tool-tips on the chart.

Range: 0/1

plotToolText : String [+]

Specify custom text for node tooltips at global level. You can use plain text, macros, and basic html like br, strong, em,and b.

linkToolText : String [+]

Specify custom text for link tooltips at global level. You can use plain text, macros, and basic html like br, strong, em,and b.

tooltext : String [+]

Specify custom text for node or link tooltips at local level. You can use plain text, macros, and basic html like br, strong, em,and b.

tooltipPosition : String [+]

Configure the tooltip's position.

Range: auto, top and bottom

}
Toolbar Attributes

Using this set of attributes, you can customize the toolbar on the chart. The advantage of having a toolbar is that it manages all the UI action elements (context menus, checkboxes, buttons) centrally. This provides a clean, uniform look and a better, more meaningful and logical grouping.

chart : {
toolbarPosition : String [+] 3.11.3

Where to position the toolbar on the chart: TL - Top-left TR - Top-right BR - Bottom right BL - Bottom left CC - Center of screen

Range: TL, TR, BL, BR, CC

toolbarX : Number [+] 3.11.3

Sets the toolbox position on the chart with respect to x-axis.

toolbarY : Number [+] 3.11.3

Sets the toolbox position on the chart with respect to y-axis.

toolbarHAlign : String [+] 3.11.3

Sets the horizontal alignment of the toolbar on the chart.

Range: Left, Right

toolbarVAlign : String [+] 3.11.3

Sets the vertical alignment of the toolbar on the chart

Range: Top, Bottom

toolbarButtonColor : Color [+]

Sets the color of the toolbar buttons.

Range: Any (color code without the # prefix)

showToolBarButtonTooltext : Boolean [+]

Enables/disables display of tooltips for toolbar buttons.

Range: 0/1

toolbarButtonScale : Number [+]

You can change the scale of the toolbar by specifying a value for this attribute.

}
Attributes for Exporting Charts

These attributes allow you to control the saving of chart as image, SVG or XLSX.

chart : {
exportEnabled : Boolean [+]

Whether the chart will allow exporting to images, PDFs, SVG, XLSX or CSV format.

Default value: 0

Range: 0/1

exportAction : String [+]

In case of server-side exporting, the action specifies whether the exported image will be sent back to client as download, or whether it'll be saved on the server.

Default value: download

Range: 'save' or 'download'

exportHandler : String [+]

In case of server side exporting, this refers to the path of the server-side export handler (the ready-to-use scripts that we provide).

exportFormats : String [+]

Lets you configure what output formats to allow for export of chart, in the export context menu, and also customize the label for each menu item. The attribute value should be a pipe (|) delimited separated key-value pair. Example: exportFormats: 'PNG=Export as High Quality Image&#124;JPG&#124;PDF=Export as PDF File'

exportMode : String [+] 3.12.1

This attributes sets the modes of export. To enable client-side exporting, set this attribute to client.

Default value: auto.

Note: Starting v3.12.1, the exportMode attribute replaces the exportAtClientSide attribute. However, you don’t need to make any changes to the existing setup because, the FusionCharts library comes with the proper mapping already provided.

exportShowMenuItem : Boolean [+]

Whether the menu items related to export (e.g., Save as JPEG etc.) will appear in the context menu of chart.

Range: 0/1

exportTargetWindow : String [+]

In case of server-side exporting and when using download as action, this lefts you configure whether the return image, PDF, SVG or XLSX will open in same window (as an attachment for download), or whether it will open in a new window.

Default value: _self

Range: '_self' or '_blank'

exportFileName : String [+]

Using this attribute you can specify the name (excluding the extension) of the output (export) file.

}
Data Plot Hover Effects

If you wish to show an effect on the data plot (column, line anchor, pie etc.) when the user hovers his mouse over the data plot, these attributes let you configure the cosmetics of the hover for all data plots in the chart.

chart : {
highlightEffect : Boolean [+] 3.15.0

This attribute lets you specify whether the link should be highlighted when hovered upon.

Range: 0 / 1

nodeHoverAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node when hovered over, between 0 for transparent and 100 for opaque.

Range: 0 - 100

linkHoverAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the link when hovered over, between 0 for transparent and 100 for opaque.

Range: 0 - 100

plotHighlightEffect : String [+]

This attribute lets you enable/disable the highlight effect, in the form of a fadeout, for the data plots corresponding to a legend item. When this attribute is enabled and the mouse pointer is hovered over a legend item label, plots belonging to the other data series fadeout, by reducing their opacity.

The fadeout effect can be customized by specifying the fadeout color and opacity using the color and alpha attributes. Eg. fadeout|color=#ff0000, alpha=60

}
Chart Padding & Margins

The following attributes help you control chart margins and paddings. FusionCharts Suite XT allows you to manually customize the padding of various elements on the chart to allow advanced manipulation and control over chart visualization. Padding in FusionCharts Suite XT is always defined in pixels, unless the attribute itself suggests some other scale (like plotSpacePercent, which configures the spacing using percentage values). You can also define the chart margins. Chart Margins refer to the empty space left on the top, bottom, left and right of the chart. That means, FusionCharts Suite XT will not plot anything in that space. It's not necessary for you to specify any padding/margin values. FusionCharts Suite XT automatically assumes the best values for the same, if you do not specify the same.

chart : {
captionPadding : Number [+]

This attribute lets you control the space (in pixels) between the sub-caption and top of the chart canvas. If the sub-caption is not defined, it controls the space between caption and top of chart canvas. If neither caption, nor sub-caption is defined, this padding does not come into play.

Range: In Pixels

chartLeftMargin : Number [+]

Amount of empty space that you want to put on the left side of your chart. Nothing is rendered in this space.

Range: In Pixels

chartRightMargin : Number [+]

Amount of empty space that you want to put on the right side of your chart. Nothing is rendered in this space.

Range: In Pixels

chartTopMargin : Number [+]

Amount of empty space that you want to put on the top of your chart. Nothing is rendered in this space.

Range: In Pixels

chartBottomMargin : Number [+]

Amount of empty space that you want to put at the bottom of your chart. Nothing is rendered in this space.

Range: In Pixels

}
The Node Object

The attributes in this section let you customize several functional and cosmetic aspects of a node.

nodes : {
label : String [+] 3.15.0

This attribute lets you specify the label text for the node. If you omit this, the node will not be displayed.

showLabel : Boolean [+] 3.15.0

This attribute lets you specify whether or not node label should be displayed.

Default value: 1

Range: 0/1

showValue : Boolean [+] 3.15.0

This attribute lets you specify whether or not node value should be displayed.

Default value: 0

Range: 0/1

rotateLabel : Boolean [+] 3.15.0

This attribute lets you specify whether or not node label should be rotated and displayed.

Default value: 0

Range: 0/1

labelPosition : String [+] 3.15.0

This attribute lets you position the labels with respect to the nodes.

Default value: end

Range: start, inside, end

labelFontColor : Color [+] 3.15.0

This attribute lets you set the font color for the node label text.

Range: Hex Color Code

labelAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node label between 0 for transparent and 100 for opaque.

Range: 0 - 100

Labelbgcolor : Color [+] 3.15.0

This attribute allows you to set the background color of the node label.

Range: Hex Color Code

Labelbordercolor : Color [+] 3.15.0

This attribute allows you to set the color of the node label border.

Range: Hex Color Code

color : Color [+] 3.15.0

This attribute allows you to specify the color of the node.

Range: Hex Color Code

alpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node between 0 for transparent and 100 for opaque.

Range: 0 - 100

hoveralpha : Number [+] 3.15.0

This attribute lets you set the transparency of the node when hovered over, between 0 for transparent and 100 for opaque.

Range: 0 - 100

}

The attributes in this section let you customize several functional and cosmetic aspects of a link.

links : {
from : String [+] 3.15.0

This attribute lets you specify the id of the from node of a link. This is a mandatory attribute. If you omit this attribute, the link will not be rendered.

to : String [+] 3.15.0

This attribute lets you specify the id of the to node of a link. This is a mandatory attribute. If you omit this attribute, the link will not be rendered.

value : Number [+] 3.15.0

This attribute lets you set the value of the link. If you set this to 0, the link will not be displayed.

color : Color [+] 3.15.0

This attribute allows you to specify the color of the link.

Range: Hex Color Code

alpha : Number [+] 3.15.0

This attribute lets you set the transparency of the link between 0 for transparent and 100 for opaque.

Range: 0 - 100

hoverAlpha : Number [+] 3.15.0

This attribute lets you set the transparency of the link when hovered over, between 0 for transparent and 100 for opaque.

Range: 0 - 100

curvature : Number [+] 3.15.0

This attribute lets you specify whether the link should be drawn straight or curved.

Range: 0 - 1

}