Legend Classe

Definição

Namespace:

System.Windows.Forms.DataVisualization.Charting

Assembly:

System.Windows.Forms.DataVisualization.dll

Representa a legenda da imagem do gráfico.

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

Herança

Object

ChartElement

ChartNamedElement

Legend

Comentários

A Legend classe encapsula toda a funcionalidade da Chart legenda do controle e é exposta usando a Legends propriedade de coleção do objeto raiz Chart .

Pode haver qualquer número de legendas para uma imagem de gráfico.

As legendas podem:

• Esteja encaixado e alinhado.

• Seja exibido dentro ou fora das áreas de gráfico plotadas.

• Ajuste automaticamente seu conteúdo.

• Use um estilo predefinido, como linha, coluna ou tabela.

• Use o hatching, cores de gradiente e imagens de plano de fundo.

• Seja dimensionado e posicionado em qualquer lugar dentro da imagem do gráfico.

Os itens de legenda são representados pelo LegendItem objeto e são itens padrão ou personalizados. Os itens personalizados não estão associados aos dados e podem ser adicionados, excluídos e modificados usando a CustomItems propriedade.

Os itens padrão são adicionados automaticamente à legenda por padrão e são os nomes dos pontos de dados plotados para gráficos de rosca e pizza.

Para todos os outros tipos de gráfico, os itens padrão são os nomes da série de dados plotada. Cada série tem uma Legend propriedade que define o nome da legenda que será usada. Um item de legenda não será criado para uma série se a IsVisibleInLegend propriedade estiver definida como false. O texto desses itens padrão pode ser alterado usando a LegendText propriedade. Essa propriedade permitirá que você especifique palavras-chave predefinidas que serão substituídas por seus valores apropriados em tempo de execução.

Se você tiver um gráfico de pizza e definir a Label propriedade, ele também definirá o texto da legenda como o valor definido para os rótulos. Se você quiser definir o texto como um valor diferente, poderá definir a LegendText propriedade. Na maioria dos casos, você gostaria de definir a LegendText propriedade como "#AXISLABEL" ou "#VALX".

Os símbolos da série de legendas são retângulos, ponto ou linhas. O tipo de símbolo é definido automaticamente pelo gráfico e depende do tipo de gráfico plotado.

O texto da legenda por padrão é dimensionado automaticamente. Você pode desabilitar o dimensionamento automático do texto da legenda desabilitando a IsTextAutoFit propriedade. Quando essa propriedade é definida como false, o tamanho do texto da legenda é determinado pela propriedade Size da legenda Font. Se a IsTextAutoFit propriedade estiver habilitada, a AutoFitMinFontSize propriedade determinará o tamanho mínimo da fonte que um item de legenda pode ter ao redimensionar.

A TextWrapThreshold propriedade define um limite no número de caracteres que podem ser mostrados em uma linha antes que o texto seja encapsulado para outra linha. Se você não quiser encapsular o texto na legenda, defina o valor da TextWrapThreshold propriedade como zero. Por padrão, quando todo o texto da legenda não se ajustar na legenda, o texto será truncado. Você pode definir a TextWrapThreshold legenda para que o texto seja encapsulado em vez de ser truncado.

Se o conteúdo da legenda não puder caber no espaço especificado, as entradas de legenda serão truncadas. Uma reticências é mostrada para indicar que há mais entradas do que a legenda tem espaço para. Para impedir que os itens de legenda sejam truncados, defina a posição e o tamanho da legenda usando a Position propriedade. Ao definir a posição ou o tamanho da legenda, o gráfico não pode mais posicionar automaticamente os elementos no gráfico. Em alguns casos, muitos precisam posicionar manualmente outros elementos do gráfico para alcançar a aparência desejada.

Outra opção seria definir suas próprias colunas de célula em vez de usar as configurações de legenda padrão.

O Legend objeto tem uma Coleção CellColumn; cada objeto CellColumn representa uma coluna na Legenda. Uma coluna de célula tem MaximumWidth e MinimumWidth propriedades que podem ser usadas para ajustar o tamanho das colunas.

Quando a legenda contém muitas entradas, InterlacedRows pode ser usada para melhorar a legibilidade. Quando essa propriedade for definida como True, ela exibirá uma cor de fundo que você pode definir usando a InterlacedRowsColor propriedade.

Por padrão, a legenda é posicionada no canto superior direito do gráfico. Essa posição pode ser modificada usando a e Alignment as Docking propriedades da legenda. A legenda também pode ser associada a uma área de gráfico usando a DockedToChartArea propriedade. Essa propriedade especifica o nome da área do gráfico para a qual a legenda deve ser encaixada. Além disso, a IsDockedInsideChartArea propriedade pode ser usada para exibir a legenda dentro de uma área de gráfico.

Quando IsDockedInsideChartArea é definida como False, a MaximumAutoSize propriedade define o tamanho máximo, em porcentagem, da legenda dentro do gráfico disponível quando a legenda é posicionada automaticamente. Essa propriedade deve ser definida se você quiser ajustar a largura ou a altura da legenda depois que as propriedades de encaixe tiverem sido definidas.

A legenda pode ser modificada usando o CustomizeLegend evento.

Construtores

Nome	Description
Legend()	Inicializa uma nova instância da classe Legend.
Legend(String)	Inicializa uma nova instância da Legend classe com o nome da legenda especificado.

Propriedades

Nome	Description
Alignment	Obtém ou define o alinhamento da legenda.
AutoFitMinFontSize	Obtém ou define o tamanho mínimo da fonte que pode ser usado pelo algoritmo de dimensionamento automático para o texto da legenda.
BackColor	Obtém ou define a cor da tela de fundo de uma legenda.
BackGradientStyle	Obtém ou define a orientação para o gradiente de plano de fundo de uma legenda. Também determina se um gradiente é usado.
BackHatchStyle	Obtém ou define o estilo de criação de uma legenda.
BackImage	Obtém ou define a imagem de plano de fundo de uma legenda.
BackImageAlignment	Obtém ou define o alinhamento da imagem de plano de fundo usado para o Unscaled modo de desenho.
BackImageTransparentColor	Obtém ou define uma cor que será substituída por uma cor transparente quando a imagem de plano de fundo for desenhada.
BackImageWrapMode	Obtém ou define o modo de desenho de imagem de plano de fundo da legenda.
BackSecondaryColor	Obtém ou define a cor secundária de um plano de fundo de legenda.
BorderColor	Obtém ou define a cor da borda de uma legenda.
BorderDashStyle	Obtém ou define o estilo de borda de uma legenda.
BorderWidth	Obtém ou define a largura da borda de uma legenda.
CellColumns	Obtém o LegendCellColumnCollection objeto que contém a coleção de colunas de célula para uma legenda.
CustomItems	Obtém um LegendItemsCollection objeto usado para itens de legenda personalizados.
DockedToChartArea	Obtém ou define o nome do ChartArea local em que a legenda será encaixada.
Docking	Obtém ou define um valor que determina se a legenda está encaixada.
Enabled	Obtém ou define um valor que indica se a legenda está habilitada.
Font	Obtém ou define um Font objeto, que é usado para definir propriedades de fonte da legenda.
ForeColor	Obtém ou define a cor do texto da legenda.
HeaderSeparator	Obtém ou define o tipo de separador visual para o cabeçalho da legenda.
HeaderSeparatorColor	Obtém ou define a cor do separador para o cabeçalho da legenda.
InsideChartArea	Obtém ou define o nome da área do gráfico na qual a legenda é desenhada.
InterlacedRows	Obtém ou define um sinalizador que indica se as linhas de legenda serão desenhadas com a cor da tela de fundo entrelaçada.
InterlacedRowsColor	Obtém ou define a cor da tela de fundo das linhas entrelaçadas da legenda.
IsDockedInsideChartArea	Obtém ou define um sinalizador que indica se a legenda está encaixada dentro ou fora da área do gráfico.
IsEquallySpacedItems	Obtém ou define um sinalizador que indica se todos os itens de legenda estão espaçados igualmente.
IsTextAutoFit	Obtém ou define um sinalizador que indica se o texto da legenda é dimensionado automaticamente.
ItemColumnSeparator	Obtém ou define o tipo de separador visual para as colunas da tabela de legendas.
ItemColumnSeparatorColor	Obtém ou define a cor do separador da coluna da tabela de legendas.
ItemColumnSpacing	Obtém ou define o espaçamento da coluna da tabela de legendas.
LegendItemOrder	Obtém ou define um valor que especifica a ordem na qual os itens de legenda são exibidos. Essa propriedade afeta apenas os itens de legenda adicionados automaticamente para a série de gráficos; ele não tem efeito sobre itens de legenda personalizados.
LegendStyle	Obtém ou define o estilo da legenda.
MaximumAutoSize	Obtém ou define o tamanho máximo da legenda, medido como um percentual da área do gráfico. Esse valor é usado pelo algoritmo de layout automático.
Name	Obtém ou define o nome da legenda.
Position	Obtém ou define um ElementPosition objeto, que pode ser usado para obter ou definir a posição da legenda.
ShadowColor	Obtém ou define a cor da sombra da legenda.
ShadowOffset	Obtém ou define o deslocamento de sombra, em pixels, da legenda.
TableStyle	Obtém ou define o estilo da tabela de legendas.
Tag	Obtém ou define um objeto associado a esse elemento de gráfico. (Herdado de ChartElement)
TextWrapThreshold	Obtém ou define o número de caracteres que podem ser exibidos sequencialmente na legenda antes que o texto seja encapsulado.
Title	Obtém ou define o texto do título da legenda.
TitleAlignment	Obtém ou define o alinhamento do título da legenda.
TitleBackColor	Obtém ou define a cor da tela de fundo do título da legenda.
TitleFont	Obtém ou define a fonte do título da legenda.
TitleForeColor	Obtém ou define a cor do texto do título da legenda.
TitleSeparator	Obtém ou define o tipo de separador visual para o título da legenda.
TitleSeparatorColor	Obtém ou define a cor do separador de título da legenda.

Métodos

Nome	Description
Dispose()	Libera os recursos usados pelo ChartElement. (Herdado de ChartElement)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo Legend e, opcionalmente, libera os recursos gerenciados.
Equals(Object)	Determina se o especificado Object é igual ao atual ChartElement. (Herdado de ChartElement)
GetHashCode()	Retorna uma função de hash para um tipo específico. (Herdado de ChartElement)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o atual Object. (Herdado de ChartElement)