Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CIMPictureMarker

Represents a picture marker created from a raster (bitmapped) image file. The image can have color substitutions to replace one or more colors in the image or it can have a tint applied to the whole image depending on the picture type. Supported formats are .bmp, .jpg, .png, and .gif.

Read more...

Hierarchy

Index

Properties

Optional anchorPoint

The specified location where all transformation property operations originate.

Optional anchorPointUnits

anchorPointUnits: "Relative" | "Absolute"

A value which specifies if the anchor point location is considered a percentage of the size or as an absolute distance.

Optional angleX

angleX: number

The angle the marker is rotated around the X axis. This type of rotation is also referred to as tilt and is only applied in 3D. The order of how this is applied with respect to other rotations depends on the RotationOrder3D. The name in the user interface is Tilt.

Optional angleY

angleY: number

The angle the marker is rotated around the Y axis. This type of rotation is also referred to as roll and is only applied in 3D. The order of how this is applied with respect to other rotations depends on the RotationOrder3D. The name in the user interface is Roll.

Optional billboardMode3D

billboardMode3D: "None" | "SignPost" | "FaceNearPlane"

The billboard mode of the marker.

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 colorSubstitutions

colorSubstitutions: CIMColorSubstitution[]

The color substitutions for the picture.

Optional depth3D

depth3D: number

The depth of the image when drawn in 3D.

Optional dominantSizeAxis3D

dominantSizeAxis3D: "Z" | "X" | "Y"

Which axis is considered as the Size in 3D. Only applicable when the marker layer is a 3DShapeMarker.

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 invertBackfaceTexture

invertBackfaceTexture: boolean

A value indicating whether the image is right-reading when viewed from behind.

Optional markerPlacement

markerPlacement: CIMMarkerPlacementType

Marker placements which determine how markers are placed along a line or within a polygon.

Optional name

name: string

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

Optional offsetX

offsetX: number

The value the marker is moved along the X axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation.

Optional offsetY

offsetY: number

The value the marker is moved along the Y axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation.

Optional offsetZ

offsetZ: number

The value the marker is moved along the Z axis from the anchor point. This is applied after all rotation, as opposed to anchor point which is applied before the rotation.

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.

Optional rotateClockwise

rotateClockwise: boolean

A value indicating whether the rotation is applied clockwise or counterclockwise to the marker layer.

Optional rotation

rotation: number

The angle that the marker is rotated around the anchor point, in degrees.

Optional scaleX

scaleX: number

The scale X which changes the width of the symbol without changing the height (or depth in 3D), as a ratio.

Optional size

size: number

The height of the marker. Modifying Size changes the marker's height to the specified size and the width is updated proportionally.

Optional textureFilter

textureFilter: "Draft" | "Picture" | "Text"

How the image is resampled.

Optional tintColor

tintColor: 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.

type

type: "CIMPictureMarker"

Optional url

url: string

The image that is used in the symbol layer. Typically a base64 encoded image.

Optional verticalOrientation3D

verticalOrientation3D: boolean

A value indicating whether the marker stands upright as though locked in place. The marker can be viewed from all angles.

Generated using TypeDoc