Legend Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет условные обозначения для изображения диаграммы.
public ref class Legend : System::Windows::Forms::DataVisualization::Charting::ChartNamedElement
public class Legend : System.Windows.Forms.DataVisualization.Charting.ChartNamedElement
type Legend = class
inherit ChartNamedElement
Public Class Legend
Inherits ChartNamedElement
- Наследование
Комментарии
Класс 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) |
Инициализирует новый экземпляр класса с указанным именем условных Legend обозначений. |
Свойства
| Имя | Описание |
|---|---|
| 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) |