new LayerOptions()
Every option of the LayerOptions type has associated a property of the Layer object. For instance, the option:
back {string}, specifies the background image of the layer or the color to fill the layer's areais associated with the property:
Back {string}, specifies the background image of the layer or the color to fill the layer's areawhich means that the following statements are equivalent:
oLayer.Options = {back: "gauge_back"}where oLayer is an object of Layer type
oLayer.SetOptions({back: "gauge_back"})
oLayer.Back = "gauge_back"
oLayer.SetBack("gauge_back")
- Since:
- 5.4
Members
(static) back :any
The back field is mapped to the Back property, which means that the following statements are equivalent:
oLayer.Options = {back: "gauge_back"}
oLayer.SetOptions({back: "gauge_back"})
oLayer.Back = "gauge_back"
oLayer.SetBack("gauge_back")
Type:
- any
Example
null {any}, no background is shown for the layer
"gauge_back" {string}, if there is a HTML picture with name "gauge_back", the layer's background is that HTML picture
"red" {string}, if there is no HTML picture with name "red", but "red" is a valid CSS color, the layer's background is filled with red color
back
(static) brightness :LayerColorAdjustmentOptions
The brightness field is mapped to the Brightness property, which means that the following statements are equivalent:
oLayer.Options = {brightness: {red: "value", green: "value"}}
oLayer.SetOptions({brightness: {red: "value", green: "value"}})
oLayer.Brightness = {red: "value", green: "value"}
oLayer.SetBrightness({red: "value", green: "value"})
Type:
Example
{red: "value", green: "value", blue: "value"} {object}, complete darkness to full brightness as the layer's value increases from 0 to 100
{red: "value/2", green: "value/2", blue: "value/2"} {object}, the brightness of the layer is half of layer's value
{red: 0, green: 0, blue: 0} {object}, the layer is completely dark regardless of its value
brightness
(static) clip :LayerClipOptions
The clip field is mapped to the Clip property, which means that the following statements are equivalent:
oLayer.Options = {clip: {type: "ellipse", radiusX: 50, radiusY: 50}}
oLayer.SetOptions({clip: {type: "ellipse", radiusX: 50, radiusY: 50}})
oLayer.Clip = {type: "ellipse", radiusX: 50, radiusY: 50}
oLayer.SetClip({type: "ellipse", radiusX: 50, radiusY: 50})
Type:
Example
null {null}, there is no clipping region and the whole layer is visible
{type: "ellipse", radiusX: 50, radiusY: 50} {object}, the layer is clipped to a circle with a radius of 50 pixels
clip
(static) contrast :LayerColorAdjustmentOptions
The contrast field is mapped to the Contrast property, which means that the following statements are equivalent:
oLayer.Options = {contrast: {red: "value", green: "value"}}
oLayer.SetOptions({contrast: {red: "value", green: "value"}})
oLayer.Contrast = {red: "value", green: "value"}
oLayer.SetContrast({red: "value", green: "value"})
Type:
Example
{red: "value", green: "value", blue: "value"} {object}, complete gray to full contrast as the layer's value increases from 0 to 100
{red: "value/2", green: "value/2", blue: "value/2"} {object}, the contrast of the layer is half of layer's value
{red: 0, green: 0, blue: 0} {object}, the layer is completely gray regardless of its value
contrast
(static) defaultOffsetX :number
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The defaultOffsetX field is mapped to the DefaultOffsetX property, which means that the following statements are equivalent:
oLayer.Options = {defaultOffsetX: 10}
oLayer.SetOptions({defaultOffsetX: 10})
oLayer.DefaultOffsetX = 10
oLayer.SetDefaultOffsetX(10)
Type:
- number
Example
0 {number}, the layer is shown at the position specified by the left and offsetX fields
10 {number}, the layer is shown with a total x-offset of 10 pixels from the position specified by the left field
defaultOffsetX
(static) defaultOffsetY :number
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The defaultOffsetY field is mapped to the DefaultOffsetY property, which means that the following statements are equivalent:
oLayer.Options = {defaultOffsetY: 10}
oLayer.SetOptions({defaultOffsetY: 10})
oLayer.DefaultOffsetY = 10
oLayer.SetDefaultOffsetY(10)
Type:
- number
Example
0 {number}, the layer is shown at the position specified by the top and offsetY fields
10 {number}, the layer is shown with a total y-offset of 10 pixels from the position specified by the top field
defaultOffsetY
(static) defaultRotateAngle :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The defaultRotateAngle field is mapped to the DefaultRotateAngle property, which means that the following statements are equivalent:
oLayer.Options = {defaultRotateAngle: -90}
oLayer.SetOptions({defaultRotateAngle: -90})
oLayer.DefaultRotateAngle = -90
oLayer.SetDefaultRotateAngle(-90)
Type:
- number
Example
0 {number}, no rotation applied to the layer
-90 {number}, the layer is rotated 90 degrees counter-clockwise
90 {number}, the layer is rotated 90 degrees clockwise
defaultRotateAngle
(static) fore :string
The expression supports the following keywords:
"value", gets the value of the Layer.Value property
The fore field is mapped to the Fore property, which means that the following statements are equivalent:
oLayer.Options = {fore: "value + ` km/h`"}
oLayer.SetOptions({fore: "value + ` km/h`"})
oLayer.Fore = "value + ` km/h`"
oLayer.SetFore("value + ` km/h`")
Type:
- string
Example
null or "" {string}, the layer's caption is not shown on the layer's foreground
"value" {string}, the layer's caption is the value of the layer
"`<outline white><b><font ;20>` + (value format `0`)" {string}, shows the layer's value formatted as integer with white outlined bold font of size 20
fore
(static) foreOpt :LayerForeOptions
The foreOpt field is mapped to the ForeOpt property, which means that the following statements are equivalent:
oLayer.Options = {foreOpt: {tfi: "Arial 20", front: false}}
oLayer.SetOptions({foreOpt: {tfi: "Arial 20", front: false}})
oLayer.ForeOpt = {tfi: "Arial 20", front: false}
oLayer.SetForeOpt({tfi: "Arial 20", front: false})
Type:
- Since:
- 5.4
Example
null {any}, the layer's caption is shown on the layer's foreground with the default formatting options
{tfi: "<fgcolor red> Arial 20", front: false} {object}, the layer's caption is shown with red color Arial font of size 20, behind the layer's background
{formatText: "wrap"} {object}, the layer's caption is shown with text wrapped within the layer's area
foreOpt
(static) grayscale :number|string
The expression supports the following keywords:
"value", indicates the Layer.Value property of the layer, which is the value displayed by the layer and can be linked to the layer's rotation angle or offset though the rotateAngleToValue, offsetToValue fields, so when the layer is rotated or moved, its value changes accordingly.
The grayscale field is mapped to the Grayscale property, which means that the following statements are equivalent:
oLayer.Options = {grayscale: "value/2"}
oLayer.SetOptions({grayscale: "value/2"})
oLayer.Grayscale = "value/2"
oLayer.SetGrayscale("value/2")
Type:
- number | string
Example
50 {number}, the layer is displayed with 50% grayscale regardless of its value
"value/2" {string}, the grayscale level of the layer is half of its value
"100 - value" {string}, the grayscale level of the layer decreases as its value increases
grayscale
(static) height :number|string
The expression supports the following keywords:
"width", indicates the width of the control
"height", indicates the height of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The height field is mapped to the Layer.Height property, which means that the following statements are equivalent:
oLayer.Options = {height: "height/2"}
oLayer.SetOptions({height: "height/2"})
oLayer.Height = "height/2"
oLayer.SetHeight("height/2")
Type:
- number | string
Example
"" {string} or {null} or {undefined}, the layer is shown with its original width and height
12 {number}, the layer is shown with a height of 12 pixels
"height/2" {string}, the layer is shown with a height of half of the control's height
height
(static) idem :any
The idem field is mapped to the Idem property, which means that the following statements are equivalent:
oLayer.Options = {idem: "knob,knob2"}
oLayer.SetOptions({idem: "knob,knob2"})
oLayer.Idem = "knob,knob2"
oLayer.SetIdem("knob,knob2")
Type:
- any
Example
null or "" {string}, the layer is not idem with any other layer
"knob,knob2" {string}, the knob,knob2 layers share the same offset and rotation-angle
idem
(static) key
The key field is mapped to the Key property, which means that the following statements are equivalent:
oLayer.Options = {key: "needle"}
oLayer.SetOptions({key: "needle"})
oLayer.Key = "needle"
oLayer.SetKey("needle")
Example
null or "" {string}, the layer has no key
"needle" {string}, the layer's key is "needle"
key
(static) left :number|string
The expression supports the following keywords:
"width", indicates the width of the control
"height", indicates the height of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The left field is mapped to the Layer.Left property, which means that the following statements are equivalent:
oLayer.Options = {left: "width/2"}
oLayer.SetOptions({left: "width/2"})
oLayer.Left = "width/2"
oLayer.SetLeft("width/2")
Type:
- number | string
Example
"0" or "" {string} or {null} or {undefined}, the layer is shown at the position specified by the offsetX field from the left edge of the control.
"width/2+10" {string}, the layer is shown at the horizontal center of the control, plus 10 pixels and any additional x-offset specified in defaultOffsetX and offsetX fields
left
(static) offsetToValue :number|string
The expression supports the following keywords:
"value", "x" or "offsetx", indicates the Layer.OffsetX property
"y" or "offsety", indicates the Layer.OffsetY property
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The offsetToValue field is mapped to the OffsetToValue property, which means that the following statements are equivalent:
oLayer.Options = {offsetToValue: "x/2 + 4"}
oLayer.SetOptions({offsetToValue: "x/2 + 4"})
oLayer.OffsetToValue = "x/2 + 4"
oLayer.SetOffsetToValue("x/2 + 4")
Type:
- number | string
Example
0 {number}, the value is always 0 regardless of the offsetX and offsetY fields
"x/2 + 4" {string}, converts the current x-offset to a value by dividing the x-offset by 2 and then adding 4
"value = 0 ? 0 : 1" {string}, converts the current x-offset to a value of 0 if the x-offset is 0 or 1 if the x-offset is not 0
offsetToValue
(static) offsetX :number
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The offsetX field is mapped to the Layer.OffsetX property, which means that the following statements are equivalent:
oLayer.Options = {offsetX: 10}
oLayer.SetOptions({offsetX: 10})
oLayer.OffsetX = 10
oLayer.SetOffsetX(10)
Type:
- number
Example
0 {number}, the layer is shown at the position specified by the left and defaultOffsetX fields
10 {number}, the layer is shown with a total x-offset of 10 pixels from the position specified by the left and defaultOffsetX fields
offsetX
(static) offsetXValid :number|string
The expression supports the following keywords:
"value", specifies the x-offset/y-offset of the layer, or 0 if not specified
"x", specifies the x-offset of the layer, equivalent of Layer.OffsetX property
"y", specifies the y-offset of the layer, equivalent of Layer.OffsetY property
"lwidth" specifies the width in pixels of the layer's view
"lheight", specifies the height in pixels of the layer's view
"width" specifies the width in pixels of the control
"height", specifies the height in pixels of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The offsetXValid field is mapped to the OffsetXValid property, which means that the following statements are equivalent:
oLayer.Options = {offsetXValid: "value MIN 0 MAX 48"}
oLayer.SetOptions({offsetXValid: "value MIN 0 MAX 48"})
oLayer.OffsetXValid = "value MIN 0 MAX 48"
oLayer.SetOffsetXValid("value MIN 0 MAX 48")
Type:
- number | string
Example
"" {string} or {null} or {undefined}, the offsetX field is not validated (offsetXValid field is ignored)
0 {number}, the offsetX field is alwyays 0
"x MIN 0 MAX 48" {string}, the offsetX field is validated to be between 0 and 48 pixels
"round(x/8)*8" {string}, the offsetX field is spanned to the closest multiple of 8 pixels
offsetXValid
(static) offsetY :number
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The offsetY field is mapped to the Layer.OffsetY property, which means that the following statements are equivalent:
oLayer.Options = {offsetY: 10}
oLayer.SetOptions({offsetY: 10})
oLayer.OffsetY = 10
oLayer.SetOffsetY(10)
Type:
- number
Example
0 {number}, the layer is shown at the position specified by the top and defaultOffsetY fields
10 {number}, the layer is shown with a total y-offset of 10 pixels from the position specified by the top and defaultOffsetY fields
offsetY
(static) offsetYValid :number|string
The expression supports the following keywords:
"value", specifies the x-offset/y-offset of the layer, or 0 if not specified
"x", specifies the x-offset of the layer, equivalent of Layer.OffsetX property
"y", specifies the y-offset of the layer, equivalent of Layer.OffsetY property
"lwidth" specifies the width in pixels of the layer's view
"lheight", specifies the height in pixels of the layer's view
"width" specifies the width in pixels of the control
"height", specifies the height in pixels of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The offsetYValid field is mapped to the OffsetYValid property, which means that the following statements are equivalent:
oLayer.Options = {offsetYValid: "value MIN 0 MAX 48"}
oLayer.SetOptions({offsetYValid: "value MIN 0 MAX 48"})
oLayer.OffsetYValid = "value MIN 0 MAX 48"
oLayer.SetOffsetYValid("value MIN 0 MAX 48")
Type:
- number | string
Example
"" {string} or {null} or {undefined}, the offsetY field is not validated (offsetYValid field is ignored)
0 {number}, the offsetY field is alwyays 0
"y MIN 0 MAX 48" {string}, the offsetY field is validated to be between 0 and 48 pixels
"round(y/8)*8" {string}, the offsetY field is spanned to the closest multiple of 8 pixels
offsetYValid
(static) onDrag :Gauge.OnDragLayerEnum
- exDoMove, the layer is moved according to the mouse movement once the user drags it, so the offsetX and offsetY fields of the layer are changed according to the mouse movement, while the rotateAngle field is not changed once the user drags the layer.
- exDoRotate, the layer is rotated according to the mouse movement once the user drags it, so the rotateAngle field of the layer is changed according to the mouse movement, while the offsetX and offsetY fields are not changed once the user drags the layer.
- exDoRotamove, the layer is moved by rotation according to the mouse movement once the user drags it, but only rotateAngle field of the layer is changed according to the mouse movement once the user drags the layer.
The selectable field must be true for the onDrag field to have effect, which means that the user can move or rotate the layer by dragging it only if the onDrag field is set and the selectable field is true. By default, the onDrag field is null (equivalent of exDoNothing), which means that the layer is not dragged (the user cannot move or rotate the layer by dragging it).
The onDrag field is mapped to the OnDrag property, which means that the following statements are equivalent:
oLayer.Options = {onDrag: "rotate"}
oLayer.SetOptions({onDrag: "rotate"})
oLayer.OnDrag = "rotate"
oLayer.SetOnDrag("rotate")
Type:
Example
null {any}, the layer is not dragged (the user cannot move or rotate the layer by dragging it)
"move" {string}, 1 {number} or exontrol.Gauge.OnDragLayerEnum.exDoMove {Gauge.OnDragLayerEnum}, the layer is moved according to the mouse movement once the user drags it
onDrag
(static) position :number
The position field is mapped to the Position property, which means that the following statements are equivalent:
oLayer.Options = {position: 0}
oLayer.SetOptions({position: 0})
oLayer.Position = 0
oLayer.SetPosition(0)
Type:
- number
Example
0 {number}, the layer is the bottom layer, which is drawn first
1 {number}, the layer is drawn over the layer with position 0
position
(static) rotamoveCenterX :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotamoveCenterX field is mapped to the RotamoveCenterX property, which means that the following statements are equivalent:
oLayer.Options.rotamoveCenterX
oLayer.GetOptions().rotamoveCenterX
oLayer.RotamoveCenterX
oLayer.GetRotamoveCenterX()
Type:
- number
(static) rotamoveCenterY :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotamoveCenterY field is mapped to the RotamoveCenterY property, which means that the following statements are equivalent:
oLayer.Options.rotamoveCenterY
oLayer.GetOptions().rotamoveCenterY
oLayer.RotamoveCenterY
oLayer.GetRotamoveCenterY()
Type:
- number
(static) rotamoveOffsetX :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotamoveOffsetX field is mapped to the RotamoveOffsetX property, which means that the following statements are equivalent:
oLayer.Options.rotamoveOffsetX
oLayer.GetOptions().rotamoveOffsetX
oLayer.RotamoveOffsetX
oLayer.GetRotamoveOffsetX()
Type:
- number
(static) rotamoveOffsetY :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotamoveOffsetY field is mapped to the RotamoveOffsetY property, which means that the following statements are equivalent:
oLayer.Options.rotamoveOffsetY
oLayer.GetOptions().rotamoveOffsetY
oLayer.RotamoveOffsetY
oLayer.GetRotamoveOffsetY()
Type:
- number
(static) rotateAngle :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotateAngle field is mapped to the RotateAngle property, which means that the following statements are equivalent:
oLayer.Options = {rotateAngle: 90}
oLayer.SetOptions({rotateAngle: 90})
oLayer.RotateAngle = 90
oLayer.SetRotateAngle(90)
Type:
- number
Example
0 {number}, no rotation applied to the layer
90 {number}, the layer is rotated 90 degrees clockwise
-90 {number}, the layer is rotated 90 degrees counter-clockwise
rotateAngle
(static) rotateAngleToValue :string
The expression supports the following keywords:
"value", indicates the value of the Layer.RotateAngle property. Angle 0 is considered the 12 o'clock direction, and it increases clockwise, so 90 degrees is considered the 3 o'clock direction, 180 degrees the 6 o'clock direction, and 270 degrees (or -90 degrees) the 9 o'clock direction.
The rotateAngleToValue field is mapped to the RotateAngleToValue property, which means that the following statements are equivalent:
oLayer.Options = {rotateAngleToValue: "value*180/100"}
oLayer.SetOptions({rotateAngleToValue: "value*180/100"})
oLayer.RotateAngleToValue = "value*180/100"
oLayer.SetRotateAngleToValue("value*180/100")
Type:
- string
Example
"value/180*100" {string}, when the layer's rotation angle is 180 degrees, its value becomes 100
"value/360*100" {string}, when the layer's rotation angle is 90 degrees, its value becomes 25
"value >= 270 ? (value - 270)/90*50 : (value/90)*50 + 50", {string} wraps and remaps angles into a 0 - 100 range
rotateAngleToValue
(static) rotateAngleValid :string
The expression supports the following keywords:
"value", indicates the value of the Layer.RotateAngle property. Angle 0 is considered the 12 o'clock direction, and it increases clockwise, so 90 degrees is considered the 3 o'clock direction, 180 degrees the 6 o'clock direction, and 270 degrees (or -90 degrees) the 9 o'clock direction.
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotateAngleValid field is mapped to the RotateAngleValid property, which means that the following statements are equivalent:
oLayer.Options = {rotateAngleValid: "value >= 0 && value <= 180"}
oLayer.SetOptions({rotateAngleValid: "value >= 0 && value <= 180"})
oLayer.RotateAngleValid = "value >= 0 && value <= 180"
oLayer.SetRotateAngleValid("value >= 0 && value <= 180")
Type:
- string
Example
"round(value/5)*5" {string}, snaps the rotation angle of the layer to multiples of 5 degrees
"value < 90 ? value : (value < 180 ? 90 : (value < 270 ? 270 : value))" {string}, limits the rotation angle between -90 (270) to 90 degrees
rotateAngleValid
(static) rotateCenterLayer :number
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotateCenterLayer field is mapped to the RotateCenterLayer property, which means that the following statements are equivalent:
oLayer.Options = {rotateCenterLayer: -1}
oLayer.SetOptions({rotateCenterLayer: -1})
oLayer.RotateCenterLayer = -1
oLayer.SetRotateCenterLayer(-1)
Type:
- number
Example
-1 {number}, the layer is rotated around the center specified by the rotateCenterX and rotateCenterY fields of itself
0 {number}, the layer is rotated around the center specified by the rotateCenterX and rotateCenterY fields of the layer with index 0, which is usually the background layer (default value)
1 {number}, the layer is rotated around the center specified by the rotateCenterX and rotateCenterY fields of the layer with index 1
rotateCenterLayer
(static) rotateCenterX :string
The expression of the rotateCenterX and rotateCenterY fields supports the following keywords:
"lwidth", indicates the width in pixels of the layer
"width", specifies the width in pixels of the view / control
"lheight", indicates the height in pixels of the layer
"height", specifies the height in pixels of the view / control
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotateCenterX field is mapped to the RotateCenterX property, which means that the following statements are equivalent:
oLayer.Options = {rotateCenterX: "lwidth/2 + 78"}
oLayer.SetOptions({rotateCenterX: "lwidth/2 + 78"})
oLayer.RotateCenterX = "lwidth/2 + 78"
oLayer.SetRotateCenterX("lwidth/2 + 78")
Type:
- string
Example
"" {string}, the rotation center is determined by the rotateCenterLayer layer's center (default value)
"lwidth/2 + 16" {string}, the x-origin of the rotation point is 16 pixels to the right of the center of the layer specified in the rotateCenterLayer field
rotateCenterX
(static) rotateCenterY :string
The expression of the rotateCenterX and rotateCenterY fields supports the following keywords:
"lwidth", indicates the width in pixels of the layer
"width", specifies the width in pixels of the view / control
"lheight", indicates the height in pixels of the layer
"height", specifies the height in pixels of the view / control
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The rotateCenterY field is mapped to the RotateCenterY property, which means that the following statements are equivalent:
oLayer.Options = {rotateCenterY: "lheight/2 + 78"}
oLayer.SetOptions({rotateCenterY: "lheight/2 + 78"})
oLayer.RotateCenterY = "lheight/2 + 78"
oLayer.SetRotateCenterY("lheight/2 + 78")
Type:
- string
Example
"" {string}, the rotation center is determined by the rotateCenterLayer layer's center (default value)
"lheight/2 + 16" {string}, the y-origin of the rotation point is 16 pixels below the center of the layer specified in the rotateCenterLayer field
rotateCenterY
(static) rotateClip :boolean
The following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The rotateClip field is mapped to the RotateClip property, which means that the following statements are equivalent:
oLayer.Options = {rotateClip: true}
oLayer.SetOptions({rotateClip: true})
oLayer.RotateClip = true
oLayer.SetRotateClip(true)
Type:
- boolean
Example
true {boolean}, the layer's clipping region is rotated together with the layer
false {boolean}, the layer's clipping region is not rotated with the layer
rotateClip
(static) selectable :boolean
The selectable field is mapped to the Selectable property, which means that the following statements are equivalent:
oLayer.Options = {selectable: false}
oLayer.SetOptions({selectable: false})
oLayer.Selectable = false
oLayer.SetSelectable(false)
Type:
- boolean
Example
true {boolean}, the layer is selectable (the user can move or rotate it if the onDrag field is set)
false {boolean}, the layer is un-selectable (the user cannot move or rotate it even if the onDrag field is set)
selectable
(static) top :number|string
The expression supports the following keywords:
"width", indicates the width of the control
"height", indicates the height of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The top field is mapped to the Layer.Top property, which means that the following statements are equivalent:
oLayer.Options = {top: "height/2"}
oLayer.SetOptions({top: "height/2"})
oLayer.Top = "height/2"
oLayer.SetTop("height/2")
Type:
- number | string
Example
"0" or "" {string} or {null} or {undefined}, the layer is shown at the position specified by the offsetY field from the top edge of the control.
"height/2+10" {string}, the layer is shown at the vertical center of the control, plus 10 pixels and any additional y-offset specified in defaultOffsetY and offsetY fields
top
(static) transparency :number|string
The expression supports the following keywords:
"value", indicates the Layer.Value property of the layer, which is the value displayed by the layer and can be linked to the layer's rotation angle or offset though the rotateAngleToValue, offsetToValue fields, so when the layer is rotated or moved, its value changes accordingly.
The transparency field is mapped to the Transparency property, which means that the following statements are equivalent:
oLayer.Options = {transparency: "value/2"}
oLayer.SetOptions({transparency: "value/2"})
oLayer.Transparency = "value/2"
oLayer.SetTransparency("value/2")
Type:
- number | string
Example
50 {number}, the layer is displayed with 50% transparency regardless of its value
"value/2" {string}, the transparency of the layer is half of its value
"100 - value" {string}, the transparency of the layer decreases as its value increases
transparency
(static) value :number
For instance:
- the control displays a clock, the value could be the current-time
- the control shows a switch, so the value could indicate the state of the switch
- the control shows a thermometer, so the value could be the current temperature
- the control displays a gauge, so the value could be the value on the gauge pointed by the needle
The onchange event occurs when the Layer.Value property is changed. During the onchange event, you can change values of other layers as well. For instance, if the second-hand of the clock is rotated, you can rotate the hour and the minute-hands of the clock as well.
The value field indicates the "value" keyword in the following properties:
- valueToOffsetX field, specifies the format-expression to convert the value to x-offset. The offsetX field is the result of evaluating the valueToOffsetX field expression, while the onDrag field is exDoMove. The offsetToValue field converts the current offset to a value.
- valueToOffsetY field, specifies the format-expression to convert the value to y-offset. The offsetY field is the result of evaluating the valueToOffsetY field expression, while the onDrag field is exDoMove. The offsetToValue converts the current offset to a value.
- valueToRotateAngle field, specifies the format-expression to convert the value to rotating angle. The rotateAngle field is the result of evaluating the valueToRotateAngle field expression, while the onDrag field is exDoRotate or exDoRotamove. The rotateAngleToValue field converts the current rotation angle to a value.
The value field works in association with the layer's OnDrag property like follows:
- If the onDrag field is exDoMove, evaluating the valueToOffsetX field indicates the layer's offsetX field.
- If the onDrag field is exDoMove, evaluating the valueToOffsetY field indicates the layer's offsetY field.
- If the onDrag field is exDoRotate or exDoRotamove, evaluating the valueToRotateAngle field indicates the layer's rotateAngle field.
The value field is mapped to the Layer.Value property, which means that the following statements are equivalent:
oLayer.Options = {value: 50}
oLayer.SetOptions({value: 50})
oLayer.Value = 50
oLayer.SetValue(50)
Type:
- number
Example
0 {number}, the value of the layer is 0
50 {number}, the value of the layer is 50
value
(static) valueToOffsetX :number|string
The expression supports the following keywords:
"value", gets the value the Layer.Value property returns
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The valueToOffsetX field is mapped to the ValueToOffsetX property, which means that the following statements are equivalent:
oLayer.Options = {valueToOffsetX: "value*2"}
oLayer.SetOptions({valueToOffsetX: "value*2"})
oLayer.ValueToOffsetX = "value*2"
oLayer.SetValueToOffsetX("value*2")
Type:
- number | string
Example
0 {number}, sets the x-offset to 0 pixels regardless of the value field
"value=0 ? 0 : 48" {string}, sets the x-offset to 0 pixels if the value is 0 or 48 pixels if the value is not 0
valueToOffsetX
(static) valueToOffsetY :number|string
The expression supports the following keywords:
"value", gets the value the Layer.Value property returns
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The valueToOffsetY field is mapped to the ValueToOffsetY property, which means that the following statements are equivalent:
oLayer.Options = {valueToOffsetY: "value*2"}
oLayer.SetOptions({valueToOffsetY: "value*2"})
oLayer.ValueToOffsetY = "value*2"
oLayer.SetValueToOffsetY("value*2")
Type:
- number | string
Example
0 {number}, sets the y-offset to 0 pixels regardless of the value field
"value=0 ? 0 : 48" {string}, sets the y-offset to 0 pixels if the value is 0 or 48 pixels if the value is not 0
valueToOffsetY
(static) valueToRotateAngle :string
The expression supports the following keywords:
"value", indicates the value of the Layer.Value property
Any of the following fields can be used to rotate the layer:
- defaultRotateAngle field, specifies the default angle to rotate the layer
- rotateAngle field, specifies the angle to rotate the layer.
- rotateAngleValid field, validates / limits the rotation angle of the layer.
- value and valueToRotateAngle fields, specifies the expression to convert the value to rotating angle. The rotateAngleToValue field converts the current rotation angle to a value.
The following fields can be used to specify a different rotation center:
- rotateCenterLayer field, indicates the index of the layer the rotation is around.
- rotateCenterX field, indicates the expression that determines the x-origin of the rotation point relative to the rotateCenterLayer layer.
- rotateCenterY field, indicates the expression that determines the y-origin of the rotation point relative to the rotateCenterLayer layer.
The following fields can be used to change the rotation center, while the onDrag field is exDoRotamove:
- rotamoveCenterX field, gets the x-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveCenterY field, gets the y-coordinate of the background content's center (back field), indicating the horizontal position of the visual center of the actual content, not the full image.
- rotamoveOffsetX field, gets the x-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate..
- rotamoveOffsetY field, gets the y-offset of the layer's center point during rotation when the layer's onDrag field is set to exDoRotamove or exDoRotate.
The valueToRotateAngle field is mapped to the ValueToRotateAngle property, which means that the following statements are equivalent:
oLayer.Options = {valueToRotateAngle: "value/100*180"}
oLayer.SetOptions({valueToRotateAngle: "value/100*180"})
oLayer.ValueToRotateAngle = "value/100*180"
oLayer.SetValueToRotateAngle("value/100*180")
Type:
- string
Example
"value/100*180" {string}, when the layer's value is 25, it is rotated 45 degrees
"value/100*360" {string}, when the layer's value is 25, it is rotated 90 degrees
"value < 50 ? (270 + value/50*90) : (value - 50)/50 * 90", {string} wraps and remaps values into a 0 - 360 range
valueToRotateAngle
(static) visible :boolean
The visible field is mapped to the Visible property, which means that the following statements are equivalent:
oLayer.Options = {visible: false}
oLayer.SetOptions({visible: false})
oLayer.Visible = false
oLayer.SetVisible(false)
Type:
- boolean
Example
true {boolean}, the layer is visible and drawn on the control
false {boolean}, the layer is hidden and not drawn on the control
visible
(static) width :number|string
The expression supports the following keywords:
"width", indicates the width of the control
"height", indicates the height of the control
Any of the following fields can be used to move the layer:
- defaultOffsetX and defaultOffsetY fields, indicates the default x- and y-offset of the layer
- offsetX and offsetY fields, indicates additional x- and y-offset of the layer
- offsetXValid and offsetYValid fields, validates / limits the x- and y-offset value of the layer
- value, valueToOffsetX and valueToOffsetY fields, specifies the format-expression to convert the value to x- and y-offset. The offsetToValue field converts the current x- and y-offset to a value.
Any of the following fields can be used to move or resize the layer:
- left and top fields, specifies the format-expression relative to the view, to determine the x- and y-position to show the current layer on the control
- width and height fields, specifies the format-expression relative to the view, to determine the width and height to show the current layer on the control
The width field is mapped to the Layer.Width property, which means that the following statements are equivalent:
oLayer.Options = {width: "width/2"}
oLayer.SetOptions({width: "width/2"})
oLayer.Width = "width/2"
oLayer.SetWidth("width/2")
Type:
- number | string
Example
"" {string} or {null} or {undefined}, the layer is shown with its original width and height
12 {number}, the layer is shown with a width of 12 pixels
"width/2" {string}, the layer is shown with a width of half of the control's width
width