Enumeration that specifies the various hot spot regions of an IStripe instance.
Remarks
Members of this enumeration can be combined to specify composite regions.
Type Details
- yFiles module
- view
See Also
Constants
The hot spot region includes the stripe far-border region.
Remarks
The far border is the region that is used for the resize gesture in ResizeStripeInputMode to expand the stripe to the bottom or the right. This is typically the bottom border for an IRow instance and the right border for an IColumn.
See Also
The hot spot region includes both stripe headers.
The hot spot region includes the leading stripe header.
The hot spot region includes the near-border region of the stripe.
Remarks
The near border is the region that is used for the resize gesture in ResizeStripeInputMode to expand the stripe to the top or the left. This is typically the upper border for an IRow instance and the left border for an IColumn.
See Also
The hot spot region includes the stripe itself.
The hot spot region includes the trailing stripe header.
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - StripeSubregionTypes
- The value to convert to an enum constant.
Returns
- ↪StripeSubregionTypes
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - StripeSubregionTypes
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.