MosaicRule Class

  • MosaicRule
  • class Esri::ArcGISRuntime::MosaicRule

    A rule determining how a requested image should participate in the mosaic. More...

    Header: #include <MosaicRule.h>
    Since: Esri::ArcGISRuntime 100.9
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    MosaicRule(QObject *parent = nullptr)
    virtual ~MosaicRule() override
    bool isAscending() const
    Esri::ArcGISRuntime::RenderingRule *itemRenderingRule() const
    QList<qint64> lockRasterIds() const
    Esri::ArcGISRuntime::MosaicMethod mosaicMethod() const
    Esri::ArcGISRuntime::MosaicOperation mosaicOperation() const
    QList<qint64> rasterIds() const
    void setAscending(bool ascending)
    void setItemRenderingRule(Esri::ArcGISRuntime::RenderingRule *itemRenderingRule)
    void setLockRasterIds(const QList<qint64> &lockRasterIds)
    void setMosaicMethod(Esri::ArcGISRuntime::MosaicMethod mosaicMethod)
    void setMosaicOperation(Esri::ArcGISRuntime::MosaicOperation mosaicOperation)
    void setRasterIds(const QList<qint64> &rasterIds)
    void setSortField(const QString &sortField)
    void setSortValue(const QString &sortValue)
    void setViewpoint(const Esri::ArcGISRuntime::Viewpoint &viewpoint)
    void setWhereClause(const QString &whereClause)
    QString sortField() const
    QString sortValue() const
    Esri::ArcGISRuntime::Viewpoint viewpoint() const
    QString whereClause() const

    Detailed Description

    An image service uses a mosaic rule to mosaic multiple rasters on-the-fly. A mosaic rule parameter is used by many image service operations, such as export image and identify operations.

    Member Function Documentation

    [explicit] MosaicRule::MosaicRule(QObject *parent = nullptr)

    Creates a mosaic rule object.

    • parent - The optional parent QObject.

    [override virtual] MosaicRule::~MosaicRule()


    bool MosaicRule::isAscending() const

    Returns whether this MosaicRule is ascending.

    The default value is the value used when the mosaic data was created, if unavailable, the default value is true.

    Esri::ArcGISRuntime::RenderingRule *MosaicRule::itemRenderingRule() const

    Returns rendering rule applied on items before mosaic operation.

    See also setItemRenderingRule().

    QList<qint64> MosaicRule::lockRasterIds() const

    Returns the collection of raster IDs for image service rasters forced to be visible at all scales.

    Used with MosaicMethod::LockRaster. Cannot be greater than the maximum mosaic image count of the service.

    See also setLockRasterIds().

    Esri::ArcGISRuntime::MosaicMethod MosaicRule::mosaicMethod() const

    Returns the type of mosaic method used for individual images.

    The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicMethod::None.

    See also setMosaicMethod().

    Esri::ArcGISRuntime::MosaicOperation MosaicRule::mosaicOperation() const

    Returns the mosaic operation used to resolve overlapped pixel values.

    The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicOperation::First.

    See also setMosaicOperation().

    QList<qint64> MosaicRule::rasterIds() const

    Returns the collection of raster IDs specifying a subset of rasters used in the mosaic.

    Any of the specified rasters may not be visible at all scales.

    See also setRasterIds().

    void MosaicRule::setAscending(bool ascending)

    Sets ascending to ascending.

    See also isAscending.

    void MosaicRule::setItemRenderingRule(Esri::ArcGISRuntime::RenderingRule *itemRenderingRule)

    Sets the itemRenderingRule to itemRenderingRule.

    See also itemRenderingRule.

    void MosaicRule::setLockRasterIds(const QList<qint64> &lockRasterIds)

    Sets the lockRasterIds to lockRasterIds.

    See also lockRasterIds.

    void MosaicRule::setMosaicMethod(Esri::ArcGISRuntime::MosaicMethod mosaicMethod)

    Sets the mosaicMethod to mosaicMethod.

    See also mosaicMethod.

    void MosaicRule::setMosaicOperation(Esri::ArcGISRuntime::MosaicOperation mosaicOperation)

    Sets the mosaicOperation to mosaicOperation.

    See also mosaicOperation.

    void MosaicRule::setRasterIds(const QList<qint64> &rasterIds)

    Sets the rasterIds to rasterIds.

    See also rasterIds.

    void MosaicRule::setSortField(const QString &sortField)

    Sets the sortField to sortField.

    See also sortField.

    void MosaicRule::setSortValue(const QString &sortValue)

    Sets the sortValue to sortValue.

    See also sortValue.

    void MosaicRule::setViewpoint(const Esri::ArcGISRuntime::Viewpoint &viewpoint)

    Sets the viewpoint to viewpoint.

    See also viewpoint.

    void MosaicRule::setWhereClause(const QString &whereClause)

    Sets the whereClause to whereClause.

    See also whereClause.

    QString MosaicRule::sortField() const

    Returns the field name used together with MosaicMethod::Attribute method.

    See also setSortField().

    QString MosaicRule::sortValue() const

    Returns the base sort value used together with MosaicMethod::Attribute method and sortField parameter.

    See also setSortValue().

    Esri::ArcGISRuntime::Viewpoint MosaicRule::viewpoint() const

    Returns the viewpoint used along with MosaicMethod::Viewpoint method.

    See also setViewpoint().

    QString MosaicRule::whereClause() const

    Returns the SQL WHERE clause to define a subset of rasters used in the mosaic.

    Any of the rasters in the subset may not be visible at all scales.

    See also setWhereClause().

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