Box
API
Map
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Chart - legend.title.subtitle

Configures the legend subtitle. The subtitle appears only if the title is specified.

Type:

Object

|

String

To specify only the subtitle's text, assign it directly to this property. Otherwise, set this property to an object with the text and other fields specified.

font

Specifies the legend subtitle's font properties.

Type:

Object

The following code sample illustrates how to set this property:

jQuery
index.js
$(function() {
    $("#chartContainer").dxChart({
        // ...
        legend: {
            title: {
                // ...
                subtitle: {
                    // ...
                    font: {
                        color: "black"
                    }
                }
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-chart ... >
    <dxo-legend>
        <dxo-title ... >
            <dxo-subtitle ... >
                <dxo-font
                    color="black">
                </dxo-font>
            </dxo-subtitle>
        </dxo-title>
    </dxo-legend>
</dx-chart>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxChart ... >
        <DxLegend>
            <DxTitle ... >
                <DxSubtitle ... >
                    <DxFont
                        color="black"
                    />
                </DxSubtitle>
            </DxTitle>
        </DxLegend>
    </DxChart>
</template>

<script>
import DxChart, {
    DxLegend,
    DxTitle,
    DxSubtitle,
    DxFont
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxLegend,
        DxTitle,
        DxSubtitle,
        DxFont
    },
    // ...
}
</script>
React
App.js
import React from 'react';

import Chart, {
    Legend,
    Title,
    Subtitle,
    Font
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Legend ... >
                    <Title ... >
                        <Subtitle ... >
                            <Font color="black" />
                        </Subtitle>
                    </Title>
                </Legend>
            </Chart>
        );
    }
}
export default App;

offset

Specifies the distance between the legend's title and subtitle in pixels.

Type:

Number

Default Value: 0

text

Specifies the subtitle's text.

Type:

String

Default Value: null