* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) INRIA - Djalel Abdemouche
* Copyright (C) 2010 - DIGITEO - Manuel Juliachs
- *
* Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
*
* This file is hereby licensed under the terms of the GNU GPL v2.0,
* pursuant to article 5.3.4 of the CeCILL v.2.1.
* along with this program.
*
-->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="label_properties">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
+ xml:lang="en" xml:id="label_properties">
<refnamediv>
<refname>Label entity properties</refname>
- <refpurpose>description of the Label entity properties
+ <refpurpose>
+ Properties of Axes labels and title
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>
- The Label entity is a child of an <literal>Axes</literal> entity. When an
- Axes entity is built, the Title and Labels handles come with it and are
- part of the Axes properties. Therefore, the properties of those
- sub-objects are editable via the Axes handle (see <literal>gca</literal> and
- <literal>gda</literal>). Also note that Label entities cannot be directly deleted.
- This entity defines the parameters for label
- drawing:
+ Label entities are used as <literal>Axes.x_label</literal>,
+ <literal>Axes.y_label</literal>, <literal>Axes.z_label</literal>, and
+ <literal>Axes.title</literal> coumpound properties.
+ They are therefore addressed through any Axes handle as for instance returned by
+ <literal>gca()</literal>. <literal>gda()</literal> settings allow to define
+ the default values of their properties.
+ </para>
+ <warning>
+ Label entities cannot be directly deleted.
+ </warning>
+ <para>
+ Their properties are the following:
</para>
<variablelist>
<varlistentry>
<term>parent: </term>
<listitem>
- <para>This property contains the handle of the parent. The parent of the
- label entity should be of type <literal>"Axes"</literal> .
- </para>
- <para>Note that, for now, Label entity is exclusively used in
- <literal>title</literal>, <literal>x_label</literal>, <literal>y_label</literal> and
- <literal>z_label</literal> building.
+ <para>
+ Handle of the parent Axes.
</para>
</listitem>
</varlistentry>
<term>visible: </term>
<listitem>
<para>
- This field contains the <literal>visible</literal> property value for
- the entity . It should be <literal>"on" </literal> or <literal>"off"</literal> .By
- default, the label is visible, the value's property is
- <literal>"on"</literal>. If <literal>"off"</literal> the label is not displayed on
- the screen.
+ "on" | "off".
+ If <literal>"off"</literal> the label (and its box) still exists but is not
+ displayed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>text: </term>
<listitem>
- <para>The matrix containing the strings of the object. The rows of the
- matrix are displayed horizontally and the columns vertically.
- </para>
<para>
- Starting from Scilab 5.2, it is possible to write <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>.
+ Matrix of texts of the label. So, a label can have multiple rows or/and
+ columns of text. Leading and trailing blanks are trimmed.
+ In their columns, texts are left-justified.
+ <link linkend="math_rendering_features_in_graphic">LaTeX expressions</link>
+ delimited with "$...$" are supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>font_foreground: </term>
<listitem>
- <para>This field contains the color used to display the label
- <literal>text</literal>. Its value should be a color index (relative to the
- current colormap).
+ <para>
+ Color used to display the <literal>.text</literal> of the label.
+ It is specified by its index in the current colormap (or -1 for black,
+ -2 for white)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>foreground: </term>
<listitem>
- <para>This field contains the color used to display the line around the
- box if any. Its value should be a color index (relative to the current
- colormap).
+ <para>
+ Color used to display the border of the box surrounding the block of
+ <literal>.text</literal>, if any. It is specified by its index in the current
+ colormap, or -1 for black or -2 for white.
+ It is ignored if <literal>.fill_mode="off"</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>background: </term>
<listitem>
- <para>This field contains the color used to fill the box if any. Its
- value should be a color index (relative to the current colormap).
+ <para>
+ Color used to fill the box surrounding the block of <literal>text</literal>,
+ if any. It is specified by its index in the current colormap, or -1 for
+ black or -2 for white.
+ It is ignored if <literal>.fill_mode="off"</literal>.
</para>
</listitem>
</varlistentry>
<term>fill_mode: </term>
<listitem>
<para>
- This field takes the values <literal>"on"</literal> or
- <literal>"off"</literal>. If <literal>"on"</literal> a box is draw around the text
- with a line on its edge and a background.
+ This is actually a "box mode" property. <literal>"on"</literal> draws a box
+ around the block of text of the label. Otherwise, no block's edge is drawn.
+ The <literal>.foreground</literal> value is the color's index of the edge.
+ The <literal>.background</literal> value is the index of the filling color.
</para>
</listitem>
</varlistentry>
<term>font_style: </term>
<listitem>
<para>
- Specifies the font used to display the label.
- This is a positive integer referecing one of the loaded fonts.
- Its value must be between 0, referecing the first font,
- and the number of loaded fonts minus one, referencing the last font.
- For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
+ Integer id ≥ 0 identifying the font used to display the label, among loaded
+ ones. = rank of the font in the vector listed with
+ <link linkend="xlfont">xlfont()'</link>, - 1.
+ For more information, see <link linkend="graphics_fonts">graphics_fonts</link>.
</para>
</listitem>
</varlistentry>
<term>font_size: </term>
<listitem>
<para>
- It is a scalar specifying the displayed characters size.
- If <literal>fractional_font</literal> property is <literal>"off"</literal>
- only the integer part of the value is used.
+ Scalar positive number specifying the size of displayed characters.
+ If <literal>.fractional_font</literal> property is <literal>"off"</literal>
+ only the integer part of the <literal>.font_size</literal>value is used.
For more information see <link linkend="graphics_fonts">graphics_fonts</link>.
</para>
</listitem>
<term>fractional_font: </term>
<listitem>
<para>
- This property specify whether text is displayed using fractional font sizes.
- Its value must be either <literal>"on"</literal> or <literal>"off"</literal>.
- If <literal>"on"</literal> the floating point value of <literal>font_size</literal>
- is used for display and the font is anti-aliased. If <literal>"off"</literal> only the integer part is used
- and the font is not smoothed.
+ "on" |"off". When it is "off", only the integer part of the
+ <literal>.font_size</literal> is considered. When it is "on", the font
+ is scaled and the display of the text is anti-aliased (smoothed).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>font_angle: </term>
<listitem>
- <para>This scalar allows you to turn the label. The font is turned
- clockise with the angle given in degrees. Note that changing the
- <literal>font_angle</literal> will automatically disable the
- <literal>auto_rotation</literal> property.
+ <para>
+ Clockwise angle of the label's block, in degrees, horizontal = 0°.
+ The lower-left corner of the horizontal box is used as pivot (fixed point).
+ Setting <literal>.font_angle</literal> automatically sets
+ <literal>.auto_rotation="off"</literal>.
</para>
</listitem>
</varlistentry>
<term>auto_rotation: </term>
<listitem>
<para>
- If <literal>"on"</literal>, Scilab computes automatically the best angle
- to turn the label for the display. If <literal>"off"</literal>, the label
- can be manually turned with the <literal>font_angle</literal> property.
+ If <literal>"on"</literal>, Scilab sets automatically the best label's
+ orientation.
+ Then the <literal>.font_angle</literal> value is not taken into account.
+ If <literal>"off"</literal>, the orientation is set according to the
+ <literal>.font_angle</literal> value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>position: </term>
<listitem>
- <para>This 2d vector allows you to place manually the label on the
- screen. The position is stored in the data units of the axes. Note
- that changing the <literal>font_angle</literal> will automatically disable
- the <literal>auto_position</literal> property.
+ <para>
+ Vector of coordinates of the label's anchor, in data unit.
+ The anchor is the lower-left corner of the horizontal box of the label.
+ Setting the <literal>.position</literal> automatically sets
+ <literal>.auto_position="off"</literal>.
</para>
</listitem>
</varlistentry>
<term>auto_position: </term>
<listitem>
<para>
- If <literal>"on"</literal>, Scilab computes automatically the best
- position in the graphic window for the display. If <literal>"off"</literal>,
- the label can be manually places with the <literal>position</literal>
- property.
+ If <literal>"on"</literal>, Scilab sets automatically the best label's
+ position. If <literal>"off"</literal>, the value of the
+ <literal>.position</literal> property is used.
</para>
</listitem>
</varlistentry>
x_label.font_style= 5;
a.y_label.foreground = 12;
-// Starting with Scilab 5.2, it is now possible to write LaTeX or MathML:
-t.text="$\sqrt{SCILAB}$";
+// Labels written in LaTeX or MathML can be used:
+t.text = "$\sqrt{SCILAB}$";
x_label.font_size= 5;
-x_label.text="<mrow><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mo></mo><mfenced open=""{"" close=""}""> ..
-<mrow><mfrac><mrow><mfrac><mrow><mi>a</mi></mrow><mrow><mi>b</mi></mrow></mfrac></mrow><mrow><mfrac><mrow><mi>c</mi></mrow><mrow><mi>d</mi></mrow>..
-</mfrac></mrow></mfrac></mrow></mfenced></mrow>"
+x_label.text="<mrow><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mo></mo><mfenced open=""{"" close=""}"">" + ...
+"<mrow><mfrac><mrow><mfrac><mrow><mi>a</mi></mrow><mrow><mi>b</mi></mrow></mfrac></mrow><mrow><mfrac><mrow><mi>c</mi></mrow><mrow><mi>d</mi></mrow>" + ...
+"</mfrac></mrow></mfrac></mrow></mfenced></mrow>"
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See also</title>
<simplelist type="inline">
<member>
- <link linkend="set">set</link>
+ <link linkend="xlabel">xlabel ylabel zlabel</link>
</member>
<member>
- <link linkend="get">get</link>
+ <link linkend="xtitle">xtitle</link>
</member>
<member>
- <link linkend="delete">delete</link>
+ <link linkend="title">title</link>
</member>
<member>
- <link linkend="xtitle">xtitle</link>
+ <link linkend="xstring">xstring</link>
</member>
<member>
- <link linkend="graphics_entities">graphics_entities</link>
+ <link linkend="xlfont">xlfont</link>
</member>
<member>
- <link linkend="axes_properties">axes_properties</link>
+ <link linkend="color">color</link>
+ </member>
+ <member>
+ <link linkend="set">set</link>
</member>
<member>
<link linkend="text_properties">text_properties</link>
</member>
+ <member>
+ <link linkend="axes_properties">axes_properties</link>
+ </member>
</simplelist>
</refsection>
+ <refsection role="history">
+ <title>History</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.2</revnumber>
+ <revdescription>
+ LaTeX expressions delimited with "$..$" are now supported
+ </revdescription>
+ </revision>
+ </revhistory>
+ </refsection>
</refentry>
<?xml version="1.0" encoding="UTF-8"?>
-
<!--
-
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-
* Copyright (C) INRIA - Djalel Abdemouche
-
* Copyright (C) 2010 - DIGITEO - Manuel Juliachs
-
- *
-
-
* Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
*
* This file is hereby licensed under the terms of the GNU GPL v2.0,
* pursuant to article 5.3.4 of the CeCILL v.2.1.
* and continues to be available under such terms.
* For more information, see the COPYING file which you should have received
* along with this program.
-
*
-
-->
-
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="label_properties">
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
+ xml:lang="ja" xml:id="label_properties">
<refnamediv>
-
<refname>label_properties</refname>
-
<refpurpose>Labelエンティティプロパティの説明
-
</refpurpose>
-
</refnamediv>
-
<refsection>
-
<title>説明</title>
-
<para>
-
Labelエンティティは<literal>Axes</literal>エンティティの子です.
-
Axesエンティティが構築された時,
-
TitleおよびLabelsのハンドルはAxesプロパティの一部として組み込まれます.
-
このため、これらのサブオブジェクトのプロパティはAxesハンドル経由で編集可能です
-
(<literal>gca</literal> および <literal>gda</literal>参照).
-
Labelエンティティを直接削除することはできないことにも注意してください.
-
このエンティティは描画するラベルに関する以下のパラメータを定義します:
-
</para>
-
<variablelist>
-
<varlistentry>
-
<term>parent: </term>
-
<listitem>
-
<para>このエンティティは親のハンドルを有します.
-
labelエンティティの親は<literal>"Axes"</literal>型です.
-
</para>
-
<para>現時点でLabelエンティティは
-
<literal>title</literal>, <literal>x_label</literal>, <literal>y_label</literal> および
-
<literal>z_label</literal> を構築する際に排他的に使用されていることに
-
注意してください.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>visible: </term>
-
<listitem>
-
<para>
-
このフィールドはエンティティの<literal>visible</literal>プロパティを有します.
-
この値は<literal>"on" </literal> または <literal>"off"</literal>です.
-
デフォルトでラベルは可視であり,このプロパティの値は<literal>"on"</literal>です.
-
<literal>"off"</literal>の場合,ラベルは画面に表示されません.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>text: </term>
-
<listitem>
-
- <para>オブジェクトの文字列を有する行列.行列の行は水平に表示され,列は垂直に表示されます.
-
- </para>
-
<para>
-
- Scilab 5.2以降, <link linkend="math_rendering_features_in_graphic">LaTeX または MathML 式</link>を書くことが可能です.
-
+ オブジェクトの文字列を有する行列.行列の行は水平に表示され,列は垂直に表示されます.
+ A label can have multiple rows or/and
+ columns of text. Leading and trailing blanks are trimmed.
+ In their columns, texts are left-justified.
+ <link linkend="math_rendering_features_in_graphic">LaTeX expressions</link>
+ delimited with "$...$" are supported.
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>font_foreground: </term>
-
<listitem>
-
<para>
-
このフィールドはラベル<literal>text</literal>を表示する際に使用される色を
-
有します.色のインデックスは(カレントのカラーマップに基づく)色インデックス
-
である必要があります.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>foreground: </term>
-
<listitem>
-
<para>このフィールドはボックスの周りに線を表示する際に使用される色を
-
有します.この値は(カレントのカラーマップに基づく)色インデックス
-
である必要があります.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>background: </term>
-
<listitem>
-
<para>このフィールドはボックスを塗る際に使用される色を
-
有します.この値は(カレントのカラーマップに基づく)色インデックス
-
である必要があります.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>fill_mode: </term>
-
<listitem>
-
<para>
-
このフィールドは<literal>"on"</literal>または
-
<literal>"off"</literal>を値とします.
-
<literal>"on"</literal> の場合, テキストの周囲に縁に線があるボックスと
-
背景が描画されます.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>font_style: </term>
-
<listitem>
-
<para>
-
ラベルの表示に使用されるフォントを指定します.
-
これはロード済みのフォントの一つを指す正の整数です.
-
その値は最初のフォントを指す 0 から最後のフォントを指すロード済みの
-
フォントの数から1を引いた数までとします.
-
詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>font_size: </term>
-
<listitem>
-
<para>
-
表示される文字の大きさを指定するスカラー値です.
-
<literal>fractional_font</literal>プロファイルが <literal>"off"</literal>の場合,
-
値の整数部のみが使用されます.
-
詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>fractional_font: </term>
-
<listitem>
-
<para>このプロパティはテキストを分数のフォントサイズにより表示するかどうかを
-
指定します.この値には,<literal>"on"</literal> または <literal>"off"</literal>を指定します.
-
<literal>"on"</literal> の場合,<literal>font_size</literal>の浮動小数点の値が
-
表示の際に使用され,フォントはアンチエイリアス処理されます.
-
<literal>"off"</literal> の場合,整数部のみが使用され,フォントは平滑化されません.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>font_angle: </term>
-
<listitem>
-
- <para>このスカラー値によりラベルを回転させることができます.
-
- フォントは度を単位として指定した角度で時計回りに回転されます.
-
- <literal>font_angle</literal>を変更すると
-
- <literal>auto_rotation</literal>プロパティが自動的に無効となる
-
- ことに注意してください.
-
+ <para>
+ Clockwise angle of the label's block, in degrees, horizontal = 0°.
+ The lower-left corner of the horizontal box is used as pivot (fixed point).
+ Setting <literal>font_angle</literal> automatically sets
+ <literal>auto_rotation="off"</literal>.
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>auto_rotation: </term>
-
<listitem>
-
<para>
-
<literal>"on"</literal>の場合, Scilab は表示の際に
-
最良のラベル回転角を自動的に計算します.
-
<literal>"off"</literal>の場合, ラベルは<literal>font_angle</literal> プロパティにより
-
マニュアルで回転できます.
-
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>position: </term>
-
<listitem>
-
- <para>この2次元ベクトルにより画面上にラベルをマニュアルで配置できます.
-
- 位置は軸のデータユニットに保存されます.
-
- <literal>font_angle</literal>を変更すると
-
- <literal>auto_position</literal>プロパティが自動的に無効となる
-
- ことに注意してください.
-
+ <para>
+ Vector of coordinates of the label's anchor, in data unit.
+ The anchor is the lower-left corner of the horizontal box of the label.
+ Setting the <literal>position</literal> automatically sets
+ <literal>auto_position="off"</literal>.
</para>
-
</listitem>
-
</varlistentry>
-
<varlistentry>
-
<term>auto_position: </term>
-
<listitem>
-
<para>
-
<literal>"on"</literal>の場合, Scilab は
-
表示の際にグラフィックウインドウにおける最良の位置を自動的に計算します.
-
<literal>"off"</literal>の場合,<literal>position</literal>プロパティにより
-
マニュアルで配置可能です.
-
</para>
-
</listitem>
-
</varlistentry>
-
</variablelist>
-
</refsection>
-
<refsection>
-
<title>例</title>
-
<programlisting role="example"><![CDATA[
-
a=get("current_axes");
-
a.title
-
type(a.title)
-
plot3d()
-
a.x_label
-
a.y_label
-
a.z_label
-
xtitle("My title","my x axis label", "Volume","Month")
-
-
t=a.title;
-
t.foreground=9;
-
t.font_size=4;
-
t.font_style=5;
-
t.text="SCILAB";
-
-
x_label=a.x_label;
-
x_label.text=" Weight"
-
x_label.font_style= 5;
-
a.y_label.foreground = 12;
-
-
-// Scilab 5.2以降, LaTeX または MathML式を書くことができます:
-
+// LaTeX または MathML式を書くことができます:
t.text="$\sqrt{SCILAB}$";
-
x_label.font_size= 5;
-
-x_label.text="<mrow><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mo></mo><mfenced open=""{"" close=""}""> ..
-
-<mrow><mfrac><mrow><mfrac><mrow><mi>a</mi></mrow><mrow><mi>b</mi></mrow></mfrac></mrow><mrow><mfrac><mrow><mi>c</mi></mrow><mrow><mi>d</mi></mrow>..
-
-</mfrac></mrow></mfrac></mrow></mfenced></mrow>"
-
+x_label.text="<mrow><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mo></mo><mfenced open=""{"" close=""}"">" + ...
+"<mrow><mfrac><mrow><mfrac><mrow><mi>a</mi></mrow><mrow><mi>b</mi></mrow></mfrac></mrow><mrow><mfrac><mrow><mi>c</mi></mrow><mrow><mi>d</mi></mrow>" + ...
+"</mfrac></mrow></mfrac></mrow></mfenced></mrow>"
]]></programlisting>
-
</refsection>
-
<refsection role="see also">
-
<title>参照</title>
-
<simplelist type="inline">
-
<member>
-
- <link linkend="set">set</link>
-
+ <link linkend="xlabel">xlabel ylabel zlabel</link>
</member>
-
<member>
-
- <link linkend="get">get</link>
-
+ <link linkend="xtitle">xtitle</link>
</member>
-
<member>
-
- <link linkend="delete">delete</link>
-
+ <link linkend="title">title</link>
</member>
-
<member>
-
- <link linkend="xtitle">xtitle</link>
-
+ <link linkend="xstring">xstring</link>
</member>
-
<member>
-
- <link linkend="graphics_entities">graphics_entities</link>
-
+ <link linkend="xlfont">xlfont</link>
</member>
-
<member>
-
- <link linkend="axes_properties">axes_properties</link>
-
+ <link linkend="color">color</link>
+ </member>
+ <member>
+ <link linkend="set">set</link>
</member>
-
<member>
-
<link linkend="text_properties">text_properties</link>
-
</member>
-
+ <member>
+ <link linkend="axes_properties">axes_properties</link>
+ </member>
</simplelist>
-
</refsection>
-
-</refentry>
-
+ <refsection role="history">
+ <title>履歴</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.2</revnumber>
+ <revdescription>
+ LaTeX expressions delimited with "$..$" are now supported
+ </revdescription>
+ </revision>
+ </revhistory>
+ </refsection>
+</refentry>
\ No newline at end of file
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) INRIA - Djalel Abdemouche
- *
* Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
*
* This file is hereby licensed under the terms of the GNU GPL v2.0,
* pursuant to article 5.3.4 of the CeCILL v.2.1.
* along with this program.
*
-->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="label_properties" xml:lang="pt">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
+ xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+ xmlns:scilab="http://www.scilab.org" xml:id="label_properties" xml:lang="pt">
<refnamediv>
<refname>label_properties</refname>
<refpurpose>Descrição de propriedades da entidade Label
<varlistentry>
<term>text:</term>
<listitem>
- <para>a matriz contendo os strings do objeto. As linhas da matriz
- são exibidas horizontalmente e as colunas verticalmente.
+ <para>
+ Matrix of texts of the label. So, a label can have multiple rows or/and
+ columns of text. Leading and trailing blanks are trimmed.
+ In their columns, texts are left-justified.
+ <link linkend="math_rendering_features_in_graphic">LaTeX expressions</link>
+ delimited with "$...$" are supported.
</para>
</listitem>
</varlistentry>
<term>font_foreground:</term>
<listitem>
<para>este campo contém o índice de cor utilizado para exibir o
- rótulo <literal>text</literal>. Seu valor deve ser um índice de cor
+ rótulo <literal>.text</literal>. Seu valor deve ser um índice de cor
(relativo ao mapa de cores corrente).
</para>
</listitem>
<term>fill_mode:</term>
<listitem>
<para>
- este campo toma valores <literal>"on"</literal> ou
- <literal>"off"</literal>. Se <literal>"on"</literal> uma caixa é
- desenhada ao redor do texto com uma linha em sua borda e um plano de
- fundo.
+ This is actually a "box mode" property. <literal>"on"</literal> draws a box
+ around the block of text of the label. Otherwise, no block's edge is drawn.
+ The <literal>.foreground</literal> value is the color's index of the edge.
+ The <literal>.background</literal> value is the index of the filling color.
</para>
</listitem>
</varlistentry>
inteiro positivo fazendo referência uma das fontes carregadas. Seu
valor deve estar entre 0, fazendo referência à primeira fonte, e o
número de fontes carregadas menos um, fazendo referência à última
- fonte. Para mais informações, veja <link linkend="graphics_fonts">graphics_fonts</link>.
+ fonte. Para mais informações, veja
+ <link linkend="graphics_fonts">graphics_fonts</link>.
</para>
</listitem>
</varlistentry>
<term>font_size:</term>
<listitem>
<para>é um escalar especificando o tamanho dos caracteres exibidos.
- Se a propriedade <literal>fractional_font</literal> for
+ Se a propriedade <literal>.fractional_font</literal> for
<literal>"off"</literal>, apenas a parte inteira é utilizada. Para
mais informações, veja <link linkend="graphics_fonts">graphics_fonts</link>.
</para>
utilizando-se tamanhos de fonte fracionários. Seu valor deve ser
<literal>"on"</literal> ou <literal>"off"</literal>. Se
<literal>"on"</literal>, o valor em ponto flutuante de
- <literal>font_size</literal> é utilizado para a exibição e evita-se
+ <literal>.font_size</literal> é utilizado para a exibição e evita-se
o serrilhamento da fonte. Se <literal>"off"</literal>, apenas a
parte inteira é utilizada e a fonte não é suavizada.
</para>
<varlistentry>
<term>font_angle:</term>
<listitem>
- <para>um escalar que permite girar o rótulo. A fonte é girada em
- sentido horário em um ângulo dado em graus. Note que mudar
- <literal>font_angle</literal> desabilitará automaticamente a
- propriedade <literal>auto_rotation</literal>.
+ <para>
+ Clockwise angle of the label's block, in degrees, horizontal = 0°.
+ The lower-left corner of the horizontal box is used as pivot (fixed point).
+ Setting <literal>.font_angle</literal> automatically sets
+ <literal>.auto_rotation="off"</literal>.
</para>
</listitem>
</varlistentry>
se <literal>"on"</literal>, o Scilab computa automaticamente o
melhor ângulo de rotação para a exibição do rótulo. Se
<literal>"off"</literal>, o rótulo pode ser girado manualmente
- através da propriedade <literal>font_angle</literal>.
+ através da propriedade <literal>.font_angle</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>position:</term>
<listitem>
- <para>este vetor 2d permite posicionar o rótulo na tela. A posição é
- armazenada em unidades de dados dos eixos. Note que mudar
- <literal>font_angle</literal> desabilitará automaticamente a
- propriedade <literal>auto_position</literal>.
+ <para>
+ Vector of coordinates of the label's anchor, in data unit.
+ The anchor is the lower-left corner of the horizontal box of the label.
+ Setting the <literal>.position</literal> automatically sets
+ <literal>.auto_position="off"</literal>.
</para>
</listitem>
</varlistentry>
se <literal>"on"</literal>, o Scilab computa automaticamente a
melhor posição para a exibição do rótulo na janela de gráficos. Se
<literal>"off"</literal>, o rótulo pode ser posicionado manualmente
- através da propriedade <literal>position</literal>.
+ através da propriedade <literal>.position</literal>.
</para>
</listitem>
</varlistentry>
<title>Ver Também</title>
<simplelist type="inline">
<member>
- <link linkend="set">set</link>
+ <link linkend="xlabel">xlabel ylabel zlabel</link>
</member>
<member>
- <link linkend="get">get</link>
+ <link linkend="xtitle">xtitle</link>
</member>
<member>
- <link linkend="delete">delete</link>
+ <link linkend="title">title</link>
</member>
<member>
- <link linkend="xtitle">xtitle</link>
+ <link linkend="xstring">xstring</link>
</member>
<member>
- <link linkend="graphics_entities">graphics_entities</link>
+ <link linkend="xlfont">xlfont</link>
</member>
<member>
- <link linkend="axes_properties">axes_properties</link>
+ <link linkend="color">color</link>
+ </member>
+ <member>
+ <link linkend="set">set</link>
</member>
<member>
<link linkend="text_properties">text_properties</link>
</member>
+ <member>
+ <link linkend="axes_properties">axes_properties</link>
+ </member>
</simplelist>
</refsection>
+ <refsection role="history">
+ <title>Histórico</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.2</revnumber>
+ <revdescription>
+ LaTeX expressions delimited with "$..$" are now supported
+ </revdescription>
+ </revision>
+ </revhistory>
+ </refsection>
</refentry>
projects / scilab.git / commitdiff