Dgs-dxlabel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 11: | Line 11: | ||
Alignment of the text within the label. | Alignment of the text within the label. | ||
The functions as follows are | The functions as follows are based on this property. | ||
[[dgsLabelSetHorizontalAlign]]/[[dgsLabelGetHorizontalAlign]] | [[dgsLabelSetHorizontalAlign]]/[[dgsLabelGetHorizontalAlign]] | ||
| Line 25: | Line 25: | ||
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off. | *'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off. | ||
=== | ===colorCoded=== | ||
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]'' | Whether the color code is enabled or not. ''Learn More [[dxDrawText]]'' | ||
<syntaxhighlight lang="lua">dgsSetProperty(label," | <syntaxhighlight lang="lua">dgsSetProperty(label,"colorCoded",colorCoded)</syntaxhighlight> | ||
*''' | *'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes. | ||
===font=== | ===font=== | ||
| Line 41: | Line 41: | ||
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the label. | *'''offsetY:''' A float of the 2D Y offset of the shadow text of the label. | ||
*'''color:''' An integer of the color of the shadow text of the label. | *'''color:''' An integer of the color of the shadow text of the label. | ||
*'''outline:''' | *'''outline:''' An integer of the outline style of the shadow text. | ||
===subPixelPositioning=== | ===subPixelPositioning=== | ||
This property determines whether the '''subPixelPositioning''' is enabled or not, by default, it is | This property determines whether the '''subPixelPositioning''' is enabled or not, by default, it is disable. ''Learn More [[dxDrawText]]'' | ||
'''subPixelPositioning''' Will make positioning and resizing animation looks better, but you should know, it may | '''subPixelPositioning''' Will make positioning and resizing animation looks better, but you should know, it may blur your static text with unrounded position and size, or alignment. | ||
If you are using dgs animation library, you'd better turn this on. | |||
<syntaxhighlight lang="lua">dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)</syntaxhighlight> | ||
*'''subPixelPositioning:''' A bool indicates whether to enable subPixelPositioning or not. | *'''subPixelPositioning:''' A bool indicates whether to enable subPixelPositioning or not. | ||
| Line 59: | Line 61: | ||
<syntaxhighlight lang="lua">dgsSetProperty(label,"textColor",textColor)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(label,"textColor",textColor)</syntaxhighlight> | ||
*'''textColor:''' An integer of the color of the text of the label. | *'''textColor:''' An integer of the color of the text of the label. | ||
===textOffset=== | |||
The offset of the text on label. | |||
<syntaxhighlight lang="lua">dgsSetProperty(label,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight> | |||
*'''offsetX''' : A float of the 2D X offset relative to the position of the label, depends on '''relative'''. | |||
*'''offsetY''' : A float of the 2D Y offset relative to the position of the label, depends on '''relative'''. | |||
*'''relative''' : A bool of whether the offset is relative or absolute. | |||
===textSize=== | ===textSize=== | ||
| Line 66: | Line 75: | ||
*'''scaleY:''' A float of the 2D Y scale of the text of the label. | *'''scaleY:''' A float of the 2D Y scale of the text of the label. | ||
=== | ===wordBreak=== | ||
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]'' | Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]'' | ||
<syntaxhighlight lang="lua">dgsSetProperty(label," | <syntaxhighlight lang="lua">dgsSetProperty(label,"wordBreak",wordBreak)</syntaxhighlight> | ||
*''' | *'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line. | ||
==See Also== | ==See Also== | ||
{{DGSPROPERTIES}} | {{DGSPROPERTIES}} | ||
Latest revision as of 09:01, 14 June 2022
DGS Properties is always used to change the gui style and make it more fantastic.
This page shows the properties of dgs-dxlabel that you could use.
Main Functions
Properties
alignment
Alignment of the text within the label.
The functions as follows are based on this property.
dgsLabelSetHorizontalAlign/dgsLabelGetHorizontalAlign
dgsLabelSetVerticalAlign/dgsLabelGetVerticalAlign
dgsSetProperty(label,"alignment",{alignX,alignY})
- alignX: Horizontal alignment of the text within the label. Can be "left", "center" or "right".
- alignY: Vertical alignment of the text within the label. Can be "top", "center" or "bottom".
clip
Whether the clip property is enabled or not. Learn More dxDrawText
dgsSetProperty(label,"clip",clip)
- clip: If set to true, the parts of the text that don't fit within the bounding box will be cut off.
colorCoded
Whether the color code is enabled or not. Learn More dxDrawText
dgsSetProperty(label,"colorCoded",colorCoded)
- colorCoded: Set to true to enable embedded #FFFFFF color codes.
font
This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText
dgsSetProperty(label,"font",font)
- font: A string or a dx font element of the text font of the label.
shadow
The shadow text of the label.
dgsSetProperty(label,"shadow",{offsetX,offsetY,color,outline})
- offsetX: A float of the 2D X offset of the shadow text of the label.
- offsetY: A float of the 2D Y offset of the shadow text of the label.
- color: An integer of the color of the shadow text of the label.
- outline: An integer of the outline style of the shadow text.
subPixelPositioning
This property determines whether the subPixelPositioning is enabled or not, by default, it is disable. Learn More dxDrawText
subPixelPositioning Will make positioning and resizing animation looks better, but you should know, it may blur your static text with unrounded position and size, or alignment.
If you are using dgs animation library, you'd better turn this on.
dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)
- subPixelPositioning: A bool indicates whether to enable subPixelPositioning or not.
text
This is equivalent to dgsSetText/dgsGetText.
dgsSetProperty(label,"text",text)
- text: A string of the text of the label.
textColor
The color which can be translated by tocolor of the text of the label.
dgsSetProperty(label,"textColor",textColor)
- textColor: An integer of the color of the text of the label.
textOffset
The offset of the text on label.
dgsSetProperty(label,"textOffset",{offsetX,offsetY,relative})
- offsetX : A float of the 2D X offset relative to the position of the label, depends on relative.
- offsetY : A float of the 2D Y offset relative to the position of the label, depends on relative.
- relative : A bool of whether the offset is relative or absolute.
textSize
The scale of the text of the label. Learn More dxDrawText
dgsSetProperty(label,"textSize",{scaleX,scaleY})
- scaleX: A float of the 2D X scale of the text of the label.
- scaleY: A float of the 2D Y scale of the text of the label.
wordBreak
Whether the word-break is enabled or not. Learn More dxDrawText
dgsSetProperty(label,"wordBreak",wordBreak)
- wordBreak: If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.
See Also
General Properties
Unique Properties For DGS Core Elements
- dgs-dx3dinterface
- dgs-dx3dimage
- dgs-dx3dtext
- dgs-dx3dline
- dgs-dxbutton
- dgs-dxcheckbox
- dgs-dxcombobox
- dgs-dxdetectarea
- dgs-dxedit
- dgs-dxgridlist
- dgs-dximage
- dgs-dxlabel
- dgs-dxline
- dgs-dxmemo
- dgs-dxprogressbar
- dgs-dxradiobutton
- dgs-dxscrollbar
- dgs-dxscrollpane
- dgs-dxselector
- dgs-dxswitchbutton
- dgs-dxtabpanel
- dgs-dxtab
- dgs-dxwindow