@syncfusion/ej2-charts
Version:
Feature-rich chart control with built-in support for over 25 chart types, technical indictors, trendline, zooming, tooltip, selection, crosshair and trackball.
190 lines (189 loc) • 3.94 kB
TypeScript
import { ChildProperty } from '@syncfusion/ej2-base';
import { LegendTitleModel, LegendLocationModel, LegendBorderModel, LegendItemStyleModel } from '../legend/legend-model';
import { SmithchartAlignment } from '../utils/enum';
import { LegendItemStyleBorderModel } from '../legend/legend-model';
import { SmithchartFont } from '../utils/utils';
export declare class LegendTitle extends ChildProperty<LegendTitle> {
/**
* visibility for legend title.
*
* @default true
*/
visible: boolean;
/**
* text for legend title.
*
* @default ''
*/
text: string;
/**
* description for legend title.
*
* @default ''
*/
description: string;
/**
* alignment for legend title.
*
* @default Center
*/
textAlignment: SmithchartAlignment;
/**
* options for customizing font.
*/
textStyle: SmithchartFont;
}
export declare class LegendLocation extends ChildProperty<LegendLocation> {
/**
* x location for legend.
*
* @default 0
*/
x: number;
/**
* y location for legend.
*
* @default 0
*/
y: number;
}
export declare class LegendItemStyleBorder extends ChildProperty<LegendItemStyleBorder> {
/**
* border width for legend item.
*
* @default 1
*/
width: number;
/**
* border color for legend item.
*
* @default null
*/
color: string;
}
export declare class LegendItemStyle extends ChildProperty<LegendItemStyle> {
/**
* specify the width for legend item.
*
* @default 10
*/
width: number;
/**
* specify the height for legend item.
*
* @default 10
*/
height: number;
/**
* options for customizing legend item style border.
*/
border: LegendItemStyleBorderModel;
}
export declare class LegendBorder extends ChildProperty<LegendBorder> {
/**
* border width for legend.
*
* @default 1
*/
width: number;
/**
* border color for legend.
*
* @default null
*/
color: string;
}
export declare class SmithchartLegendSettings extends ChildProperty<SmithchartLegendSettings> {
/**
* visibility for legend.
*
* @default false
*/
visible: boolean;
/**
* position for legend.
*
* @default 'bottom'
*/
position: string;
/**
* alignment for legend.
*
* @default Center
*/
alignment: SmithchartAlignment;
/**
* width for legend.
*
* @default null
*/
width: number;
/**
* height for legend.
*
* @default null
*/
height: number;
/**
* shape for legend.
*
* @default 'circle'
*/
shape: string;
/**
* rowCount for legend.
*
* @default null
*/
rowCount: number;
/**
* columnCount for legend.
*
* @default null
*/
columnCount: number;
/**
* spacing between legend item.
*
* @default 8
*/
itemPadding: number;
/**
* Padding between the legend shape and text.
*
* @default 5
*/
shapePadding: number;
/**
* description for legend
*
* @default ''
*/
description: string;
/**
* If set to true, series' visibility collapses based on the legend visibility.
*
* @default true
*/
toggleVisibility: boolean;
/**
* options for customizing legend title.
*/
title: LegendTitleModel;
/**
* options for customizing legend location.
*/
location: LegendLocationModel;
/**
* options for customizing legend item style.
*/
itemStyle: LegendItemStyleModel;
/**
* options for customizing legend border.
*/
border: LegendBorderModel;
/**
* options for customizing font.
*/
textStyle: SmithchartFont;
}