API Reference › core-common › Symbology › LineStyle › LineStyle.Modifier

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 undefined | boolean Optional flag to center stroke pattern and stretch ends, false if undefined  
dashScale undefined | number Optional scale to apply to scalable dashes, 1.0 if undefined  
distPhase undefined | number Optional shift by distance in meters, 0.0 if undefined  
endWidth undefined | number Optional end width in meters to apply to dashes, same as startWidth if undefined  
fractPhase undefined | number Optional shift by fraction, 0.0 if undefined  
gapScale undefined | number Optional scale to apply to scalable gaps, 1.0 if undefined  
normal undefined | Vector3d Optional up vector for style (applicable to 3d only), 0.0,0.0,1.0 if undefined  
physicalWidth undefined | boolean Optional flag that denotes startWidth and endWidth represent physical widths that should not be affected by scale, false if undefined  
rotation undefined | YawPitchRollAngles Optional orientation for style (applicable to 3d only), 0.0,0.0,0.0 if undefined  
scale undefined | number Optional scale to apply to all length values, 1.0 if undefined  
segmentMode undefined | boolean Optional flag to enable or disable single segment mode  
startWidth undefined | number Optional start width in meters to apply to dashes, no width if undefined  

Defined in

Last Updated: 16 April, 2024