.. highlightlang:: us

.. index:: LayerGetProps

.. _layergetprops:

LayerGetProps
=============

.. us.tag  LayerGetProps ENGLISH LayerGet New5800

:ref:`LayerGetProps` gets the font properties.

.. function::  o = LayerGetProps(hFont)

.. us.return

**Return Value**

*o*

**layer**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - layer
     - 
   * - name
     - string
     - 
     - 
   * - @atts_xy_width_height
     - 
     - 
     - 
   * - background
     - bool
     - 0
     - 
   * - @atts_background
     - 
     - 
     - 
   * - @atts_pen
     - 
     - 
     - 
   * - @atts_misc
     - 
     - 
     - 
   * - flags
     - @flags
     - 
     - 
   * - dia-type
     - int
     - 1
     - 3d:0, 2d:1, waterfall:2, polar:3
   * - link
     - string
     - 
     - 
   * - @atts_waterfall
     - 
     - 
     - if dia-type == 2
   * - @atts_polar
     - 
     - 
     - if dia-type == 3
   * - @atts_3d
     - 
     - 
     - if dia-type == 0
   * - %x-axes
     - %axis
     - 
     - 
   * - %y-axes
     - %axis
     - 
     - 
   * - %z-axes
     - %axis
     - 
     - 

**atts_xy_width_height**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * -  x               
     - double
     - 1.0
     -  x position in cm or diagram coordinates
   * -  y               
     - double
     - -1.0
     -  
   * -  width           
     - double
     - 1.0
     -  
   * -  height          
     - double
     - 1.0
     - 

**atts_background**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - bkmode
     - @bkmode
     - transparent
     -  opaque:0  transparent:1
   * - gradient
     - bool
     - 0
     - 
   * - gradient-colors
     - @color
     - white grey
     - 
   * - fill-color
     - @color
     - black
     - 

**atts_pen**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - stroke-type
     - int
     - 0
     - 
   * - stroke-width
     - int
     - 1
     - 
   * - stroke-color
     - @color
     - black
     - 

**atts_misc**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - shadow
     - bool
     - 0
     - 
   * - shadow-width
     - double
     - 20
     - 
   * - round-rect
     - bool
     - 0
     - 
   * - radius
     - double
     - 0.3
     - 
   * - show-edge
     - bool
     - 0
     - 

**atts_waterfall**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - waterfall-closebox
     - bool
     - 
     - 
   * - waterfall-frontgrid
     - bool
     - 
     - 
   * - waterfall-reverseorder
     - bool
     - 0
     - 
   * - waterfall-dx
     - double
     - 
     - 
   * - waterfall-dy
     - double
     - 
     - 
   * - waterfall-label-freq
     - int
     - 1
     - 
   * - waterfall-label-type
     - int 
     - 1
     - 

**atts_polar**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - polar-rad-label-opaque
     - bool
     - 
     - 
   * - polar-angle-label-opaque
     - bool
     - 
     - 
   * - polar-angle-label-gradient
     - bool
     - 
     - 
   * - polar-clockwise
     - bool
     - 
     - 
   * - polar-draw-to-center-freq
     - int
     - 
     - 
   * - polar-draw-to-center-offset-major
     - int
     - 
     - 
   * - polar-draw-to-center-offset-minor
     - int
     - 
     - 
   * - polar-min-radius
     - double
     - 
     - 
   * - polar-angle-offset
     - double
     - 
     - 

**atts_3d**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - view-3d-box
     - bool
     - 1
     - missing in program
   * - view-3d-distance
     - double
     - 1
     - 
   * - view-3d-elevation
     - double
     - 45
     - 
   * - view-3d-rotation
     - double
     - 135
     - 
   * - view-3d-box-ratio
     - string
     - 100 100 100
     - list { xsd:double, xsd:double, xsd:double}

**axis**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - 
     - 
   * - axis-scale-type
     - int
     - 0
     - 0:linear, 1: log, … 7: 360 grad
   * - axis-descending
     - int
     - 0
     - 
   * - min
     - double
     - 0
     - 
   * - max
     - double
     - 100
     - 
   * - delta
     - double
     - 10
     - 
   * - axis-link
     - string
     - 
     - 
   * - pos
     - int
     - 0
     - 
   * - rel-pos
     - double
     - 0
     - 
   * - @atts_ticks
     - 
     - 
     - 
   * - @atts_grid
     - 
     - 
     - 
   * - @atts_label_font
     - 
     - 
     - 
   * - label
     - bool
     - 1
     - 
   * - label-format
     - int
     - 1
     - 
   * - title
     - bool
     - 1
     - 
   * - min-line
     - bool
     - 1
     - 
   * - max-line
     - bool
     - 1
     - 
   * - title-pos
     - int
     - 
     - 
   * - title-offset
     - double
     - 0
     - 
   * - axis-pen-width
     - int
     - 1
     - 
   * - %text
     - %text-box
     - 
     - 

**atts_ticks**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - tick-major-len
     - double
     - 0
     - in cm
   * - tick-major-width
     - int
     - 0
     - In 0.1 mm
   * - tick-minor-len
     - double
     - 0
     - 
   * - tick-minor-width
     - int
     - 0
     - 
   * - tick-pos
     - int
     - 0
     - 
   * - tick-minor-count
     - int
     - 0
     - 
   * - tick-count
     - int
     - 0
     - 

**atts_grid**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - grid-major
     - bool
     - 1
     - 
   * - grid-minor
     - bool
     - 1
     - 
   * - grid-major-pen-type
     - int
     - 0
     - 
   * - grid-major-pen-width
     - int
     - 1
     - 
   * - grid-major-pen-color
     - @color
     - black
     - 
   * - grid-minor-pen-type
     - int
     - 0
     - 
   * - grid-minor-pen-width
     - int
     - 1
     - 
   * - grid-minor-pen-color
     - @color
     - black
     - 

**atts_label_font**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - label-font-face-name
     - string
     - Arial
     - 
   * - label-font-size
     - int
     - 10
     - 
   * - label-font-weight
     - int
     - 400
     - 
   * - label-font-italic
     - int
     - 0
     - 
   * - label-font-underline
     - int
     - 0
     - 
   * - label-font-strikeout
     - int
     - 0
     - 
   * - label-font-color
     - @color
     - black
     - 
   * - label-font-pitch-and-family
     - int
     - 32
     - 

**text-box**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - text-box
     - 
   * - name
     - string
     -        
     -  Object name
   * - @atts_xy_width_height
     - 
     - 
     - 
   * - @atts_pen
     - 
     - 
     - 
   * - flags
     - @flags
     - 
     - 
   * - @atts_misc
     - 
     - 
     - 
   * - @atts_background
     - 
     - 
     - 
   * - halign
     - @halign 
     - center 
     - Horizontal alignment: left, center (default), right
   * - valign
     - @valign
     - middle
     - Top:8 middle:16 bottom:32
   * - angle
     - double  
     - 0
     - 
   * - edge-dist
     - double  
     - 0
     - 
   * - auto-size
     - double  
     - 0
     - 
   * - word-wrap
     - bool
     - 0
     - 
   * - clip-text
     - bool
     - 0
     - 
   * - text
     - string
     - 
     - 
   * - %font
     - %font
     - 
     - 

**font**

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Default Value
     - Comment
   * - type
     - string
     - font
     - 
   * - face-name
     - string
     - Arial
     - 
   * - size
     - int
     - 9
     - 
   * - weight
     - int
     - 400
     - 
   * - italic
     - bool
     - 0
     - 
   * - underline
     - bool
     - 0
     - 
   * - strike-out
     - bool
     - 0
     - 
   * - color
     - @color
     - black
     - 
   * - pitch-and-family
     - int
     - 34
     - 

.. us.params

**Parameters**

.. uparam:: hFont

   Identifies the font.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2016.0
     - New.

.. seealso::
   :ref:`overview-text-objects`,
   :ref:`TBCreate`,
   :ref:`TBSetProps`,
   :ref:`ObjSetProps`

:sub:`id-1944876`