Base interface for a border icon style.

Hierarchy

Properties

anchorX?: string

The x coordinate of the anchor for this icon. This can be either percentage or pixels. Example: "16px", or "50%". The default is "50%", which implies that the anchor-point is at the center of the image.

The anchor is always defined with respect to the original image size. This means that a scaled image will automatically have its anchor-point scaled.

The horizontal anchorpoint is always defined from left to right. { anchorX:"0px" } is the left of the image, and positive values are points to the right.

anchorY?: string

The y coordinate of the anchor for this icon. This can be either percentage or pixels. Example: "16px", or "50%". The default is "50%", which implies that the anchor-point is at the center of the image.

The anchor is always defined with respect to the original image size. This means that a scaled image will automatically have its anchor-point scaled.

The vertical anchorpoint is always defined from top to bottom. { anchorY:"0px" } is the top of the image, and positive values are points to the bottom.

height?: string

The target height of the image, with a given unit of measure. This can be either percentage or pixels. Example: "16px", or "50%". The default is "100%", which implies that the icon is painted at its original resolution.

offsetX?: number

The X offset in pixels that should be applied with respect to the location of the point. This offset is applied after rotation and does not take into account any scaling performed on the image. The default is 0, which means that the icon is painted at its anchor-point.

offsetY?: number

The Y offset in pixels that should be applied with respect to the location of the point. This offset is applied after rotation and does not take into account any scaling performed on the image. The default is 0, which means that the icon is painted at its anchor-point.

rotation?: number

The rotation of the icon, specified in degrees. The default is 0, which implies no rotation to the original icon. Rotations are applied in a clock-wise fashion. Rotation of the icon happens around its anchor-point.

stem?: LineStyle

The line-style of a line which connects the border with the position of the feature on the map, using a perpendicular line.

width?: string

The target width of the image, with a given unit of measure. This can be either percentage or pixels. Example: "16px", or "50%". The default is "100%", which implies that the icon is painted at its original resolution.

zOrder?: number

The Z-order of this shape. Shapes will be painted from lowest to highest Z-order, so that shapes with a higher Z-order are painted on top of shapes with a lower Z-order. The default value is 0.