# legend_properties

Descrição das propriedades da entidade Legend (legenda)

## Descrição

A entidade Legend é uma folha na hierarquia de entidade gráficas. Esta entidade define parâmetros para legendas impressas abaixo de gráficos `plot2dx` ou criadas pela função captions. Para cada linha esboçada, a legenda exibe uma amostra do tipo da linha, de sua marca e de sua cor.

parent:

  esta propriedade contém o manipulador da raiz. A raiz de uma entidade Legends deve ser do tipo `"Compound"`. Este Compound contém também o restante das entidade gráficas.

children:

  esta propriedade contém um vetor com os galhos do manipulador. contudo, manipuladores `legend` não possuem galhos correntemente.

visible:

  este campo contém o valor da propriedade `visible` para a entidade . Pode ser `"on"` ou `"off"` . Se `"on"` a legenda é impressa, se `"off"`, a legenda não é exibida na tela.

text:

  este campo é um vetor de strings que contém as legendas para cada objeto anotado.

font_size:

  um escalar especificando o tamanho da fonte. Se a propriedade `fractional_font` for `"off"`, apenas a parte inteira é utilizada. Para mais informações veja graphics_fonts.

font_style:

  especifica a fonte utilizada para exibir os rótulos da legenda. É um inteiro positivo fazendo referência a uma das fontes carregadas. Seu valor deve estar entre 0, fazendo referência à primeira fonte, e o número de fontes caregadas menos um, fazendo referência à última fonte. Para mais informações veja graphics_fonts.

font_color

  um índice de cor, esta propriedade determina a cor do texto.

fractional_font:

  esta propriedade especifica se os textos são exibidos utilizando-se tamanhos de fonte fracionários. Seu valor deve ser `"on"` ou `"off"`. Se `"on"`, o valor em ponto flutuante de `font_size` é utilizado para a exibição e evita-se o serrilhamento da fonte. Se `"off"`, apenas a parte inteira é utilizada e a fonte não é suavizada.

links:

  um array linha de manipuladores. Eles se referem às poligonais associadas.

legend_location

  um string, especifica a localização da legenda

  - `"in_upper_right"` : as legendas são exibidas no canto superior direito da caixa de eixos.

  - `"in_upper_left"`: as legendas são exibidas no canto superior esquerdo da caixa de eixos.

  - `"in_lower_right"`: as legendas são exibidas no canto inferior direito da caixa de eixos.

  - `"in_lower_left"`: as legendas são exibidas no canto inferior esquerdo da caixa de eixos.

  - `"out_upper_right"`: as legendas são exibidas à direita do canto superior direito da caixa de eixos.

  - `"out_upper_left"`: as legendas são exibidas à esquerda do canto superior esquerdo da caixa de eixos.

  - `"out_lower_right"`: as legendas são exibidas à direita do canto inferior direito da caixa de eixos.

  - `"out_lower_left"`: as legendas são exibidas à esquerda do canto inferior esquerdo da caixa de eixos.

  - `"upper_caption"`: as legendas são exibidas acima do canto superior esquerdo da caixa de eixos.

  - `"lower_caption"`: as legendas são exibidas abaixo do canto inferior esquerdo da caixa de eixos. Esta opção corresponde ao argumento `leg` de plot2d

  - `"by_coordinates"`: o canto superior esquerdo da caixa de legendas é fornecido pelo campo "position" da estrutura de dados associada. As posições `x` e `y` são fornecidas como frações dos `axes_bounds`

position

  as coordenadas do canto superior esquerdo da legenda. As posições `x` e `y` são dadas como frações dos tamanhos `axes_bounds`. Este campo pode ser ajustado se `legend_location=="by_coordinates" ou obtido de outros ajustes de legend_location.`

line_mode

  este campo especifica se um retângulo é desenhado ao redor da legenda ou não. Deve ser `"on"` ou `"off"`. Se `"on"` , o retângulo é desenhado utilizando-se as seguintes propriedades.

thickness

  este campo fornece a espessura da linha utilizada para desenhar o retângulo.

foreground

  este campo contém o índice de cor da linha utilizada para desenhar o contorno do retângulo.

fill_mode

  este campo especifica se o plano de fundo da legenda será pintado ou não. Deve ser `"on"` ou `"off"`. Se `"on"` , o plano de fundo é pintado utilizando-se a cor definida no campo `background`.

background

  este campo contém o índice de cor da linha utilizada para pintar a área do retângulo.

clip_state:

  este campo contém o valor da propriedade `clip_state` para todos os objetos. O valor de clip_state pode ser :

  - `"off"` significa que todos os objetos criados posteriormente não são recortados. (valor padrão).

  - `"clipgrf"` significa que todos os objetos criados posteriormente são recortados fora da caixa dos eixos.

  - `"on"` significa que todos os objetos criados posteriormente são recortados fora do retângulo dado pela propriedade clip_box.

clip_box:

  este campo contém o valor padrão da propriedade `clip_box` para todos os objetos. O seu valor é uma matriz vazia se clip_state é `"off"`. Em outros casos, o recorte é dado por `[x,y,w,h]` (ponto superior esquerdo, largura, altura).

user_data:

  este campo pode ser utilizado para armazenar qualquer variável Scilab na estrutura de dados do texto e recuperá-la.

## Exemplos

    // inicialização de x
    x=[0:0.1:2*%pi]';
    plot2d(x,[sin(x) sin(2*x) sin(3*x)],[1,2,3],leg="L1@L2@L3")
    a=get("current_axes");
    l=a.children(2);
    l.links
    l.text=["sin(x)";"sin(2*x)";"sin(3*x)"];
    l.visible="off"; // invisível
    l.font_size = 2;
    l.font_style = 5;
    l.visible='on';

## Ver Também

- plot2d
- graphics_entities