@arcgis/core 5.1.0-next.20 → 5.1.0-next.21

package/symbols/cim/types.d.ts

@@ -1,6 +1,10 @@
 import type { Extent, Point } from "../../portal/jsonTypes.js";
 
-/** @since 5.0 */
+/**
+ * A color represented as an array of RGBA values, where each value is a number between 0 and 255.
+ *
+ * @since 5.0
+ */
 export type CIMColor = [
     number,
     number,
@@ -58,7 +62,7 @@ export type CIMColor = [
  */
 export interface CIMPrimitiveOverride {
   /** @since 5.0 */
-  type?: "CIMPrimitiveOverride";
+  type: "CIMPrimitiveOverride";
   /**
    * The primitive name this override applies to.
    *
@@ -104,23 +108,27 @@ export interface CIMFixedColorRamp extends CIMColorRamp {
   /** @since 5.0 */
   type: "CIMFixedColorRamp";
   /**
-   * The ordered list of colors in the color scheme, with each color represented as an array of rbga values (`[255,255,255,255]`). The colors are applied in the order they are defined.
+   * The ordered list of colors in the color scheme. The colors are applied in the order they are defined.
    *
    * @since 5.0
    */
   colors: CIMColor[];
 }
 
-/** @since 5.0 */
+/**
+ * Represents a continuous color ramp scheme - a color ramp that has a continuous transition between two colors.
+ *
+ * @since 5.0
+ */
 export interface CIMContinuousColorRamp extends CIMColorRamp {
   /**
-   * The color at the start of the ramp. The color is defined as an array of RGBA values (`[255,255,255,255]`).
+   * The color at the start of the ramp.
    *
    * @since 5.0
    */
   fromColor: CIMColor;
   /**
-   * The color at the end of the ramp. The color is defined as an array of RGBA values (`[255,255,255,255]`).
+   * The color at the end of the ramp.
    *
    * @since 5.0
    */
@@ -201,7 +209,11 @@ export interface CIMMultipartColorRamp extends CIMColorRamp {
  */
 export type CIMColorRampUnion = CIMLinearContinuousColorRamp | CIMFixedColorRamp | CIMMultipartColorRamp;
 
-/** @since 5.0 */
+/**
+ * Represents a callout for a point symbol.
+ *
+ * @since 5.0
+ */
 export interface CIMCallout {}
 
 /** @since 5.0 */
@@ -222,7 +234,7 @@ export interface CIMBackgroundCallout extends CIMLineCallout {
   type: "CIMBackgroundCallout";
   /**
    * The symbol used to draw the background.
-   *    Currently, only CIMSolidStroke and CIMSolidFill symbol layers without geometric effects are supported within this symbol.
+   * > Currently, only CIMSolidStroke and CIMSolidFill symbol layers without geometric effects are supported within this symbol.
    *
    * @since 5.0
    */
@@ -264,7 +276,7 @@ export interface CIMSymbolLayer {
    *
    * @since 5.0
    */
-  enable?: boolean;
+  enable: boolean;
   /**
    * A value indicating whether the color can be changed for this symbol layer. If the symbol layer is colorLocked, then any changes to the symbol's color property will not be applied to this symbol layer.
    *
@@ -392,7 +404,7 @@ export interface CIMGeometricEffectBase {
    *
    * @since 5.0
    */
-  primitiveName: string;
+  primitiveName?: string;
 }
 
 /**
@@ -448,7 +460,7 @@ export interface CIMGeometricEffectArrow extends CIMGeometricEffectBase {
    *
    * @since 5.0
    */
-  geometricEffectArrowType: CIMGeometricEffectArrowType;
+  arrowType: CIMGeometricEffectArrowType;
   /**
    * The distance between the lines that construct the body of the arrow.
    *
@@ -529,28 +541,28 @@ export interface CIMGeometricEffectCut extends CIMGeometricEffectBase {
    * @default 1
    * @since 5.0
    */
-  beginCut: number;
+  beginCut?: number;
   /**
    * The distance from the end of a line that the display of the stroke ends. The end of the line is determined by the direction in which the line was digitized.
    *
    * @default 1
    * @since 5.0
    */
-  endCut: number;
+  endCut?: number;
   /**
    * The distance around the middle of a line that the display of the stroke is interrupted.
    *
    * @default 0
    * @since 5.0
    */
-  middleCut: number;
+  middleCut?: number;
   /**
    * A value indicating whether the effect should be applied in the opposite manner. This displays the stroke symbol only at the ends of the line and leaves the rest of the line unsymbolized.
    *
    * @default false
    * @since 5.0
    */
-  invert: boolean;
+  invert?: boolean;
 }
 
 /**
@@ -581,7 +593,7 @@ export interface CIMGeometricEffectDashes extends CIMGeometricEffectBase {
    * @default 0
    * @since 5.0
    */
-  customEndingOffset: number;
+  customEndingOffset?: number;
   /**
    * The distance for each dash and gap. There can be multiple dash and gap values to form a complex pattern (i.e. [2,5] where 2 is the length of the dash and 5 is the length of the gap).
    *
@@ -594,7 +606,7 @@ export interface CIMGeometricEffectDashes extends CIMGeometricEffectBase {
    * @default "NoConstraint"
    * @since 5.0
    */
-  lineDashEnding: CIMLineDashEnding;
+  lineDashEnding?: CIMLineDashEnding;
   /**
    * The position where the pattern should begin relative to the starting point of the geometry. It shifts the entire pattern along the line the specified distance. Negative values indicate a shift to the left and positive numbers a shift to the right. This property is only applied if `lineDashEnding` is set to `NoConstraint` or `Custom`.
    *
@@ -619,7 +631,7 @@ export interface CIMGeometricEffectDonut extends CIMGeometricEffectBase {
    * @default "Accurate"
    * @since 5.0
    */
-  option: CIMGeometricEffectOffsetOption;
+  option?: CIMGeometricEffectOffsetOption;
   /**
    * The distance from the edge of the polygon that the fill symbol is to be displayed.
    *
@@ -645,7 +657,7 @@ export interface CIMGeometricEffectEnclosingPolygon extends CIMGeometricEffectBa
   /** @since 5.0 */
   type: "CIMGeometricEffectEnclosingPolygon";
   /**
-   * The method which speccifies the way in which the polygon geometry is generated around the feature geometry.
+   * The method which specifies the way in which the polygon geometry is generated around the feature geometry.
    *
    * @since 5.0
    */
@@ -717,14 +729,14 @@ export interface CIMGeometricEffectMove extends CIMGeometricEffectBase {
    * @default 1
    * @since 5.0
    */
-  offsetX: number;
+  offsetX?: number;
   /**
    * The distance in points to move the symbol along the Y-axis of the feature geometry.
    *
    * @default -1
    * @since 5.0
    */
-  offsetY: number;
+  offsetY?: number;
 }
 
 /**
@@ -751,7 +763,7 @@ export interface CIMGeometricEffectOffset extends CIMGeometricEffectBase {
    * @default "Square"
    * @since 5.0
    */
-  method: CIMGeometricEffectOffsetMethod;
+  method?: CIMGeometricEffectOffsetMethod;
   /**
    * The distance in points of the symbol perpendicular to the feature geometry.
    *
@@ -764,11 +776,11 @@ export interface CIMGeometricEffectOffset extends CIMGeometricEffectBase {
    * @default "Fast"
    * @since 5.0
    */
-  option: CIMGeometricEffectOffsetOption;
+  option?: CIMGeometricEffectOffsetOption;
 }
 
 /**
- * Represents the radial geometric effect which creates a dynamic line of a sepcified length and angle originating from a point feature.
+ * Represents the radial geometric effect which creates a dynamic line of a specified length and angle originating from a point feature.
  *
  * ```json
  * {
@@ -789,14 +801,14 @@ export interface CIMGeometricEffectRadial extends CIMGeometricEffectBase {
    * @default 0
    * @since 5.0
    */
-  angle: number;
+  angle?: number;
   /**
    * The length of the radial line.
    *
    * @default 5
    * @since 5.0
    */
-  length: number;
+  length?: number;
 }
 
 /**
@@ -850,14 +862,14 @@ export interface CIMGeometricEffectScale extends CIMGeometricEffectBase {
    * @default 1.15
    * @since 5.0
    */
-  xScaleFactor: number;
+  xScaleFactor?: number;
   /**
    * The amount of change in size of a symbol in the y-axis. The value is expressed in terms of a ratio/percentage.
    *
    * @default 1.15
    * @since 5.0
    */
-  yScaleFactor: number;
+  yScaleFactor?: number;
 }
 
 /**
@@ -882,7 +894,7 @@ export interface CIMGeometricEffectSuppress extends CIMGeometricEffectBase {
    * @default false
    * @since 5.0
    */
-  invert: boolean;
+  invert?: boolean;
 }
 
 /**
@@ -959,14 +971,14 @@ export interface CIMGeometricEffectWave extends CIMGeometricEffectBase {
    * @default 1
    * @since 5.0
    */
-  seed: number;
+  seed?: number;
   /**
    * The shape of the curves to be displayed along the symbol.
    *
    * @default "Sinus"
    * @since 5.0
    */
-  waveform: CIMGeometricEffectWaveform;
+  waveform?: CIMGeometricEffectWaveform;
 }
 
 /** @since 5.0 */
@@ -1026,7 +1038,7 @@ export interface CIMGradientFill extends CIMFill {
    * @default "Linear"
    * @since 5.0
    */
-  gradientMethod: CIMGradientFillMethod;
+  gradientMethod?: CIMGradientFillMethod;
   /**
    * The size which determines the how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans (if units are "Relative") or the number of points from the starting point at which the gradient displays (if units are "Absolute").
    *
@@ -1057,7 +1069,11 @@ export interface CIMGradientFill extends CIMFill {
   interval?: number;
 }
 
-/** @since 5.0 */
+/**
+ * Represents a stroke which draws linear geometry with specified visual properties.
+ *
+ * @since 5.0
+ */
 export interface CIMStroke extends CIMSymbolLayer {
   /**
    * Determines how the stroke should draw at the ends of the geometries.
@@ -1209,27 +1225,27 @@ export interface CIMHatchFill extends CIMFill {
    * @default 0
    * @since 5.0
    */
-  offsetX: number;
+  offsetX?: number;
   /**
    * How much to move the stroke in points to a new Y-position.
    *
    * @default 0
    * @since 5.0
    */
-  offsetY: number;
+  offsetY?: number;
   /**
    * The angle of rotation for all the strokes, in degrees.
    *
    * @default 0
    * @since 5.0
    */
-  rotation: number;
+  rotation?: number;
   /**
    * The distance between the line symbols in the hatch pattern.
    *
    * @since 5.0
    */
-  separation: number;
+  separation?: number;
 }
 
 /** @since 5.0 */
@@ -1298,7 +1314,11 @@ export interface CIMSymbolReference {
   maxScale?: number;
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all CIM symbols.
+ *
+ * @since 5.0
+ */
 export interface CIMSymbol {}
 
 /**
@@ -1325,7 +1345,11 @@ export interface CIMSymbol {}
  */
 export type CIMSymbolLayerUnion = CIMGradientFill | CIMPictureMarker | CIMVectorMarker | CIMGradientStroke | CIMHatchFill | CIMPictureFill | CIMPictureStroke | CIMSolidFill | CIMSolidStroke;
 
-/** @since 5.0 */
+/**
+ * Represents a multi-layer symbol which is a symbol composed of multiple symbol layers.
+ *
+ * @since 5.0
+ */
 export interface CIMMultiLayerSymbol extends CIMSymbol {
   /**
    * The geometric effects applied to the symbol.
@@ -1445,7 +1469,11 @@ export interface CIMMarkerGraphic {
   primitiveName?: string;
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all CIM marker placements.
+ *
+ * @since 5.0
+ */
 export interface CIMMarkerPlacementBase {
   /**
    * The primitive name.
@@ -1459,10 +1487,14 @@ export interface CIMMarkerPlacementBase {
    * @default true
    * @since 5.0
    */
-  placePerPart: boolean;
+  placePerPart?: boolean;
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all CIM marker placements along a stroke.
+ *
+ * @since 5.0
+ */
 export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase {
   /**
    * A value indicating whether to angle the marker to the line.
@@ -1470,7 +1502,7 @@ export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase {
    * @default true
    * @since 5.0
    */
-  angleToLine: boolean;
+  angleToLine?: boolean;
   /**
    * A value indicating whether to keep the marker upright. This is only considered if `angleToLine` is true.
    *
@@ -1484,10 +1516,14 @@ export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase {
    * @default 0
    * @since 5.0
    */
-  offset: number;
+  offset?: number;
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all CIM marker placements along a line.
+ *
+ * @since 5.0
+ */
 export interface CIMMarkerPlacementAlongLine extends CIMMarkerStrokePlacement {
   /**
    * Where the pattern should end relative to the ending point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the `endings` property is set to `Custom`.
@@ -1495,21 +1531,21 @@ export interface CIMMarkerPlacementAlongLine extends CIMMarkerStrokePlacement {
    * @default 0
    * @since 5.0
    */
-  customEndingOffset: number;
+  customEndingOffset?: number;
   /**
    * How markers are placed at the end points of a line.
    *
    * @default "WithHalfGap"
    * @since 5.0
    */
-  endings: CIMPlacementEndings;
+  endings?: CIMPlacementEndings;
   /**
    * Where the pattern should begin relative to the starting point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the `endings` property is set to `No Constraint` or `Custom`.
    *
    * @default 0
    * @since 5.0
    */
-  offsetAlongLine: number;
+  offsetAlongLine?: number;
   /**
    * The numeric pattern that defines the sequence of placed markers and the length of space between them.
    *
@@ -1576,14 +1612,14 @@ export interface CIMMarkerPlacementAtExtremities extends CIMMarkerStrokePlacemen
    * @default "Both"
    * @since 5.0
    */
-  extremityPlacement: CIMExtremityPlacement;
+  extremityPlacement?: CIMExtremityPlacement;
   /**
    * The distance (in points) from the ends of a line that the marker will be placed.
    *
    * @default 0
    * @since 5.0
    */
-  offsetAlongLine: number;
+  offsetAlongLine?: number;
 }
 
 /**
@@ -1617,21 +1653,21 @@ export interface CIMMarkerPlacementAtRatioPositions extends CIMMarkerStrokePlace
    * @default 0
    * @since 5.0
    */
-  beginPosition: number;
+  beginPosition?: number;
   /**
    * The distance from the end of a line that the marker will be placed. The ending of a line is determined by the direction in which the line was digitized.
    *
    * @default 0
    * @since 5.0
    */
-  endPosition: number;
+  endPosition?: number;
   /**
    * A value indicating whether only the first marker will be rotated 180 degrees.
    *
    * @default true
    * @since 5.0
    */
-  flipFirst: boolean;
+  flipFirst?: boolean;
   /**
    * The array of positions.
    *
@@ -1640,7 +1676,11 @@ export interface CIMMarkerPlacementAtRatioPositions extends CIMMarkerStrokePlace
   positionArray: number[];
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all CIM marker placements inside a polygon.
+ *
+ * @since 5.0
+ */
 export interface CIMMarkerFillPlacement extends CIMMarkerPlacementBase {}
 
 /**
@@ -1675,49 +1715,49 @@ export interface CIMMarkerPlacementInsidePolygon extends CIMMarkerFillPlacement
    * @default 0
    * @since 5.0
    */
-  gridAngle: number;
+  gridAngle?: number;
   /**
    * The grid type which defines how markers are placed. `Random` is supported as of version 4.24.
    *
    * @default "Fixed"
    * @since 5.0
    */
-  gridType: CIMPlacementGridType;
+  gridType?: CIMPlacementGridType;
   /**
    * The marker row offset horizontally in points.
    *
    * @default 0
    * @since 5.0
    */
-  offsetX: number;
+  offsetX?: number;
   /**
    * The marker row offset vertically in points.
    *
    * @default 0
    * @since 5.0
    */
-  offsetY: number;
+  offsetY?: number;
   /**
    * A percentage that determines the randomness of markers within the polygon. Accepted values are between 0 and 100, with 0 being the least random and 100 being the most random. Only applied when `gridType` is `Random`.
    *
    * @default 100
    * @since 5.0
    */
-  randomness: number;
+  randomness?: number;
   /**
    * The starting value for generating a random pattern. Only applied when `gridType` is `Random`.
    *
    * @default 0
    * @since 5.0
    */
-  seed: number;
+  seed?: number;
   /**
    * A value indicating whether every other row of markers should be shifted to create an offset grid.
    *
    * @default false
    * @since 5.0
    */
-  shiftOddRows: boolean;
+  shiftOddRows?: boolean;
   /**
    * The distance between each marker on the X-axis of the grid.
    *
@@ -1730,12 +1770,6 @@ export interface CIMMarkerPlacementInsidePolygon extends CIMMarkerFillPlacement
    * @since 5.0
    */
   stepY: number;
-  /**
-   * The clipping option which specifies how markers should be clipped at the polygon boundary. The markers will always be clipped at the polygon boundary.
-   *
-   * @since 5.0
-   */
-  clipping: CIMPlacementClip;
 }
 
 /**
@@ -1767,14 +1801,14 @@ export interface CIMMarkerPlacementOnLine extends CIMMarkerStrokePlacement {
    * @default "LineMiddle"
    * @since 5.0
    */
-  relativeTo: CIMPlacementOnLineRelativeTo;
+  relativeTo?: CIMPlacementOnLineRelativeTo;
   /**
    * The distance in points from a specified location on a line that a marker will be placed.
    *
    * @default 0
    * @since 5.0
    */
-  startPointOffset: number;
+  startPointOffset?: number;
 }
 
 /**
@@ -1806,21 +1840,21 @@ export interface CIMMarkerPlacementOnVertices extends CIMMarkerStrokePlacement {
    * @default true
    * @since 5.0
    */
-  placeOnControlPoints: boolean;
+  placeOnControlPoints?: boolean;
   /**
    * A value indicating whether a marker will be placed on the endpoints of the line.
    *
    * @default true
    * @since 5.0
    */
-  placeOnEndPoints: boolean;
+  placeOnEndPoints?: boolean;
   /**
    * A value indicating whether a marker will be placed on the vertices of the line.
    *
    * @default true
    * @since 5.0
    */
-  placeOnRegularVertices: boolean;
+  placeOnRegularVertices?: boolean;
 }
 
 /**
@@ -1852,28 +1886,21 @@ export interface CIMMarkerPlacementPolygonCenter extends CIMMarkerFillPlacement
    * @default "OnPolygon"
    * @since 5.0
    */
-  method: CIMPlacementPolygonCenterMethod;
+  method?: CIMPlacementPolygonCenterMethod;
   /**
    * The value which offsets the marker horizontally from the center in points.
    *
    * @default 0
    * @since 5.0
    */
-  offsetX: number;
+  offsetX?: number;
   /**
    * The value which offsets the marker vertically from the center in points.
    *
    * @default 0
    * @since 5.0
    */
-  offsetY: number;
-  /**
-   * A value indicating whether the marker should be clipped if it extends pasts the boundary of the polygon.
-   *
-   * @default false
-   * @since 5.0
-   */
-  clipAtBoundary: boolean;
+  offsetY?: number;
 }
 
 /**
@@ -1935,28 +1962,28 @@ export interface CIMPictureFill extends CIMFill {
    * @default 0
    * @since 5.0
    */
-  offsetX: number;
+  offsetX?: number;
   /**
    * The distance that the image is offset in points in the vertical direction.
    *
    * @default 0
    * @since 5.0
    */
-  offsetY: number;
+  offsetY?: number;
   /**
    * The angle of the image within the fill.
    *
    * @default 0
    * @since 5.0
    */
-  rotation: number;
+  rotation?: number;
   /**
    * The width of the symbol without changing the height, as a ratio. For example, a `scaleX` value of `1` means no change, `0.5` means half the width, and `2` means double the width.
    *
    * @default 1
    * @since 5.0
    */
-  scaleX: number;
+  scaleX?: number;
   /**
    * The height of the image in points.
    *
@@ -2018,7 +2045,7 @@ export interface CIMPictureMarker extends CIMMarker {
    * @default 1
    * @since 5.0
    */
-  scaleX: number;
+  scaleX?: number;
   /**
    * The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
    *
@@ -2108,7 +2135,11 @@ export interface CIMAnimatedSymbolProperties {
   startTimeOffset?: number;
 }
 
-/** @since 5.0 */
+/**
+ * The base interface for all symbol animations.
+ *
+ * @since 5.0
+ */
 export interface CIMBaseAnimation {
   /**
    * The properties that apply when the symbol layer has animation data.
@@ -2185,7 +2216,7 @@ export interface CIMSymbolAnimationColor extends CIMBaseAnimation {
    *
    * @since 5.0
    */
-  colorMode: "Override" | "Multiply";
+  colorMode?: "Override" | "Multiply";
 }
 
 /**
@@ -2235,7 +2266,7 @@ export interface CIMSymbolAnimationRotation extends CIMBaseAnimation {
    * @default false
    * @since 5.0
    */
-  rotateClockwise: boolean;
+  rotateClockwise?: boolean;
 }
 
 /**
@@ -2432,7 +2463,6 @@ export interface CIMPointSymbol extends CIMMultiLayerSymbol {
  *            seed: 13,
  *            stepX: 16,
  *            stepY: 16,
- *            clipping: "ClipAtBoundary",
  *          },
  *          markerGraphics: [{
  *            type: "CIMMarkerGraphic",
@@ -2515,7 +2545,7 @@ export interface CIMSolidFill extends CIMFill {
    *
    * @since 5.0
    */
-  color?: CIMColor;
+  color: CIMColor;
   /**
    * The animations applied to the solid fill. Only [CIMSymbolAnimationColor](https://developers.arcgis.com/javascript/latest/references/core/symbols/cim/types/#CIMSymbolAnimationColor) is supported.
    *
@@ -2555,7 +2585,7 @@ export interface CIMSolidStroke extends CIMStroke {
    *
    * @since 5.0
    */
-  color?: CIMColor;
+  color: CIMColor;
   /**
    * The animations applied to the solid stroke. Only [CIMSymbolAnimationColor](https://developers.arcgis.com/javascript/latest/references/core/symbols/cim/types/#CIMSymbolAnimationColor) is supported.
    *
@@ -2779,13 +2809,13 @@ export interface CIMVectorMarker extends CIMMarker {
    *
    * @since 5.0
    */
-  frame?: Extent;
+  frame: Extent;
   /**
    * The vector graphics that define the shape of the marker. The marker graphics are typically rendered from bottom to top, so the first marker graphic will be displayed at the bottom, and the last marker graphic will be displayed on top. See [CIMMarkerGraphic](https://developers.arcgis.com/javascript/latest/references/core/symbols/cim/types/#CIMMarkerGraphic) for limitations with FeatureLayer.
    *
    * @since 5.0
    */
-  markerGraphics?: CIMMarkerGraphic[];
+  markerGraphics: CIMMarkerGraphic[];
   /**
    * A value indicating whether the strokes and or fills of a marker are scaled proportionally when the symbol size is changed. When enabled, the strokes for the outline or fill of the polygon symbol used to draw the marker will be scaled proportionally with changes to the symbol size. If this property is not enabled, then the stroke will draw with the specified width regardless of the marker size.
    *
@@ -2802,67 +2832,140 @@ export interface CIMVectorMarker extends CIMMarker {
   respectFrame?: boolean;
 }
 
-/** @since 5.0 */
+/**
+ * Represents a union type of all CIM symbol types.
+ *
+ * @since 5.0
+ */
 export type CIMSymbolUnion = CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol | CIMTextSymbol;
 
-/** @since 5.0 */
+/**
+ * Options for angle alignment of symbols.
+ *
+ * @since 5.0
+ */
 export type CIMAngleAlignment = "Display" | "Map";
 
-/** @since 5.0 */
+/**
+ * Options for repeat types of animated symbols.
+ *
+ * @since 5.0
+ */
 export type CIMAnimatedSymbolRepeatType = "None" | "Loop" | "Oscillate";
 
-/** @since 5.0 */
+/**
+ * Options for easing types of animated symbols.
+ *
+ * @since 5.0
+ */
 export type CIMAnimatedSymbolEasingType = "Linear" | "EaseIn" | "EaseOut" | "EaseInOut";
 
-/** @since 5.0 */
+/**
+ * Options for arrow types in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectArrowType = "OpenEnded" | "Block" | "Crossed";
 
-/** @since 5.0 */
+/**
+ * Options for control measure line rules in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectControlMeasureLineRule = "FullGeometry" | "PerpendicularFromFirstSegment" | "ReversedFirstSegment" | "PerpendicularToSecondSegment" | "SecondSegmentWithTicks" | "DoublePerpendicular" | "OppositeToFirstSegment" | "TriplePerpendicular" | "HalfCircleFirstSegment" | "HalfCircleSecondSegment" | "HalfCircleExtended" | "OpenCircle" | "CoverageEdgesWithTicks" | "GapExtentWithDoubleTicks" | "GapExtentMidline" | "Chevron" | "PerpendicularWithArc" | "ClosedHalfCircle" | "TripleParallelExtended" | "ParallelWithTicks" | "Parallel" | "PerpendicularToFirstSegment" | "ParallelOffset" | "OffsetOpposite" | "OffsetSame" | "CircleWithArc" | "DoubleJog" | "PerpendicularOffset" | "LineExcludingLastSegment" | "MultivertexArrow" | "CrossedArrow" | "ChevronArrow" | "ChevronArrowOffset" | "PartialFirstSegment" | "Arch" | "CurvedParallelTicks" | "Arc90Degrees" | "TipWithPerpendicularAndTicks" | "ConcentricCircles" | "DoubleJogArrow" | "LinkedChevrons" | "SegmentThenHalfCircle" | "LineWithStraightTicks" | "DoubleCurve" | "ParallelWithTicksByWidth" | "EnclosingRoundedRectangle";
 
-/** @since 5.0 */
+/**
+ * Options for enclosing polygon methods in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectEnclosingPolygonMethod = "ClosePath" | "ConvexHull" | "RectangularBox";
 
-/** @since 5.0 */
+/**
+ * Options for offset methods in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectOffsetMethod = "Mitered" | "Bevelled" | "Rounded" | "Square";
 
-/** @since 5.0 */
+/**
+ * Options for offset calculation accuracy in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectOffsetOption = "Fast" | "Accurate";
 
-/** @since 5.0 */
+/**
+ * Options for waveform types in geometric effects.
+ *
+ * @since 5.0
+ */
 export type CIMGeometricEffectWaveform = "Sinus" | "Square" | "Triangle" | "Random";
 
-/** @since 5.0 */
+/**
+ * Options for gradient fill methods.
+ *
+ * @since 5.0
+ */
 export type CIMGradientFillMethod = "Linear" | "Rectangular" | "Circular" | "Buffered";
 
-/** @since 5.0 */
+/**
+ * Options for gradient stroke types.
+ *
+ * @since 5.0
+ */
 export type CIMGradientStrokeType = "Discrete" | "Continuous";
 
-/** @since 5.0 */
+/**
+ * Options for gradient stroke methods.
+ *
+ * @since 5.0
+ */
 export type CIMGradientStrokeMethod = "AcrossLine" | "AlongLine";
 
-/** @since 5.0 */
+/**
+ * Options for horizontal alignment of text.
+ *
+ * @since 5.0
+ */
 export type CIMHorizontalAlignment = "Left" | "Right" | "Center" | "Justify";
 
-/** @since 5.0 */
+/**
+ * Options for line cap styles.
+ *
+ * @since 5.0
+ */
 export type CIMLineCapStyle = "Butt" | "Round" | "Square";
 
-/** @since 5.0 */
+/**
+ * Options for line dash endings.
+ *
+ * @since 5.0
+ */
 export type CIMLineDashEnding = "NoConstraint" | "HalfPattern" | "HalfGap" | "FullPattern" | "FullGap" | "Custom";
 
-/** @since 5.0 */
+/**
+ * Options for line join styles.
+ *
+ * @since 5.0
+ */
 export type CIMLineJoinStyle = "Bevel" | "Round" | "Miter";
 
 /** @since 5.0 */
 export type CIMExpressionReturnType = "Default" | "String" | "Numeric";
 
-/** @since 5.0 */
-export type CIMPlacementClip = 0 | 1 | 2 | 3;
-
-/** @since 5.0 */
+/**
+ * Options for marker placement endings.
+ *
+ * @since 5.0
+ */
 export type CIMPlacementEndings = "NoConstraint" | "WithMarkers" | "WithFullGap" | "WithHalfGap" | "Custom";
 
-/** @since 5.0 */
+/**
+ * Options for placement grid types.
+ *
+ * @since 5.0
+ */
 export type CIMPlacementGridType = "Fixed" | "Random" | "RandomFixedQuantity";
 
 /** @since 5.0 */