Legend Класс

Определение

Пространство имен:

System.Web.UI.DataVisualization.Charting

Сборка:

System.Web.DataVisualization.dll

Представляет условные обозначения для изображения диаграммы.

public ref class Legend : System::Web::UI::DataVisualization::Charting::ChartNamedElement

public class Legend : System.Web.UI.DataVisualization.Charting.ChartNamedElement

type Legend = class
    inherit ChartNamedElement

Public Class Legend
Inherits ChartNamedElement

Наследование

Object

ChartElement

ChartNamedElement

Legend

Комментарии

Класс Legend инкапсулирует все функциональные возможности условных обозначений Chart элемента управления и предоставляется с помощью Legends свойства коллекции корневого Chart объекта.

Для изображения диаграммы может быть любое количество условных обозначений.

Условные обозначения могут:

• Закреплены и выровнены.

• Отображаться внутри или за пределами областей диаграммы.

• Автоматически подгонайте их содержимое.

• Используйте стандартный стиль, например строку, столбец или таблицу.

• Используйте штриховку, цвета градиента и фоновые изображения.

• Размер и расположение в любом месте изображения диаграммы.

Элементы условных обозначений представлены объектом и являются элементами LegendItem по умолчанию или пользовательскими элементами. Пользовательские элементы не связаны с данными и могут добавляться, удаляться и изменяться с помощью CustomItems свойства .

Элементы по умолчанию автоматически добавляются в условные обозначения и являются именами точек данных для кольцевых и круговых диаграмм.

Для всех других типов диаграмм по умолчанию используются имена рядов данных. Каждый ряд имеет Legend свойство, определяющее имя используемой легенды. Элемент условных обозначений не будет создан для ряда, если свойству IsVisibleInLegend присвоено значение false. Текст этих элементов по умолчанию можно изменить с помощью LegendText свойства . Это свойство позволяет указать предопределенные ключевые слова, которые будут заменены соответствующими значениями во время выполнения.

Если у вас есть круговая диаграмма и задано Label свойство , она также установит в тексте условных обозначений значение, заданное для меток. Если вы хотите задать для текста другое значение, можно задать LegendText свойство . В большинстве случаев требуется задать LegendText для свойства значение "#AXISLABEL" или "#VALX".

Символами ряда условных обозначений являются прямоугольники, точки или линии. Тип символа задается диаграммой автоматически и зависит от типа диаграммы.

Размер текста условных обозначений по умолчанию выполняется автоматически. Вы можете отключить автоматическое изменение размера текста условных обозначений, отключив IsTextAutoFit свойство . Если для этого свойства задано значение false, размер текста условных обозначений определяется свойством Size легенды Font. IsTextAutoFit Если свойство включено, AutoFitMinFontSize оно определяет минимальный размер шрифта, который может иметь элемент легенды при изменении размера.

Свойство TextWrapThreshold определяет ограничение на количество символов, которые могут отображаться в одной строке перед переносом текста в другую строку. Если вы не хотите переносить текст в условные обозначения, задайте для свойства значение TextWrapThreshold нуля. По умолчанию, если весь текст легенды не помещается в условные обозначения, текст будет усечен. Вы можете задать TextWrapThreshold для условных обозначений, чтобы текст был обтекаем, а не усечен.

Если содержимое условных обозначений не может поместиться в заданное пространство, записи условных обозначений усекаются. Отображается многоточие, указывающее, что элементов больше, чем в условных обозначениях. Чтобы предотвратить усечение элементов условных обозначений, задайте положение и размер условных обозначений с помощью Position свойства . При установке положения или размера условных обозначений диаграмма больше не может автоматически размещать элементы диаграммы. В некоторых случаях для достижения желаемого внешнего вида необходимо вручную расположить другие элементы диаграммы.

Другой вариант — определить собственные столбцы ячеек вместо использования параметров условных обозначений по умолчанию.

Объект Legend имеет коллекцию CellColumn; каждый объект CellColumn представляет столбец в условных обозначениях. Столбец ячейки имеет MaximumWidth свойства и MinimumWidth , которые можно использовать для настройки размера столбцов.

Если легенда содержит много записей, InterlacedRows ее можно использовать для улучшения удобочитаемости. Если для этого свойства задано значение True, будет отображаться цвет обратной стороны, который можно задать с помощью InterlacedRowsColor свойства .

По умолчанию условные обозначения расположены в правом верхнем углу диаграммы. Эту позицию можно изменить с помощью Docking свойств и Alignment условных обозначений. Условные обозначения также можно связать с областью диаграммы с помощью DockedToChartArea свойства . Это свойство указывает имя области диаграммы, для которой должна быть закреплена легенда. Кроме того, IsDockedInsideChartArea свойство можно использовать для отображения условных обозначений в области диаграммы.

Если IsDockedInsideChartArea задано значение False, MaximumAutoSize свойство определяет максимальный размер (в процентах) легенды в доступной диаграмме при автоматическом расположении условных обозначений. Это свойство следует задать, если вы хотите настроить ширину или высоту условных обозначений после установки свойств стыковки.

Условные обозначения можно изменить с помощью CustomizeLegend события .

Конструкторы

Legend()	Инициализирует новый экземпляр класса Legend.
Legend(String)	Инициализирует новый экземпляр класса AnnotationPathPoint, используя указанное имя легенды.

Свойства

Alignment	Возвращает или задает способ выравнивания в условных обозначениях.
AutoFitMinFontSize	Получает или задает минимальный размер шрифта, используемый при применении алгоритма автоматического размещения текста легенды.
BackColor	Получает или задает цвет фона легенды.
BackGradientStyle	Получает или задает ориентацию для градиента фона легенды. Также определяет, используется ли градиент.
BackHatchStyle	Получает или задает стиль штриховки легенды.
BackImage	Получает или задает фоновое изображение легенды.
BackImageAlignment	Получает или задает тип выравнивания фонового изображения, используемого для режима рисования Unscaled.
BackImageTransparentColor	Получает или задает цвет, который будет заменен прозрачным цветом при рисовании фонового изображения.
BackImageWrapMode	Получает или задает режим рисования для фонового изображения легенды.
BackSecondaryColor	Получает или задает вторичный цвет фона легенды.
BorderColor	Получает или задает цвет границы легенды.
BorderDashStyle	Получает или задает стиль границы легенды.
BorderWidth	Получает или задает ширину границы легенды.
CellColumns	Получает объект LegendCellColumnCollection для легенды.
CustomItems	Возвращает объект LegendItemsCollection, используемый для пользовательских элементов условных обозначений.
DockedToChartArea	Получает или задает имя области ChartArea, в которой будет закреплена легенда.
Docking	Получает или задает значение, определяющее, где будет закреплена легенда.
Enabled	Получает или задает значение, определяющее, будет ли включена легенда.
Font	Получает или задает объект Font, который используется для задания свойств шрифта легенды.
ForeColor	Получает или задает цвет текста легенды.
HeaderSeparator	Получает или задает тип визуального разделителя для заголовка легенды.
HeaderSeparatorColor	Получает или задает цвет разделителя для заголовка легенды.
InsideChartArea	Получает или задает имя области диаграммы, в которой будет нарисована легенда.
InterlacedRows	Получает или задает флаг, который указывает, следует ли рисовать строки легенды с чередованием цвета фона.
InterlacedRowsColor	Получает или задает цвет фона чередующихся строк легенды.
IsDockedInsideChartArea	Получает или задает флаг, который указывает, где необходимо закрепить легенду — внутри или снаружи области диаграммы.
IsEquallySpacedItems	Получает или задает флаг, указывающий, нужно ли размещать все элементы легенды на равном расстоянии друг от друга.
IsTextAutoFit	Получает или задает флаг, указывающий, будет ли размер текста легенды подбираться автоматически.
ItemColumnSeparator	Получает или задает тип визуального разделителя для столбцов таблицы легенды.
ItemColumnSeparatorColor	Получает или задает цвет разделителя столбцов таблицы легенды.
ItemColumnSpacing	Получает или задает интервалы между столбцами таблицы легенды.
LegendItemOrder	Получает или задает флаг, определяющий порядок отображения элементов легенды. Действие этого свойства распространяется только на элементы легенды, автоматически добавляемые в ряд диаграммы; оно не распространяется на пользовательские элементы легенды.
LegendStyle	Получает или задает стиль легенды.
MaximumAutoSize	Получает или задает максимальный размер легенды в процентах от области диаграммы. Это значение используется алгоритмом автоматического создания макета.
Name	Получает или задает имя легенды.
Position	Получает или задает объект ElementPosition, который может использоваться для задания или получения положения легенды.
ShadowColor	Получает или задает цвет тени легенды.
ShadowOffset	Получает или задает смещение тени легенды в пикселях.
TableStyle	Получает или задает стиль таблицы легенды.
Tag	Получает или задает объект, связанный с данным элементом диаграммы. (Унаследовано от ChartElement)
TextWrapThreshold	Получает или задает количество последовательных знаков, которые можно отобразить в легенде до переноса на следующую строку.
Title	Получает или задает текст заголовка легенды.
TitleAlignment	Получает или задает тип выравнивания заголовка легенды.
TitleBackColor	Получает или задает цвет фона для заголовка легенды.
TitleFont	Получает или задает шрифт заголовка легенды.
TitleForeColor	Получает или задает цвет текста заголовка легенды.
TitleSeparator	Получает или задает тип визуального разделителя для заголовка легенды.
TitleSeparatorColor	Возвращает или задает цвет разделителя заголовка условных обозначений.

Методы

Dispose()	Освобождает ресурсы, используемые объектом ChartElement. (Унаследовано от ChartElement)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом Legend, а при необходимости освобождает также управляемые ресурсы.
Equals(Object)	Определяет, равен ли указанный объект Object текущему объекту ChartElement. (Унаследовано от ChartElement)
GetHashCode()	Возвращает хэш-функцию для определенного типа. (Унаследовано от ChartElement)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, которая представляет текущий объект Object. (Унаследовано от ChartElement)