Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CIMGradientStroke

Represents a gradient stroke which draws linear geometry with a specified color scheme.

Read more...

Hierarchy

Index

Properties

Optional capStyle

capStyle: "Square" | "Butt" | "Round"

How the stroke should draw at the ends of the geometries.

Optional closeCaps3D

closeCaps3D: boolean

A value indicating whether to close caps when drawing them in 3D. When set to false, the caps are hollow.

Optional colorLocked

colorLocked: boolean

A value indicating whether the color set at the basic properties level is applied to the symbol layer. If the symbol layer is color locked then changes made to the color in the basic properties will not be applied to the symbol layer.

Optional colorRamp

colorRamp: any

The color scheme that is applied to the stroke.

Optional effects

Whether the geometric effects that are applied to the symbol layer. Effects dynamically alter the feature geometry when the symbology is applied. Multiple effects applied to a symbol layer are rendered sequentially.

Optional enable

enable: boolean

A value indicating whether the symbol layer is visible. The symbol layer draws only when enabled. Currently, an invisible layer is not considered in any transformations when in a 3D context.

Optional gradientMethod

gradientMethod: "AcrossLine" | "AlongLine"

How the gradient is applied along the stroke.

Optional gradientSize

gradientSize: number

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 or the number of page units from the starting point at which the gradient displays.

Optional gradientSizeUnits

gradientSizeUnits: "Relative" | "Absolute"

Whether GradientSize is applied with an absolute distance or a relative percentage.

Optional gradientType

gradientType: "Discrete" | "Continuous"

Whether the gradient is applied with discrete or continuous intervals.

Optional interval

interval: number

How many bands draw when the GradientType is set to Discrete.

Optional joinStyle

joinStyle: "Round" | "Bevel" | "Miter"

How the symbol is drawn at the stroke segment connections.

Optional lineStyle3D

lineStyle3D: "Tube" | "Strip" | "Wall"

How strokes will be rendered in 3D.

Optional miterLimit

miterLimit: number

The maximum 'sharpness' that is allowed for Miter joins. If the spike created by the miter join exceeds the miter limit times the width of the stroke, the sharp angle will be clipped and rendered with a bevel join. This property is only applied to the symbol layer when the JoinType is set to Miter.

Optional name

name: string

The internal name of the symbol layer used for symbol level drawing.

Optional overprint

overprint: boolean

A value indicating whether or not the symbol layer should overprint in press printing.

Optional primitiveName

primitiveName: string

The primitive name.

type

type: "CIMGradientStroke"

Optional width

width: number

The width of the stroke.

Generated using TypeDoc