HorizontalVerticalTransformationStep QML Type

  • Esri.ArcGISRuntime
  • HorizontalVerticalTransformationStep
  • Represents a step in the process of transforming between horizontal and/or vertical datums. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.9





    • bool equals(HorizontalVerticalTransformationStep other)

    Detailed Description

    Each HorizontalVerticalTransformationStep can be constructed from a well-known ID (WKID) that represents a horizontal (geographic) or a vertical transformation. This API supports thousands of predefined transformations, and all the supported WKIDs are documented in the 'Coordinate systems and transformations' topic in the developers guide.

    One or more HorizontalVerticalTransformationStep objects are combined into a HorizontalVerticalTransformation object, and can then be used to control how coordinates are transformed in a GeometryEngine.projectWithDatumTransformation method call.

    A HorizontalVerticalTransformationStep object is immutable.

    See also HorizontalVerticalTransformation and HorizontalVerticalTransformationStep.

    Property Documentation

    inverse : bool

    Returns whether this horizontal-vertical transformation step instance is an inverted transformation.

    Transformations have a specific direction indicated by the HorizontalVerticalTransformationStep::wkText value. An inverted transformation is used to transform geometries in the opposite direction from that indicated by the well-known text. HorizontalVerticalTransformationStep has DatumTransformation::inputSpatialReference and DatumTransformation::outputSpatialReference properties that respect the inverse value of the contained transformation(s).

    Returns true if this step uses the inverse of the horizontal-vertical transformation contained in this step.

    You cannot change this property after the object is instantiated.

    [read-only] inverseTransformation : HorizontalVerticalTransformationStep

    Returns the inverse of this transformation step or null if the transformation is not invertible. (read-only).

    [read-only] missingProjectionEngineFiles : bool

    True if any files needed by the Projection Engine for this transformation step are missing from the local file system (read-only).

    [read-only] projectionEngineFilenames : list<string>

    A list of the Projection Engine files required to support this transformation step (read-only).

    Each name in the list includes the full path. Projection Engine datasets are used in grid-based transforms.

    wkText : string

    The well-known text (WKT) representation of the horizonal-vertical transformation in this step.

    Returns an empty string if no WKT has been specified or if the horizonal-vertical transformation is invalid.

    This method always returns the minimal text representation that uniquely identifies a given horizonal-vertical transformation.

    You cannot change this property after the object is instantiated.

    wkid : int

    The well-known ID or 0 if the transformation in this step does not have a well-known ID.

    Occasionally, WKIDs may change, and older codes may be deprecated in favor of a new code. Both old (deprecated) and new (latest) WKIDs continue to work for instantiation, as long as they are supported by the Projection Engine. The HorizontalVerticalTransformationStep::wkid property will return the new (latest) WKID code.

    -1 on error.

    Signal Documentation


    Emitted when the inverse property changes.

    Note: The corresponding handler is onInverseChanged.


    Emitted when the wkText property changes.

    Note: The corresponding handler is onWkTextChanged.


    Emitted when the wkid property changes.

    Note: The corresponding handler is onWkidChanged.

    Method Documentation

    compares this horizontal-vertical transformation step against the other.

    Returns true if they are equal.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.