Description

Gets or sets the per-batch pixel offset, which is applied to each marker in the batch. The array contains one x pixel offset followed by one y pixel offset.

Property type

Read-write property

Syntax

[Visual Basic .NET]
Public Property PixelOffset() As System.Array

[C#]
public System.Array PixelOffset {get; set;}

[Managed C++]
public: __property System::Array get_PixelOffset(); public: __property void set_PixelOffset( System::Array );

[Managed C++]

public: __property System::Array get_PixelOffset();
public: __property void set_PixelOffset(
    System::Array
);

[Unmanaged C++]
public: HRESULT get_PixelOffset( SAFEARRAY * * ppRetVal ); public: HRESULT put_PixelOffset( SAFEARRAY * PixelOffset );

[Unmanaged C++]

public: HRESULT get_PixelOffset(
    SAFEARRAY * * ppRetVal
);
public: HRESULT put_PixelOffset(
    SAFEARRAY * PixelOffset
);

[Java]
public AgSafeArray getPixelOffset(); public void setPixelOffset( AgSafeArray );

[Python - STK API ]
@property def PixelOffset(self) -> list: @PixelOffset.setter def PixelOffset(self, PixelOffset:list) -> None:

[Python - STK API

]

@property
def PixelOffset(self) -> list:

@PixelOffset.setter
def PixelOffset(self, PixelOffset:list) -> None:

Remarks

The pixel offset defines a screen-space translation for a marker from its position. Positive x values translate to the right and positive y values translate up. This is commonly used when more than one primitive is located at the same position. For example, if a marker in a marker batch and a point in a point batch have the same position, the marker may have a pixel offset applied to it so it doesn't overlap the point.

If per-marker pixel offsets were specified with MarkerBatchPrimitiveOptionalParameters.SetPixelOffsets, the per-batch pixel offset is ignored.

Example

Shows the format of the marker batch's PixelOffset property.

[C#]

Array pixelOffset = new object[]
{
    1,
    2
};

markerBatch.PixelOffset = pixelOffset;