LineStyle.Modifier Class
Optional modifiers to override line style definition
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(props: LineStyle.ModifierProps): LineStyle.Modifier | constructor for LineStyle.Modifier | |
| applyTransform(transform: Transform): boolean | ||
| clone(): LineStyle.Modifier | Returns a deep copy of this object. | |
| equals(other: LineStyle.Modifier): boolean | Compare two LineStyle.Modifier for equivalence |
Properties
| Name | Type | Description | |
|---|---|---|---|
| centerPhase | boolean | undefined | Optional flag to center stroke pattern and stretch ends, false if undefined | |
| dashScale | number | undefined | Optional scale to apply to scalable dashes, 1.0 if undefined | |
| distPhase | number | undefined | Optional shift by distance in meters, 0.0 if undefined | |
| endWidth | number | undefined | Optional end width in meters to apply to dashes, same as startWidth if undefined | |
| fractPhase | number | undefined | Optional shift by fraction, 0.0 if undefined | |
| gapScale | number | undefined | Optional scale to apply to scalable gaps, 1.0 if undefined | |
| normal | Vector3d | undefined | Optional up vector for style (applicable to 3d only), 0.0,0.0,1.0 if undefined | |
| physicalWidth | boolean | undefined | Optional flag that denotes startWidth and endWidth represent physical widths that should not be affected by scale, false if undefined | |
| rotation | YawPitchRollAngles | undefined | Optional orientation for style (applicable to 3d only), 0.0,0.0,0.0 if undefined | |
| scale | number | undefined | Optional scale to apply to all length values, 1.0 if undefined | |
| segmentMode | boolean | undefined | Optional flag to enable or disable single segment mode | |
| startWidth | number | undefined | Optional start width in meters to apply to dashes, no width if undefined |
Defined in
Last Updated: 24 October, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.