new LayerClip(oLayer)
The LayerClip object defines the clipping the layer can apply to.
Parameters:
| Name | Type | Description |
|---|---|---|
oLayer |
Layer | Specifies the layer |
Methods
GetCenterX() → {string}
The GetCenterX() method indicates the x-position / expression of the center of the clip, relative to the layer (equivalent of layers's [clip.xCenter] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the x-position / expression of the center of the clip, relative to the layer.
- Type
- string
GetCenterY() → {string}
The GetCenterY() method indicates the y-position / expression of the center of the clip, relative to the layer (equivalent of layers's [clip.yCenter] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the y-position / expression of the center of the clip, relative to the layer.
- Type
- string
GetHeight() → {string}
The GetHeight() method indicates the height value / expression of the clip, relative to the layer (equivalent of layers's [clip.height] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the height value / expression of the clip, relative to the layer.
- Type
- string
GetLeft() → {string}
The GetLeft() method indicates the left position / expression of the clip, relative to the layer (equivalent of layers's [clip.left] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the left position / expression of the clip, relative to the layer.
- Type
- string
GetOffsetX() → {string}
The GetOffsetX() method indicates the x-offset expression / value of the clip, relative to the layer (equivalent of layers's [clip.x] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the x-offset expression / value of the clip, relative to the layer.
- Type
- string
GetOffsetY() → {string}
The GetOffsetY() method indicates the y-offset expression / value of the clip, relative to the layer (equivalent of layers's [clip.y] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the y-offset expression / value of the clip, relative to the layer.
- Type
- string
GetRadiusX() → {string}
The GetRadiusX() method indicates the x-radius value / expression of the clip, relative to the layer (equivalent of layers's [clip.radiusX] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the x-radius value / expression of the clip, relative to the layer.
- Type
- string
GetRadiusY() → {string}
The GetRadiusY() method indicates the y-radius value / expression of the clip, relative to the layer (equivalent of layers's [clip.radiusY] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the y-radius value / expression of the clip, relative to the layer.
- Type
- string
GetRoundRadiusX() → {string}
The GetRoundRadiusX() method indicates the x-radius value / expression of the round corner, relative to the layer (equivalent of layers's [clip.roundX] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the x-radius value / expression of the round corner, relative to the layer.
- Type
- string
GetRoundRadiusY() → {string}
The GetRoundRadiusY() method indicates the y-radius value / expression of the round corner, relative to the layer (equivalent of layers's [clip.roundY] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the y-radius value / expression of the round corner, relative to the layer.
- Type
- string
GetStartAngle() → {string}
The GetStartAngle() method indicates the pie's starting angle (degree) relative to the y-axis (equivalent of layers's [clip.start] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns starting angle (degree) relative to the y-axis.
- Type
- string
GetSweepAngle() → {string}
The GetSweepAngle() method indicates the pie's sweep angle (degree) / expression relative to starting angle (equivalent of layers's [clip.sweep] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the sweep angle (degree) relative to starting angle.
- Type
- string
GetTop() → {string}
The GetTop() method indicates the top position / expression of the clip, relative to the layer (equivalent of layers's [clip.top] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the top position / expression of the clip, relative to the layer.
- Type
- string
GetType() → {string}
The GetType() method retrieves the type of the clipping the current layer supports (equivalent of layers's [clip] flag).
Returns:
Returns the layer's clipping type as "Rect","RoundRect","Ellipse" or "Pie"
- Type
- string
GetValue() → {number}
The GetValue() method indicates the clip's value (equivalent of layers's [clip.value] flag).
Returns:
Returns the clip's value.
- Type
- number
GetWidth() → {string}
The GetWidth() method indicates the width value / expression of the clip, relative to the layer (equivalent of layers's [clip.width] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Returns:
Returns the width value / expression of the clip, relative to the layer.
- Type
- string
SetCenterX(value)
The SetCenterX() method indicates the x-position / expression of the center of the clip, relative to the layer (equivalent of layers's [clip.xCenter] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the x-position / expression of the center of the clip, relative to the layer. |
SetCenterY(value)
The SetCenterY() method indicates the y-position / expression of the center of the clip, relative to the layer (equivalent of layers's [clip.yCenter] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the y-position / expression of the center of the clip, relative to the layer. |
SetHeight(value)
The SetHeight() method indicates the height value / expression of the clip, relative to the layer (equivalent of layers's [clip.height] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the height value / expression of the clip, relative to the layer. |
SetLeft(value)
The SetLeft() method indicates the left position / expression of the clip, relative to the layer (equivalent of layers's [clip.left] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the left position / expression of the clip, relative to the layer. |
SetOffsetX(value)
The SetOffsetX() method indicates the x-offset expression / value of the clip, relative to the layer (equivalent of layers's [clip.x] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the x-offset expression / value of the clip, relative to the layer. |
SetOffsetY(value)
The SetOffsetY() method indicates the y-offset expression / value of the clip, relative to the layer (equivalent of layers's [clip.y] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the y-offset expression / value of the clip, relative to the layer. |
SetRadiusX(value)
The SetRadiusX() method indicates the x-radius value / expression of the clip, relative to the layer (equivalent of layers's [clip.radiusX] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the x-radius value / expression of the clip, relative to the layer. |
SetRadiusY(value)
The SetRadiusY() method indicates the y-radius value / expression of the clip, relative to the layer (equivalent of layers's [clip.radiusY] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the y-radius value / expression of the clip, relative to the layer. |
SetRoundRadiusX(value)
The SetRoundRadiusX() method indicates the x-radius value / expression of the round corner, relative to the layer (equivalent of layers's [clip.roundX] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the x-radius value / expression of the round corner, relative to the layer. |
SetRoundRadiusY(value)
The SetRoundRadiusY() method indicates the y-radius value / expression of the round corner, relative to the layer (equivalent of layers's [clip.roundY] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the y-radius value / expression of the round corner, relative to the layer (equivalent of layers's [clip.roundY] flag). |
SetStartAngle(value)
The SetStartAngle() method indicates the pie's starting angle (degree) relative to the y-axis (equivalent of layers's [clip.start] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies starting angle (degree) relative to the y-axis. |
SetSweepAngle(value)
The SetSweepAngle() method indicates the pie's sweep angle (degree) relative to starting angle (equivalent of layers's [clip.sweep] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the sweep angle (degree) relative to starting angle. |
SetTop(value)
The SetTop() method indicates the top position / expression of the clip, relative to the layer (equivalent of layers's [clip.top] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the top position / expression of the clip, relative to the layer. |
SetType(value)
The SetType() method changes the type of the clipping the current layer supports (equivalent of layers's [clip] flag).
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | Specifies the layer's clipping type as "Rect","RoundRect","Ellipse" or "Pie" |
SetValue(value)
The SetValue() method indicates the clip's value (equivalent of layers's [clip.value] flag).
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number | Specifies the clip's value. |
SetWidth(value)
The SetWidth() method indicates the width value / expression of the clip, relative to the layer (equivalent of layers's [clip.width] flag).
The expression supports the following keywords:
"value", specifies the clip's value pointed by the clip/control's Value property
"width" or "lwidth", indicates the width in pixels of the layer
"height" or "lheight", indicates the height in pixels of the layer
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Specifies the width value / expression of the clip, relative to the layer. |