Serialized Form

  • Package com.supermap.iportal.web.commontypes

    • Class com.supermap.iportal.web.commontypes.AccessCountSearchParameter extends java.lang.Object implements Serializable

    • Class com.supermap.iportal.web.commontypes.AppSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • userNames

          java.lang.String[] userNames
          
          Search by app registrant name. Default query all
        • tags

          java.lang.String[] tags
          
          Filter by tags.
        • type

          IportalApp.AppType type
          
          Filter by application type.
        • currentUser

          User currentUser
          
          Filter by current logged in user.
        • orderBy

          AppSearchParameter.AppOrderBy orderBy
          
          Filter by order type.
        • filterFields

          AppSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • groupIds

          java.lang.Integer[] groupIds
          
          The groupIds that the current user joined, which obtained from back-end. If the front-end passed this parameter, it will be withdrawn.
        • departmentIds

          java.lang.Integer[] departmentIds
          
          The groupIds to which the current user belongs to, which obtained from back-end. If the front-end passed this parameter, it will be withdrawn.
        • createStart

          java.lang.Long createStart
          
          Query apps created at this time value or after this time value. If the value is null or less than 0, the start time for app queries is not limited.
          Since:
          8.1.1
        • createEnd

          java.lang.Long createEnd
          
          Query apps created earlier than or at this time value. If the value is null or less than 0, the end time for app queries is not limited.
          Since:
          8.1.1
    • Class com.supermap.iportal.web.commontypes.BasicDirInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          

          Directory id

          Since:
          8.0.0
        • dirName

          java.lang.String dirName
          

          Directory name

          Since:
          8.0.0
        • dirType

          BasicDirInfo.DirectoryResourceType dirType
          

          Directory type

          Since:
          8.0.0
        • icon

          java.lang.String icon
          

          Directory icon

          Since:
          8.0.0
        • dirCreator

          java.lang.String dirCreator
          

          Directory creator

          Since:
          8.0.0
        • description

          java.lang.String description
          

          Directory description information

          Since:
          8.0.0
        • dirLevel

          java.lang.Integer dirLevel
          

          Directory level

          Since:
          8.0.0
        • parentDirId

          java.lang.Integer parentDirId
          

          id of parent directory

          Since:
          8.0.0
        • createTime

          java.lang.Long createTime
          

          The created time of directory

          Since:
          8.0.0
        • updateTime

          java.lang.Long updateTime
          

          The update time of the directory

          Since:
          8.0.0
        • weight

          java.lang.Integer weight
          
          Directory weight
        • isPersonal

          boolean isPersonal
          
          Whether the directory is a personal private directory. When this parameter is false, it means a public directory created in directory management to manage the resources of all users. When this parameter is true, it means that the directory is used to manage the resources it creates.
        • resourceCount

          java.lang.Integer resourceCount
          
          The current directory contains the number of resources, depending on the parameter settings, but also can include the number of sub-directory resources.
    • Class com.supermap.iportal.web.commontypes.BuilderSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          The ID value of the builder
        • userNames

          java.lang.String[] userNames
          
          Create a name query based on builder. Default query all
        • currentUser

          User currentUser
          
          The current login user.
        • nickname

          java.lang.String nickname
          
          User nickname
        • orderBy

          BuilderSearchParameter.BuilderOrderBy orderBy
          
          Sort type. TODO change field name
        • filterFields

          BuilderSearchParameter.FilterField[] filterFields
          
          Keyword query Field filter TODO change field name
        • updateStart

          java.lang.Long updateStart
          
          Queries the updated application in this time or later. If it is null or less than 0, the start time is no limit.
        • updateEnd

          java.lang.Long updateEnd
          
          Queries the updated application in this time or before. If it is null or less than 0, the deadline is no limit.
    • Class com.supermap.iportal.web.commontypes.CheckInfoSearchParameter extends SearchParameter implements Serializable

    • Class com.supermap.iportal.web.commontypes.DataCapacityInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • maxCapacity

          long maxCapacity
          

          Maximum capacity. The default maximum capacity of each user is 2G.

          Since:
          7.0.1
        • usedCapacity

          long usedCapacity
          

          Used capacity.

          Since:
          7.0.1
    • Class com.supermap.iportal.web.commontypes.DataItemSearchParameter extends ResourceSearchParameter implements Serializable

      • Serialized Fields

        • ids

          java.lang.Integer[] ids
          
          ids
        • tags

          java.lang.String[] tags
          
          Filter by tags.
        • userNames

          java.lang.String[] userNames
          
          Query by the data author name. The default is query all.
        • types

          DataItem.DataItemType[] types
          

          Query by the data type.

        • userName

          java.lang.String userName
          
          Deprecated. 
        • fileName

          java.lang.String fileName
          
          File name.
        • type

          DataItem.DataItemType type
          
          Deprecated. 

        • orderBy

          DataItemSearchParameter.DataItemOrderBy orderBy
          
          Sort field.
        • serviceStatuses

          DataItem.ServiceStatus[] serviceStatuses
          
          Deprecated. (Expired. Service publishing status)
        • serviceId

          java.lang.String serviceId
          
          Deprecated. (Expired. Service id)
        • isPublic

          java.lang.Boolean isPublic
          
          Whether querying the public data
        • status

          StoredItemInfo.Status status
          
          Data status
        • md5s

          java.lang.String[] md5s
          
          MD5 value of the data
        • filterFields

          DataItemSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • createStart

          java.lang.Long createStart
          
          Query data created at this time value or after this time value. If the value is null or less than 0, the start time for data queries is not limited.
          Since:
          8.1.1
        • createEnd

          java.lang.Long createEnd
          
          Query data created earlier than or at this time value. If the value is null or less than 0, the end time for data queries is not limited.
          Since:
          8.1.1
    • Class com.supermap.iportal.web.commontypes.DataItemServiceCheckInfo extends java.lang.Object implements Serializable

      • Serialized Fields

    • Class com.supermap.iportal.web.commontypes.DataMetaInfo extends java.lang.Object implements Serializable

    • Class com.supermap.iportal.web.commontypes.DataPublishInfo extends java.lang.Object implements Serializable

    • Class com.supermap.iportal.web.commontypes.DepartmentResourceParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • departmentId

          java.lang.Integer departmentId
          
          The department id. It is got from background, and does not support the front end.
        • resourceType

          ResourceEntity.ResourceType resourceType
          
          The department resource type filter, for example, query the map, services or scenes in the department.
        • orderBy

          DepartmentResourceParameter.OrderBy orderBy
          
          Sort type.
    • Class com.supermap.iportal.web.commontypes.DirectorySearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • dirLevel

          java.lang.Integer dirLevel
          

          Directory level

          Since:
          8.0.0
        • parentDirId

          java.lang.Integer parentDirId
          

          Parent directory id

          Since:
          8.0.0
        • dirType

          BasicDirInfo.DirectoryResourceType dirType
          

          Directory type

          Since:
          8.0.0
        • orderBy

          DirectorySearchParameter.DirOrderBy orderBy
          

          The filter of directory sorting

          Since:
          8.0.0
        • isPersonal

          boolean isPersonal
          
          Query open or private directory, true for the query private directory, false for the query open directory.
        • dirCreator

          java.lang.String dirCreator
          
          Directory creator filter.
        • queryResourceCount

          boolean queryResourceCount
          
          Whether the query directory includes the number of resources.
        • querySubDirResourceCount

          boolean querySubDirResourceCount
          
          The number of resources that contain subdirectories when querying the number of resources in the current directory.
        • queryPublicResource

          boolean queryPublicResource
          
          Whether to query only public resources.
    • Class com.supermap.iportal.web.commontypes.DirResSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • resourceName

          java.lang.String resourceName
          

          Queries by resource name.

          Since:
          8.0.0
        • currentUser

          User currentUser
          

          Currently logged in user. Get from the back-end. The parameter passed from front-end will be discarded.

          Since:
          8.0.0
        • type

          BasicDirInfo.DirectoryResourceType type
          

          Directory resource type.

          Since:
          8.0.0
    • Class com.supermap.iportal.web.commontypes.GroupApplyParameter extends SearchParameter implements Serializable

    • Class com.supermap.iportal.web.commontypes.GroupBasicInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          

          Group ID

          Since:
          7.1.0
        • groupName

          java.lang.String groupName
          

          Group name

          Since:
          7.1.0
        • icon

          java.lang.String icon
          

          Group icon

          Since:
          7.1.0
        • isEnabled

          java.lang.Boolean isEnabled
          

          The group status: true for enable, false for disable

          Since:
          7.1.0
        • isPublic

          java.lang.Boolean isPublic
          

          The group type: true for public, false for private

          Since:
          7.1.0
        • description

          java.lang.String description
          

          Group description

          Since:
          7.1.0
        • resourceSharer

          GroupRole resourceSharer
          

          The group resource sharer

          Since:
          7.1.0
        • isNeedCheck

          java.lang.Boolean isNeedCheck
          

          Whether the application of joining groups need to be audited

          Since:
          7.1.0
        • creator

          java.lang.String creator
          

          The group creator

          Since:
          7.1.0
        • nickname

          java.lang.String nickname
          
          The nickname of Creator
        • createTime

          java.lang.Long createTime
          

          The time at which the group was created.

          Since:
          7.1.0
        • updateTime

          java.lang.Long updateTime
          

          The time at which the group was updated.

          Since:
          7.1.0
    • Class com.supermap.iportal.web.commontypes.GroupInviteParameter extends SearchParameter implements Serializable

    • Class com.supermap.iportal.web.commontypes.GroupMember extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          Group member ID
        • groupId

          java.lang.Integer groupId
          
          Group ID
        • groupRole

          GroupRole groupRole
          
          The members in the group
        • userName

          java.lang.String userName
          
          Group member name
        • nickname

          java.lang.String nickname
          
          Group member nickname
        • joinTime

          java.lang.Long joinTime
          
          Join time
        • roleUpdateTime

          java.lang.Long roleUpdateTime
          
          Change time of the role
        • memberDescription

          java.lang.String memberDescription
          
          Member description
    • Class com.supermap.iportal.web.commontypes.GroupMemberParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • groupId

          java.lang.Integer groupId
          
          Group ID
        • userName

          java.lang.String userName
          
          Group member name
        • groupRole

          GroupRole groupRole
          
          The members in the group
        • orderBy

          GroupMemberParameter.MemberOrderBy orderBy
          
          The sort type of the group member
        • currentUser

          User currentUser
          
          Current user
    • Class com.supermap.iportal.web.commontypes.GroupMembersSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • groupId

          java.lang.Integer groupId
          
          Group ID
        • memberIds

          java.util.ArrayList<E> memberIds
          
          Group member id set
        • groupRole

          GroupRole groupRole
          
          The members in the group
    • Class com.supermap.iportal.web.commontypes.GroupResourceParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • groupId

          java.lang.Integer groupId
          
          Group id
        • resourceId

          java.lang.Integer resourceId
          
          Resource id
        • resourceName

          java.lang.String resourceName
          
          Resource name
        • groupResourceType

          ResourceEntity.ResourceType groupResourceType
          
          Group resource type
        • currentUser

          User currentUser
          
          Current user
        • resourceCreator

          java.lang.String resourceCreator
          
          The resource creator
        • tags

          java.lang.String[] tags
          
          Tags for filtering group resource
        • orderBy

          GroupResourceParameter.ResourceOrderBy orderBy
          
          Sort type
    • Class com.supermap.iportal.web.commontypes.GroupSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • tags

          java.lang.String[] tags
          
          Queries by group tag, searching all groups by default
        • userNames

          java.lang.String[] userNames
          
          Queries according to group creator, searching all groups by default
        • isPublic

          java.lang.Boolean isPublic
          
          Whether to filter groups by the public status
        • isEnabled

          java.lang.Boolean isEnabled
          
          Whether to filter groups by the enable or disabled status
        • orderBy

          GroupSearchParameter.GroupOrderBy orderBy
          
          Filter according to the group order type
        • joinTypes

          GroupSearchParameter.JoinType[] joinTypes
          
          Filter according to the group list type
        • currentUser

          User currentUser
          
          Current user
        • returnCreate

          java.lang.Boolean returnCreate
          
          The parameters of back-end encapsulatied: created
        • returnJoined

          java.lang.Boolean returnJoined
          
          The parameters of back-end encapsulatied: joined
        • returnCanJoin

          java.lang.Boolean returnCanJoin
          
          The parameters of back-end encapsulatied: can be joined
        • filterFields

          GroupSearchParameter.FilterField[] filterFields
          
          Query by keyword.
    • Class com.supermap.iportal.web.commontypes.InsightsWorkspaceSearchParameter extends ResourceSearchParameter implements Serializable

      • Serialized Fields

        • userNames

          java.lang.String[] userNames
          
          Search by registrant name. Default query all
        • tags

          java.lang.String[] tags
          
          Filter by tags.
        • orderBy

          InsightsWorkspaceSearchParameter.InsightsOrderBy orderBy
          
          Sort type
        • filterFields

          InsightsWorkspaceSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • createStart

          java.lang.Long createStart
          
          Query apps created at this time value or after this time value. If the value is null or less than 0, the start time for app queries is not limited.
        • createEnd

          java.lang.Long createEnd
          
          Query apps created earlier than or at this time value. If the value is null or less than 0, the end time for app queries is not limited.
    • Class com.supermap.iportal.web.commontypes.KeyInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          int id
          

          Key ID

          The parameters created by the server

        • key

          java.lang.String key
          

          The Key random code corresponding to this service instance

          The parameters created by the server

          Since:
          7.1.0
        • name

          java.lang.String name
          
          Key name
        • keyType

          KeyInfo.KeyType keyType
          
          key type. Refer to KeyInfo.KeyType
        • userName

          java.lang.String userName
          

          Creates the Key username

          Since:
          7.1.0
        • serviceIds

          java.lang.String serviceIds
          

          Alllows all service id

          Since:
          7.1.0
        • clientType

          KeyInfo.ClientType clientType
          
          Accesses the service client type
        • limitation

          java.lang.String limitation
          

          Allows to access the restrict string of this service instance. The restrictions are different in the different clients.

          Service request: Request source IP address

          Web: source stop referer

          Mobile: Mobile id

          Since:
          7.1.0
    • Class com.supermap.iportal.web.commontypes.KeyProcessException extends java.lang.Exception implements Serializable

    • Class com.supermap.iportal.web.commontypes.KeySearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • userName

          java.lang.String userName
          
          The owner username
        • types

          KeyInfo.KeyType[] types
          
          key type
    • Class com.supermap.iportal.web.commontypes.MapInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          Map ID.
        • serviceId

          java.lang.Integer serviceId
          
          Service id
        • mapTitle

          java.lang.String mapTitle
          
          the map name.
        • mapUrl

          java.lang.String mapUrl
          
          Map address.
        • mapThumbnail

          java.lang.String mapThumbnail
          
          Map thumbnail address.
    • Class com.supermap.iportal.web.commontypes.MapSearchParameter extends ResourceSearchParameter implements Serializable

      • Serialized Fields

        • userNames

          java.lang.String[] userNames
          
          Query by the map author name. The default is query all.
        • tags

          java.lang.String[] tags
          
          Query by the map tag. The default is query all.
        • suggest

          java.lang.Boolean suggest
          
          Filter according to whether it is the default basemap. The default is query all.
        • sourceTypes

          SourceType[] sourceTypes
          
          Filter according to map resource type. The default is query all.
        • mapStatus

          MapSearchParameter.ViewerMapStatus mapStatus
          
          Deprecated. 
        • permitInstances

          java.lang.String[] permitInstances
          
          List of service instances allowed to access, obtained from back-end. If passed from front-end, it will be discarded.
        • unique

          java.lang.Boolean unique
          
          If a map has multiple types, for example, the REST, WMS and WMTS, whether to choose one type according to the priority (REST>WMS>WMTS).
        • epsgCode

          java.lang.Integer epsgCode
          
          epsgCode. It is used when get the specified projection
        • excludeIds

          java.lang.Integer[] excludeIds
          
          List of excluded map IDs.
        • updateStart

          java.lang.Long updateStart
          
          Query maps created at this time value or after this time value. If the value is null or less than 0, the start time for map queries is not limited.
        • updateEnd

          java.lang.Long updateEnd
          
          Query maps created earlier than or at this time value. If the value is null or less than 0, the end time for map queries is not limited.
        • visitStart

          java.lang.Long visitStart
          
          Query maps created at this time value or after this time value. If the value is null or less than 0, the start time for map queries is not limited.
        • visitEnd

          java.lang.Long visitEnd
          
          Query maps created earlier than or at this time value. If the value is null or less than 0, the end time for map queries is not limited.
        • filterFields

          MapSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • checkStatus

          CheckStatus checkStatus
          
          Audit status
          Since:
          8.1.0
        • createStart

          java.lang.Long createStart
          
          Query maps created at this time value or after this time value. If the value is null or less than 0, the start time for map queries is not limited.
          Since:
          8.1.1
        • createEnd

          java.lang.Long createEnd
          
          Query maps created earlier than or at this time value. If the value is null or less than 0, the end time for map queries is not limited.
          Since:
          8.1.1
    • Class com.supermap.iportal.web.commontypes.MessageParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • type

          MessageType type
          

          Query according to the message type.

          Since:
          7.1.0
        • status

          MessageStatus status
          
          Deprecated. 

          Query according to the message status.

          Since:
          7.1.0
        • statuses

          MessageStatus[] statuses
          
          Query according to message status.
        • objectType

          MessageObjectType objectType
          
          Deprecated. 

          Query according to specific message object type. It is recommended to use the objectTypes field.

          Since:
          7.1.0
        • objectTypes

          MessageObjectType[] objectTypes
          
          Filter according to the message object type.
        • objectId

          java.lang.Integer objectId
          

          Query according to the id of the message object type.

          Since:
          7.1.0
        • receiver

          java.lang.String receiver
          

          The message receiver.

          Since:
          7.1.0
    • Class com.supermap.iportal.web.commontypes.OnlineUserSearchParameter extends SearchParameter implements Serializable

    • Class com.supermap.iportal.web.commontypes.ProxyCookieContent extends java.lang.Object implements Serializable

      • Serialized Fields

        • userName

          java.lang.String userName
          
          The user name of current iportal login.
        • roles

          java.lang.String[] roles
          
          The user role of current login.
        • rememberme

          boolean rememberme
          
          Whether to remember me when login.
        • lastAccessTime

          long lastAccessTime
          
          The latest time that users access. The unit is millisecond.
    • Class com.supermap.iportal.web.commontypes.ResContributorParameter extends SearchParameter implements Serializable

    • Class com.supermap.iportal.web.commontypes.ResourceSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • currentUser

          User currentUser
          

          Current user

          Since:
          8.0.0
        • dirIds

          java.lang.Integer[] dirIds
          
          Directory ids
        • returnSubDir

          java.lang.Boolean returnSubDir
          
          Whether to query the resources of the subdirectory. true means returning the resources under the current query directory and its subdirectories; false means only the resources under the current query directory will be returned.
        • isNotInDir

          java.lang.Boolean isNotInDir
          
          Ungroup: query the resources that are not added to the directory (true: not added)
        • groupIds

          java.lang.Integer[] groupIds
          
          The groupIds that the current user joined, which obtained from back-end. If the front-end passed this parameter, it will be withdrawn.
        • departmentIds

          java.lang.Integer[] departmentIds
          
          The groupIds to which the current user belongs to, which obtained from back-end. If the front-end passed this parameter, it will be withdrawn.
        • resourceIds

          java.lang.Integer[] resourceIds
          
          Resource ids under directory, which obtained from back-end. The parameter passed from front-end will be discarded.
    • Class com.supermap.iportal.web.commontypes.ResOverviewInfoParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • createStart

          java.lang.Long createStart
          
          Statistics the resources created with this parameter as the start time. If less than 0, the start time is not limited.
        • createEnd

          java.lang.Long createEnd
          
          Statistics the resources created with this parameter as the cutoff time. If less than 0, the cut-off time is not limited.
        • orderBy

          ResOverviewInfoParameter.ResOverviewInfoOrderBy orderBy
          
          Sorting column [optional]
        • userNames

          java.lang.String[] userNames
          
          Search by resource contributor name. Default query all
    • Class com.supermap.iportal.web.commontypes.ResVisitDetailParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • resourceType

          ResourceEntity.ResourceType resourceType
          
          The resource type to be queried. [Required]
        • resourceId

          java.lang.Integer resourceId
          
          The id of the resource to be queried [optional]
        • startTime

          java.lang.Long startTime
          
          Resource access start time [Optional]
        • endTime

          java.lang.Long endTime
          
          Resource access deadline [optional]
        • orderBy

          ResVisitDetailParameter.ResVisitDetailOrderBy orderBy
          
          Sorting field [optional]
    • Class com.supermap.iportal.web.commontypes.ResVisitorParameter extends SearchParameter implements Serializable

      • Serialized Fields

    • Class com.supermap.iportal.web.commontypes.SceneSearchParameter extends ResourceSearchParameter implements Serializable

      • Serialized Fields

        • tags

          java.lang.String[] tags
          

          Query according to the scene tag

          Since:
          8.0.0
        • orderBy

          SceneSearchParameter.SceneOrderBy orderBy
          

          Field for using order by statement

          Since:
          8.0.0
        • userNames

          java.lang.String[] userNames
          

          Query according to scene creator

          Since:
          8.0.0
        • filterFields

          SceneSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • createStart

          java.lang.Long createStart
          
          Query scenes created at this time value or after this time value. If the value is null or less than 0, the start time for scene queries is not limited.
          Since:
          8.1.1
        • createEnd

          java.lang.Long createEnd
          
          Query scenes created earlier than or at this time value. If the value is null or less than 0, the end time for scene queries is not limited.
          Since:
          8.1.1
    • Class com.supermap.iportal.web.commontypes.ServiceApplySearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • applicants

          java.lang.String[] applicants
          
          The applicant name of service application.
        • checkUsers

          java.lang.String[] checkUsers
          
          The auditing name of service application.
        • serviceRegisters

          java.lang.String[] serviceRegisters
          
          The service registrant.
        • serviceIds

          java.lang.Integer[] serviceIds
          
          The service to be registered.
        • applyStatuses

          ServiceApplyInfo.ServiceApplyStatus[] applyStatuses
          
          The status of service application.
        • currentUser

          User currentUser
          
          Current user. Got from back-end, if the front pass over to discard.
        • orderBy

          ServiceApplySearchParameter.ServiceApplyOrderBy orderBy
          
          The order method of the application form.
    • Class com.supermap.iportal.web.commontypes.ServiceGroup extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          The ID of service group
        • name

          java.lang.String name
          
          The name of service group
        • userName

          java.lang.String userName
          
          The owner username of service group
        • caption

          java.lang.String caption
          
          The title of service group
    • Class com.supermap.iportal.web.commontypes.ServiceInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          The id of registered service.
        • serviceRootUrlId

          java.lang.Integer serviceRootUrlId
          
          The service root address identification corresponding to the registered service.
        • resTitle

          java.lang.String resTitle
          
          Service name.
        • linkPage

          java.lang.String linkPage
          
          The service link address.
        • proxiedUrl

          java.lang.String proxiedUrl
          
          Proxied service address.
        • userName

          java.lang.String userName
          
          User identity.
        • nickname

          java.lang.String nickname
          
          User nickname
        • metadata

          Metadata metadata
          
          Service metadata info.
        • checkStatus

          CheckStatus checkStatus
          
          Audit status.
        • checkTime

          java.lang.Long checkTime
          
          Audit time.
          Since:
          8.1.0
        • verifyReason

          java.lang.String verifyReason
          
          Audit comments.
        • checkUser

          java.lang.String checkUser
          
          Auditor name.
        • checkUserNick

          java.lang.String checkUserNick
          
          Auditor nickname.
        • enable

          java.lang.Boolean enable
          
          Whether the service is available.
        • offline

          java.lang.Boolean offline
          
          Whether the service is offline.
        • type

          SourceType type
          
          Service type.
        • version

          java.lang.String version
          
          Service version, such as WMS 1.3.0.
        • isBatch

          java.lang.Boolean isBatch
          
          Whether it is registered in bulk.
        • createTime

          java.lang.Long createTime
          
          Service registration time.
        • updateTime

          java.lang.Long updateTime
          
          Update time.
        • description

          java.lang.String description
          
          The service description.
        • isDataItemService

          java.lang.Boolean isDataItemService
          
          Whether it is from registering the service via publishing user's data
        • thumbnail

          java.lang.String thumbnail
          
          The service thumbnail path.
        • visitCount

          java.lang.Integer visitCount
          
          Service visits.
    • Class com.supermap.iportal.web.commontypes.ServiceRegisterException extends java.lang.RuntimeException implements Serializable

    • Class com.supermap.iportal.web.commontypes.ServiceSceneInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.Integer id
          
          The record identification in the idenservicescenelist.
        • serviceId

          java.lang.Integer serviceId
          
          3D scene service.
        • sceneName

          java.lang.String sceneName
          
          3D scene name.
        • sceneUrl

          java.lang.String sceneUrl
          
          3D scene address.
    • Class com.supermap.iportal.web.commontypes.ServiceSearchParameter extends ResourceSearchParameter implements Serializable

      • Serialized Fields

        • tags

          java.lang.String[] tags
          
          Query by service tag, searching all services by default
        • userNames

          java.lang.String[] userNames
          
          Query by the service author name. The default is query all.
        • types

          SourceType[] types
          
          Query by service type, searching all services by default
        • checkStatus

          CheckStatus checkStatus
          
          Filter by audit status.
        • offline

          java.lang.Boolean offline
          
          Filter by whether the service is available.
        • isBatch

          java.lang.Boolean isBatch
          
          Filter by whether the service was registered in bulk.
        • orderBy

          ServiceSearchParameter.ServiceOrderBy orderBy
          
          Sort type
        • enable

          java.lang.Boolean enable
          
          Filter by whether the service is enabled.
        • filterFields

          ServiceSearchParameter.FilterField[] filterFields
          
          Query by keyword.
        • accessMode

          AccessMode accessMode
          
          Service access mode. Get from the back-end. The parameter passed from front-end will be discarded.
        • authorizedOnly

          java.lang.Boolean authorizedOnly
          
          Only query the authorized services. Default is false. Valid in V2 mode, ie., when enabling resource application function.
        • createStart

          java.lang.Long createStart
          
          Query services created at this time value or after this time value. If the value is null or less than 0, the start time for service queries is not limited.
          Since:
          8.1.1
        • createEnd

          java.lang.Long createEnd
          
          Query services created earlier than or at this time value. If the value is null or less than 0, the end time for service queries is not limited.
          Since:
          8.1.1
        • visitStart

          java.lang.Long visitStart
          
          Query visits of the service at this time value or after this time value. If the value is null or less than 0, the start time is not limited.
          Since:
          8.1.1
        • visitEnd

          java.lang.Long visitEnd
          
          Query visits of the service earlier than or at this time value. If the value is null or less than 0, the end time is not limited.
          Since:
          8.1.1
        • isDataItemService

          java.lang.Boolean isDataItemService
          
          Whether the service to be queried is from publishing user's data. null means not participating in filtering.
    • Class com.supermap.iportal.web.commontypes.StreamChunk extends java.lang.Object implements Serializable

    • Class com.supermap.iportal.web.commontypes.StreamChunkMetaInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • storageId

          java.lang.String storageId
          
          Storage id
        • sequence

          int sequence
          
          Order
        • size

          long size
          
          Size
    • Class com.supermap.iportal.web.commontypes.TagResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • tag

          java.lang.String tag
          
          Label name
        • counts

          int counts
          
          Using times
    • Class com.supermap.iportal.web.commontypes.UserDistributionSearchParameter extends SearchParameter implements Serializable

      • Serialized Fields

        • distributionTypeByRole

          DistributionTypeByRole distributionTypeByRole
          

          Query according to user's role

          Since:
          8.1.1
        • startTime

          java.lang.Long startTime
          

          Query the users joined the portal equal to or after startTime value.

          Since:
          8.1.1
        • endTime

          java.lang.Long endTime
          

          Query the users joined the portal before or equal to endTime value.

          Since:
          8.1.1
        • orderBy

          UserDistributionSearchParameter.Orderby orderBy
          

          Filter by order type.

          Since:
          8.1.1
    • Class com.supermap.iportal.web.commontypes.ValueExistsException extends java.lang.Exception implements Serializable

    • Class com.supermap.iportal.web.commontypes.WMTSOption extends java.lang.Object implements Serializable

      • Serialized Fields

        • requestEncoding

          java.lang.String requestEncoding
          
          Request encoding, can be "REST" or "KVP", the default is "KVP".
  • Package com.supermap.processing.jobserver.commontypes

    • Class com.supermap.processing.jobserver.commontypes.BuffersAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • distance

          java.lang.String distance
          
          Buffer distance.
        • distanceField

          java.lang.String distanceField
          
          Buffer distance field.
        • distanceUnit

          DistanceUnit distanceUnit
          
          Unit of buffer distance.
        • bounds

          java.lang.String bounds
          
          Buffer analysis bounds.
        • dissolveField

          java.lang.String dissolveField
          
          Dissolve field.
    • Class com.supermap.processing.jobserver.commontypes.BuildCacheDrawingSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • bounds

          java.lang.String bounds
          
          Cache range
        • level

          int level
          
          The cache scale level
        • imageType

          ImageType imageType
          
          The cache type
    • Class com.supermap.processing.jobserver.commontypes.BuildCacheInputDataSetting extends java.lang.Object implements Serializable

    • Class com.supermap.processing.jobserver.commontypes.BuildCacheOutputSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • cacheName

          java.lang.String cacheName
          
        • cacheType

          CacheType cacheType
          
    • Class com.supermap.processing.jobserver.commontypes.BuildGridIndexAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • indexFile

          java.lang.String indexFile
          
          The index file path
        • isSer

          boolean isSer
          
          Whether to use serialization file to store
        • bounds

          java.lang.String bounds
          
          Calculating extent
        • rows

          java.lang.String rows
          
          Number of grid index rows
        • cols

          java.lang.String cols
          
          Number of grid index columns
        • interval

          java.lang.String interval
          
          The external expansion tolerance for calculating grid partitions
    • Class com.supermap.processing.jobserver.commontypes.CSVInputDataSetting extends InputDataSetting implements Serializable

      • Serialized Fields

        • xIndex

          int xIndex
          
          The index of field x, such as: 10
        • yIndex

          int yIndex
          
          The index of field y, such as: 11
        • separator

          java.lang.String separator
          
          The separator
    • Class com.supermap.processing.jobserver.commontypes.DatabaseOutputSetting extends OutputSetting<DatabaseOutputSetting> implements Serializable

      • Serialized Fields

    • Class com.supermap.processing.jobserver.commontypes.DatasetInputDataSetting extends InputDataSetting implements Serializable

      • Serialized Fields

        • datasetInfo

          Named datasetInfo
          
        • datasetName

          java.lang.String datasetName
          
        • numSlices

          int numSlices
          
          The specified number of slices when distributing to read the dataset
        • specField

          java.lang.String specField
          
          Time attribute fields used when performing time feature join.
    • Class com.supermap.processing.jobserver.commontypes.FeatureJoinAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputJoin

          java.lang.String inputJoin
          
          Target dataset. Supports point, line and polygon.
        • datasetFeatureJoin

          java.lang.String datasetFeatureJoin
          
          Join dataset name.
        • joinOperation

          JoinOperation joinOperation
          
          Join methods, including JoinOneToOne and JoinOneToMany
        • joinFields

          java.lang.String joinFields
          
          Join fields from inputJoin data
        • spatialRelationship

          SpatialRelationShip spatialRelationship
          
          Spatial join condition, options: contain|cross|disjoint|identity|intersect|overlap|touch|within|near When target data is a polygon type: If join data is a polygon type, supported spatial relationship: contain,disjoint,identity,intersect,overlap,touch,within,near. If join data is a line type, supported spatial relationship: contain, disjoint, intersect, touch, near. If join data is a point type, supported spatial relationship: contain, disjoint, intersect, touch, near. When target data is a line type: If join data is a polygon type, supported spatial relationship: cross, disjoint, intersect, touch, within, near. If join data is a line type, supported spatial relationship: contain, cross, disjoint, identity, intersect, overlap, touch, within, near. If join data is a point type, supported spatial relationship: contain, disjoint, intersect, touch, near. When target data is a point type: If join data is a polygon type, supported spatial relationship: disjoint, intersect, touch, within, near. If join data is a line type, supported spatial relationship: disjoint, intersect, touch, within, near. If join data is a point type, supported spatial relationship: contain, disjoint, identity, intersect, within, near.
        • spatialNearDistance

          double spatialNearDistance
          
          Spatial distance. Valid only when then value of spatialRelationship is near.
        • spatialNearDistanceUnit

          Unit spatialNearDistanceUnit
          
          The unit of spatial distance. Valid only when then value of spatialRelationship is near. Options: meter, kilometer, yard, foot,mile.
        • tolerance

          double tolerance
          
          Node tolerance for setting spatial relationship.
        • temporalRelationship

          TemporalRelationShip temporalRelationship
          
          Time join conditions. Options: after, before, contain, during, finishes, meets, near, finishedby, metby, overlap, overlappedby, start, startedby, equal.
        • temporalNearDistance

          long temporalNearDistance
          
          TIme distance. Valid only when then value of temporalRelationship is near.
        • temporalNearDistanceUnit

          TemporalNearDistanceUnit temporalNearDistanceUnit
          
          The unit of time distance. Valid only when then value of temporalRelationship is near. Options: millisecond, second, minute, hour, day, week, month, year
        • attributeRelationship

          java.lang.String attributeRelationship
          
          Feature join field
        • summaryFields

          java.lang.String summaryFields
          
          Fields used for statistics, which need to be included in joinFields. If this field is not set, but joinOperation is JoinOneToOne, the number of join objects will be counted.
        • summaryMode

          java.lang.String summaryMode
          
          Attribute statistics mode, including: max,min, average, sum, variance, stdDeviation.
        • attributeMode

          AttributeStatisticalMode attributeMode
          
          Attribute join statistics mode, including: Equal and NotEqual
        • specFields

          java.lang.String specFields
          
          The name of time attribute field. To make a time connection, this field cannot be empty.
        • resultFieldNames

          java.lang.String resultFieldNames
          
          The name of result field
        • mappingParameters

          MappingParameters mappingParameters
          
          Parameters for making label thematic maps.
    • Class com.supermap.processing.jobserver.commontypes.FileCSVInputDataSetting extends CSVInputDataSetting implements Serializable

      • Serialized Fields

        • filePath

          java.lang.String filePath
          
    • Class com.supermap.processing.jobserver.commontypes.FileSystemOutputSetting extends OutputSetting<FileSystemOutputSetting> implements Serializable

      • Serialized Fields

        • datasourcePath

          java.lang.String datasourcePath
          
          The output result datasource path, such as the path for storing udb result file.
    • Class com.supermap.processing.jobserver.commontypes.IndexedHdfsDatasetInfo extends BigDataFileShareDatasetInfo implements Serializable

      • Serialized Fields

        • datasetType

          java.lang.String datasetType
          
    • Class com.supermap.processing.jobserver.commontypes.InputDataSetting extends java.lang.Object implements Serializable

    • Class com.supermap.processing.jobserver.commontypes.KernelDensityAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • query

          java.lang.String query
          
          Cache range
        • resolution

          java.lang.String resolution
          
          The Grid radius
        • radius

          java.lang.String radius
          
          The analysis radius
        • fields

          java.lang.String fields
          
          The set of the columns number of the field index where the weight values are in.
        • method

          int method
          
          0 represents the simple point density analysis, 1 represents kernel density analysis
        • meshType

          int meshType
          
          0: Grid; 1: Honeycomb region (hexagonal)
        • meshSizeUnit

          DistanceUnit meshSizeUnit
          
          The grid units
        • radiusUnit

          DistanceUnit radiusUnit
          
          The unit of searching radius
        • areaUnit

          AreaUnit areaUnit
          
          Area unit, density denominator unit
    • Class com.supermap.processing.jobserver.commontypes.MongoDBOutputSetting extends BuildCacheOutputSetting implements Serializable

      • Serialized Fields

        • serverAdresses

          java.lang.String[] serverAdresses
          
        • database

          java.lang.String database
          
        • version

          java.lang.String version
          
    • Class com.supermap.processing.jobserver.commontypes.OutputSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • outputPath

          java.lang.String outputPath
          
          The path for outputting the workspace of analysis result
        • datasetName

          java.lang.String datasetName
          
          The name of the analysis result dataset.
        • type

          OutputType type
          
          The output data type.
    • Class com.supermap.processing.jobserver.commontypes.OverlayAnalystGeoSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputVectorClip

          java.lang.String inputVectorClip
          
          The path of the vector clip UDB datasource. Defaults to read from the Spark Driver side directly since the operation only concerns one object.
        • datasetVectorClip

          java.lang.String datasetVectorClip
          
          The name of dataset where the clip object is in.
        • mode

          OverlayMode mode
          
          Vector clip mode, including: clip, intersect
        • attributeFilter

          java.lang.String attributeFilter
          
          Filter conditions
        • geometryClip

          Geometry geometryClip
          
          iServer geometry object. You can perform big data analysis by using restapi with this parameter.
        • bufferAnalystParameter

          BufferAnalystParameter bufferAnalystParameter
          
          Parameters used to make buffer area for the clip object. The parameters are passed in json format by the client.
    • Class com.supermap.processing.jobserver.commontypes.OverlayAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputOverlay

          java.lang.String inputOverlay
          
          The path of the overlay UDB datasource. Defaults to read from the Spark Driver side directly since the operation only concerns one object.
        • datasetOverlay

          java.lang.String datasetOverlay
          
          The name of the overlay dataset.
        • srcFields

          java.lang.String srcFields
          
          The retained fields from the input datasource.
        • overlayFields

          java.lang.String overlayFields
          
          The retained fields from the overlay datasource. If the analysis mode is clip, or update, or erase, this parameter is invalid.
        • mode

          OverlayMode mode
          
          Overlay modes, including: clip,erase,updata,union,identity,xor,intersect.
    • Class com.supermap.processing.jobserver.commontypes.ReconstructTracksAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • trackFields

          java.lang.String trackFields
          
          Track's ID field
        • summaryFields

          java.lang.String summaryFields
          
          Field Name
        • summaryStatisticModes

          java.lang.String summaryStatisticModes
          
          The statistic mode
        • timeSplit

          int timeSplit
          
          Time interval
        • timeSplitUnit

          TemporalNearDistanceUnit timeSplitUnit
          
          Time interval
    • Class com.supermap.processing.jobserver.commontypes.SpatialQueryGeoAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputQuery

          java.lang.String inputQuery
          
          The path of the query UDB datasource. Defaults to read from the Spark Driver side directly since the query operation only concerns one object.
        • datasetQuery

          java.lang.String datasetQuery
          
          The name of dataset where the query object is in.
        • mode

          SpatialQueryMode mode
          
          Spatial query mode, including: contain, cross, disjoint, identity, intersect, overlap, touch, within
        • attributeFilter

          java.lang.String attributeFilter
          
          The filtering conditions of the dataset where the querying object is located
        • geometryQuery

          Geometry geometryQuery
          
          iServer geometry object. You can perform big data analysis by using restapi with this parameter.
        • bufferAnalystParameter

          BufferAnalystParameter bufferAnalystParameter
          
          Parameters used to make buffer area for the query object. The parameters are passed in json format by the client.
    • Class com.supermap.processing.jobserver.commontypes.SummaryAttributesAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • groupField

          java.lang.String groupField
          
          The grouping field, used to group objects, the objects of the same attribute value are divided in to a group and then calculate the statistics by each group.
        • attributeField

          java.lang.String attributeField
          
          The attribute field, used to calculate the statistics according to this attribute.
        • statisticModes

          java.lang.String statisticModes
          
          The statistic mode
        • resultField

          java.lang.String resultField
          
          Result field
    • Class com.supermap.processing.jobserver.commontypes.SummaryMeshAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • query

          java.lang.String query
          
          Cache range
        • resolution

          java.lang.String resolution
          
          Resolution.
        • fields

          java.lang.String fields
          
          The set of the columns number of the field index where the weight values are in.
        • meshType

          int meshType
          
          0: Grid; 1: Honeycomb region (hexagonal)
        • statisticModes

          java.lang.String statisticModes
          
          The statistic mode
        • resultFieldNames

          java.lang.String resultFieldNames
          
          The name of result field
        • meshSizeUnit

          DistanceUnit meshSizeUnit
          
          The unit of grid size, the optional values: Meter|Kilometer|Yard|Foot|Mile (default Meter)
        • mappingParameters

          MappingParameters mappingParameters
          
          Used to set the parameters for making thematic maps.
    • Class com.supermap.processing.jobserver.commontypes.SummaryRegionAnalystSetting extends SummaryRegionAnalystSettingBase implements Serializable

      • Serialized Fields

        • attributeFilter

          java.lang.String attributeFilter
          
          Filter conditions
    • Class com.supermap.processing.jobserver.commontypes.SummaryWithinMeshAnalystSetting extends SummaryMeshAnalystSetting implements Serializable

      • Serialized Fields

        • standardSummaryFields

          boolean standardSummaryFields
          
          Whether to summary by using standard attribute fields.
        • weightedSummaryFields

          boolean weightedSummaryFields
          
          Whether to summary by using weight fields.
        • sumShape

          boolean sumShape
          
          Whether the area or length of the summary object are calculated. (default true)
        • weightedFields

          java.lang.String weightedFields
          
          The name of weight field
        • standardFields

          java.lang.String standardFields
          
          The name of the standard attribute field
        • standardStatisticModes

          java.lang.String standardStatisticModes
          
          The statistic mode used for standard attribute summary
        • weightedStatisticModes

          java.lang.String weightedStatisticModes
          
          The statistic mode used for weight attribute summary
    • Class com.supermap.processing.jobserver.commontypes.SummaryWithinRegionAnalysetSetting extends SummaryRegionAnalystSettingBase implements Serializable

      • Serialized Fields

        • standardSummaryFields

          boolean standardSummaryFields
          
          Whether to summary by using standard attribute fields.
        • weightedSummaryFields

          boolean weightedSummaryFields
          
          Whether to summary by using weight fields.
        • sumShape

          boolean sumShape
          
          Whether the area or length of the summary object are calculated.
        • query

          java.lang.String query
          
          Calculates the area, and objects that do not intersect with bounds do not participate in the statistics. (left,bottom,right,top)
        • weightedFields

          java.lang.String weightedFields
          
          The name of weight field
        • standardFields

          java.lang.String standardFields
          
          The name of the standard attribute field
        • standardStatisticModes

          java.lang.String standardStatisticModes
          
          The statistic mode used for standard attribute summary
        • weightedStatisticModes

          java.lang.String weightedStatisticModes
          
          The statistic mode used for weight attribute summary
    • Class com.supermap.processing.jobserver.commontypes.TopologyValidatorAnalystSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputValidating

          java.lang.String inputValidating
          
          Used to specify the datasource path and dataset name of the validating dataset
        • datasetTopology

          java.lang.String datasetTopology
          
          Used to specify the name of the validating dataset
        • rule

          TopologyValidatorRuleType rule
          
          Topology validation rules, including: RegionNoOverlap, RegionNoOverlapWith, RegionContainedByRegion, RegionCoveredByRegion, LineNoOverlap, LineNoOverlapwith, PointNoIdentical
        • tolerance

          java.lang.String tolerance
          
          Used to set the tolerance when validating the specified topology
  • Package com.supermap.server.commontypes

    • Class com.supermap.server.commontypes.InstanceAccessRecord extends java.lang.Object implements Serializable

      • Serialized Fields

        • userName

          java.lang.String userName
          

          The users corresponding to the service access records.

        • proxyNode

          java.lang.String proxyNode
          

          The users corresponding to the agent nodes.

        • remoteAddress

          java.lang.String remoteAddress
          

          The IP address of the service access record.

        • accessTime

          long accessTime
          

          The time of the service access record.

        • method

          java.lang.String method
          

          The request method of the service access record.

        • requestURL

          java.lang.String requestURL
          

          The URL of the service access record.

        • queryString

          java.lang.String queryString
          

          The request aurgument of the service access record.

        • instanceName

          java.lang.String instanceName
          
          The instance name of the service access record.
        • componentType

          java.lang.String componentType
          
          The component name of the service access record.
        • interfaceType

          java.lang.String interfaceType
          
          The interface name of the service access record.
        • responseCode

          int responseCode
          
          The response code returned from the client. The default is 200.
    • Class com.supermap.server.commontypes.ServicesLoad extends java.lang.Object implements Serializable

      • Serialized Fields

        • interval

          int interval
          

          The time interval of service accessing statistics. Default is 1 second.

        • historicalAccessCounts

          int[] historicalAccessCounts
          

          Records the concurrency of server in 5 minutes.

        • currentCount

          int currentCount
          

          The current concurrency.

        • averageTime

          long averageTime
          

          The average response time of the server. The unit is second.

  • Package com.supermap.server.config

    • Class com.supermap.server.config.ClusterMemberInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • authorized

          boolean authorized
          
          Whether to be authorized.
        • id

          java.lang.String id
          
          Cluster member ID.
        • active

          boolean active
          
          Whether it is activated.
        • ip

          java.lang.String ip
          
        • port

          int port
          
        • hostName

          java.lang.String hostName
          
        • uriRoot

          java.lang.String uriRoot
          
        • isControllable

          boolean isControllable
          
        • isOffLine

          boolean isOffLine
          
        • isAgent

          boolean isAgent
          
        • isTileWorker

          boolean isTileWorker
          
        • agentId

          java.lang.String agentId
          
    • Class com.supermap.server.config.CustomSecurityInfoStorageSetting extends SecurityInfoStorageSetting implements Serializable

      • Serialized Fields

        • impl

          java.lang.String impl
          

          The class name of CustomSecurityInfoStorage.

          Since:
          8.0.2
        • storageSetting

          java.lang.String storageSetting
          
    • Class com.supermap.server.config.OAuthConfig extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          int id
          

          Configure ID

          Since:
          7.0.1
        • enabled

          boolean enabled
          

          Whether it is enabled or not.

          Since:
          7.0.1
        • loginType

          java.lang.String loginType
          

          The login type.

          Since:
          7.0.1
        • clientSecret

          java.lang.String clientSecret
          

          The AppSecret while applying for application.

          Since:
          7.0.1
        • clientID

          java.lang.String clientID
          

          The Appkey while applying for application.

          Since:
          7.0.1
        • redirectDomain

          java.lang.String redirectDomain
          

          The redirect domain.

          Since:
          7.0.1
        • buttonText

          java.lang.String buttonText
          

          The login button name displaying in the login interface Such as: QQ

          Since:
          7.1.0
        • loginIcon

          java.lang.String loginIcon
          

          The login icon on the login interface. e.g., twitter_login.png. Note: The icons are placed in jar (./staticFiles/img)

          Since:
          7.1.0
    • Class com.supermap.server.config.SecurityInfoStorageSetting extends java.lang.Object implements Serializable

  • Package com.supermap.services

  • Package com.supermap.services.components

  • Package com.supermap.services.components.commontypes

    • Class com.supermap.services.components.commontypes.AbstractComputeMinDistanceParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • referenceDatasourceName

          java.lang.String referenceDatasourceName
          
          Refer to the the name of datasource where the feature set is located
        • referenceDatasetName

          java.lang.String referenceDatasetName
          
          Refer to the name of the dataset where the feature set is located (either a 2D point, a line, a face dataset, or a 2D network dataset)
        • referenceFilterQueryParameter

          QueryParameter referenceFilterQueryParameter
          
          Optional parameters that filter the elements in the reference dataset the default to null when not set , that is, all the elements in the reference dataset are evaluated as reference elements When not null, only the elements that meet the filter criteria are evaluated.
        • minDistance

          double minDistance
          
          The shortest distance between the specified querying ranges, the value range is greater than or equal to 0. The unit is the same as the unit of the dataset which the calculated record set belongs to.
        • maxDistance

          double maxDistance
          
          The biggest distance between the specified querying ranges, the value range is greater than 0 or equal to -1. When the value is set to -1, it means the maximum distance is not limited. The unit is the same as the unit of the dataset which the calculated record set belongs to.
        • isCreateResultDataset

          boolean isCreateResultDataset
          
          Whether creating the result dataset, the default is false, returning the calculated result ComputeDistanceResult. If the value is true, the names of result datasource and dataset must be specified, the calculated result generates attribute table dataset
        • resultDatasourceName

          java.lang.String resultDatasourceName
          
          The result datasource name
        • resultDatasetName

          java.lang.String resultDatasetName
          
          The name of the result dataset
    • Class com.supermap.services.components.commontypes.AbstractProximityAnalystParameter extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.Animation extends java.lang.Object implements Serializable

      • Serialized Fields

        • currentTime

          double currentTime
          
          The time position of the current animation.
        • startTime

          double startTime
          
          The start time position.
        • endTime

          double endTime
          
          The end time position.
        • playMode

          PlayMode playMode
          
          Play mode.
        • autoUpdated

          boolean autoUpdated
          
          Whether the play mode is to update time automatically.
        • enabled

          boolean enabled
          
          Whether the current animation is available.
        • length

          double length
          

          Length of animation, in milliseconds.

          Read-only attribute.

    • Class com.supermap.services.components.commontypes.ArcGISLayer extends Layer implements Serializable

      • Serialized Fields

        • id

          int id
          

          Layer ID

          Since:
          7.1.0
        • parentLayerId

          int parentLayerId
          

          Parent layer ID

          Since:
          7.1.0
        • style

          Style style
          

          Layer style

          Since:
          7.1.0
        • defaultVisibility

          boolean defaultVisibility
          

          Whether it is visible

          Since:
          7.1.0
        • subLayerIds

          int[] subLayerIds
          

          Child layer ID

          Since:
          7.1.0
        • minScale

          double minScale
          

          Minimum visible scale

          Since:
          7.1.0
        • maxScale

          double maxScale
          

          Maximum visible scale

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.ArcGISMapExtend extends java.lang.Object implements Serializable

      • Serialized Fields

        • xmin

          double xmin
          
          Minimum longitude.
        • ymin

          double ymin
          
          Minimum latitude.
        • xmax

          double xmax
          
          Maximum longitude.
        • ymax

          double ymax
          
          Maximum latitude.
        • spatialReference

          ArcGISSpatialReference spatialReference
          

          Spatial reference system

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.ArcGISSpatialReference extends java.lang.Object implements Serializable

      • Serialized Fields

        • wkid

          int wkid
          
        • wkt

          java.lang.String wkt
          
        • latestWKID

          int latestWKID
          
    • Class com.supermap.services.components.commontypes.ArcGISTileInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • cols

          int cols
          
          Column number of the tiles.
        • rows

          int rows
          
          Row number of the tiles.
        • dpi

          double dpi
          
          dpi.
        • origin

          Point2D origin
          
          Origin of the tiles.
        • format

          java.lang.String format
          
          The image format.
        • lods

          LODInfo[] lods
          
          Tile grading information.
        • spatialReference

          ArcGISSpatialReference spatialReference
          

          Spatial reference

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.AsyncClientSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • ioReactorSelectInterval

          long ioReactorSelectInterval
          

          IOReactor selects time interval.

          Since:
          8.0.0
        • ioReactorIoThreadCount

          int ioReactorIoThreadCount
          

          IOReactor IO thread count.

          Since:
          8.0.0
        • ioReactorSoKeepAlive

          boolean ioReactorSoKeepAlive
          

          IOReactor Whether to keep connection.

          Since:
          8.0.0
        • clientMaxConnTotal

          int clientMaxConnTotal
          

          The maximum connection of client.

          Since:
          8.0.0
        • clientMaxConnPerRoute

          int clientMaxConnPerRoute
          

          The maximum connection of every path on client.

          Since:
          8.0.0
        • connectTimeout

          int connectTimeout
          

          The timeout of connection.

          Since:
          8.0.0
        • soTimeout

          int soTimeout
          

          socket timeout.

          Since:
          8.0.0
    • Class com.supermap.services.components.commontypes.Atmosphere extends java.lang.Object implements Serializable

      • Serialized Fields

        • visible

          boolean visible
          

          Whether the atmosphere is visible.

    • Class com.supermap.services.components.commontypes.Attachment extends AttachmentInfo implements Serializable

      • Serialized Fields

        • data

          byte[] data
          
          Attachment data.
    • Class com.supermap.services.components.commontypes.AttachmentInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • name

          java.lang.String name
          
          Attachment name.
        • size

          long size
          
          Attachment size.
        • id

          int id
          
          Attachment ID.
        • contentType

          java.lang.String contentType
          
          Content type.
    • Class com.supermap.services.components.commontypes.AuthorizeSetting extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.BaiduMapLayer extends Layer implements Serializable

    • Class com.supermap.services.components.commontypes.Barrier3DInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • point

          Point3D point
          

          Obstacle point coordinates.

        • id

          int id
          

          ID of the obstacle model object.

        • layerName

          java.lang.String layerName
          

          The corresponding layer name of the obstacle model.

    • Class com.supermap.services.components.commontypes.BigDataFileShareDatasetInfo extends Named implements Serializable

      • Serialized Fields

        • available

          boolean available
          
        • url

          java.lang.String url
          
          File path
    • Class com.supermap.services.components.commontypes.BingMapsLayer extends Layer implements Serializable

      • Serialized Fields

        • url

          java.lang.String url
          
    • Class com.supermap.services.components.commontypes.BlankRegion extends Geometry implements Serializable

      • Serialized Fields

        • blankRegionId

          java.lang.String blankRegionId
          

          Blank region ID, randomly generated

        • markType

          MarkType markType
          

          Type

    • Class com.supermap.services.components.commontypes.BoundingBox3D extends java.lang.Object implements Serializable

      • Serialized Fields

        • lower

          Point3D lower
          

          The minimum 3D point of the bounding box, namely the 3D point object with the smallest X, Y, Z coordinates (Point3D).

        • upper

          Point3D upper
          

          The maximum 3D point of the bounding box, namely the 3D point object with the largest X, Y, Z coordinates (Point3D).

    • Class com.supermap.services.components.commontypes.BoundsWithCRS extends Rectangle2D implements Serializable

      • Serialized Fields

        • crs

          java.lang.String crs
          
    • Class com.supermap.services.components.commontypes.BoundsWithPrjCoordSys extends Rectangle2D implements Serializable

      • Serialized Fields

    • Class com.supermap.services.components.commontypes.BufferAnalystParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • endType

          BufferEndType endType
          

          Buffer endpoint type.

        • leftDistance

          BufferDistance leftDistance
          
          Left buffer distance. Unit: M.
        • rightDistance

          BufferDistance rightDistance
          
          Right buffer distance. Unit: M.
        • semicircleLineSegment

          int semicircleLineSegment
          

          The number of arc segment of the Round, that is, with how many arc segments to simulate a semicircle. The default value is 4.

        • radiusUnit

          BufferRadiusUnit radiusUnit
          

          Buffer radius unit, the default is M.

    • Class com.supermap.services.components.commontypes.BufferDistance extends java.lang.Object implements Serializable

      • Serialized Fields

        • value

          double value
          

          Use numerical value as buffer distance, which is greater than 0.

        • exp

          java.lang.String exp
          

          Use the calculated result of the expression as buffer distance, which is greater than 0.

    • Class com.supermap.services.components.commontypes.BufferResultSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • isUnion

          boolean isUnion
          
          Whether to merge the intersected regions of the result dataset.
        • isAttributeRetained

          boolean isAttributeRetained
          
          Whether to retain the field attributes of the object for buffer analysis, and invalid when isUnion is ture.
        • dataReturnOption

          DataReturnOption dataReturnOption
          
          Data return option. For details please refer to DataReturnOption
    • Class com.supermap.services.components.commontypes.BuildingScaleInfo extends TileScaleInfo implements Serializable

      • Serialized Fields

        • nextIndex

          TileIndex nextIndex
          

          Next tiling index, which records the start position of next TileTask.

    • Class com.supermap.services.components.commontypes.BurstAnalyseResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • criticalNodes

          int[] criticalNodes
          
        • edges

          int[] edges
          
        • normalNodes

          int[] normalNodes
          
        • edgesFeatures

          Feature[] edgesFeatures
          
        • normalNodesFeatures

          Feature[] normalNodesFeatures
          
        • criticalNodesFeatures

          Feature[] criticalNodesFeatures
          
    • Class com.supermap.services.components.commontypes.Camera extends java.lang.Object implements Serializable

      • Serialized Fields

        • altitude

          double altitude
          

          The height of the camera.

        • altitudeMode

          AltitudeMode altitudeMode
          

          Specified altitude mode of the camera.

          The altitude mode has the following types: the clamp-to-ground altitude mode (CLAMP_TO_GROUND), the relative-to-ground altitude mode (RELATIVE_TO_GROUND), and the absolute altitude mode (ABSOLUTE). For related details, please see the enumeration type enum in AltitudeMode.
        • heading

          double heading
          

          The camera's heading (the up direction, i.e., the included angle to the north) ranges from 0 to 360 degrees.

          The azimuth: the direction of the compass. In the three-dimensional analysis and the spatial analysis, a angle that a illuminate is irradiating a surface is called the azimuth.

        • empty

          boolean empty
          

          Whether the camera object is empty.

          true means the camera object is null, false means not null.

        • latitude

          double latitude
          

          The latitude of the camera, in degree.

        • longitude

          double longitude
          

          The longitude of the camera, in degree.

        • tilt

          double tilt
          

          The camera's tilt (the angle around the X axis). The tilt ranges from 0 and 90 degrees.

    • Class com.supermap.services.components.commontypes.CartoCSS extends java.lang.Object implements Serializable

      • Serialized Fields

        • filters

          java.util.List<E> filters
          
        • styles

          java.util.List<E> styles
          
    • Class com.supermap.services.components.commontypes.CartoCSS.CartoCSSStr extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.CartoCSS.CartoCSSStyleKeySet extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.CartoCSS.Pair extends java.lang.Object implements Serializable

      • Serialized Fields

        • key

          java.lang.String key
          
        • split

          java.lang.String split
          
        • value

          java.lang.String value
          
    • Class com.supermap.services.components.commontypes.CartoCSSLayer extends CartoCSS implements Serializable

    • Class com.supermap.services.components.commontypes.ChartAttributeSpec extends java.lang.Object implements Serializable

      • Serialized Fields

        • code

          int code
          
          The attribute field code.
        • required

          int required
          
          Whether this attribute is required for the feature. The returned value can be 0, 1, or 2. When 0, it means that the property is not the required property of the chart; when 1, that the property is the required one; when 2, it means that the property setting is valid in some specific condition.
    • Class com.supermap.services.components.commontypes.ChartFeatureInfoSpec extends java.lang.Object implements Serializable

      • Serialized Fields

        • acronym

          java.lang.String acronym
          
          The feature acronym.
        • code

          int code
          
          The code of the feature.
        • localName

          java.lang.String localName
          
          The localized name.
        • name

          java.lang.String name
          
          The name of the feature
        • primitive

          java.lang.String primitive
          
          The object type which could be applied by the feature.
        • attributeFields

          java.util.List<E> attributeFields
          
          The attribute fields of the feature.
    • Class com.supermap.services.components.commontypes.ChartQueryParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • isQueryPoint

          boolean isQueryPoint
          
          Whether looks up points
        • isQueryLine

          boolean isQueryLine
          
          Whether looks up lines
        • isQueryRegion

          boolean isQueryRegion
          
          Whether looks up regions
        • attributeFilter

          java.lang.String attributeFilter
          
          Query filter condition
        • chartFeatureInfoSpecCode

          int chartFeatureInfoSpecCode
          
          Query feature NO
    • Class com.supermap.services.components.commontypes.ChartQueryParameterSet extends java.lang.Object implements Serializable

      • Serialized Fields

        • chartQueryParams

          ChartQueryParameter[] chartQueryParams
          
          Chart query parameter array
        • startRecord

          int startRecord
          
          The start recording location of the query, and the default is 0
        • expectCount

          int expectCount
          
          The expect count. The value is greater than 0.
    • Class com.supermap.services.components.commontypes.ClearCacheParam extends java.lang.Object implements Serializable

      • Serialized Fields

        • mapName

          java.lang.String mapName
          

          ${services_components_commontypes_ClearCacheParam_attribute_mapName_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_mapName_Description}

        • bounds

          Rectangle2D bounds
          

          ${services_components_commontypes_ClearCacheParam_attribute_bounds_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_bounds_Description}

        • mapScales

          double[] mapScales
          

          ${services_components_commontypes_ClearCacheParam_attribute_mapScales_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_mapScales_Description}

        • picWidth

          int picWidth
          

          ${services_components_commontypes_ClearCacheParam_attribute_picWidth_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_picWidth_Description}

        • picHeight

          int picHeight
          

          ${services_components_commontypes_ClearCacheParam_attribute_picHeight_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_picHeight_Description}

        • customParams

          java.lang.String customParams
          

          ${services_components_commontypes_ClearCacheParam_attribute_customParams_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_customParams_Description}

        • cacheMode

          java.lang.String cacheMode
          

          ${services_components_commontypes_ClearCacheParam_attribute_cacheMode_Title}

          ${services_components_commontypes_ClearCacheParam_attribute_cacheMode_Description}

    • Class com.supermap.services.components.commontypes.ClipParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • clipRegion

          Geometry clipRegion
          
          GeometryType can only be REGION, user-specified clipping region is used for the first order. When not set, use the border polygon of the specified dataset to clip.
        • clipDatasourceName

          java.lang.String clipDatasourceName
          
          Specify the datasource name which the dataset for clipping exists in.
        • clipDatasetName

          java.lang.String clipDatasetName
          
          Specify the dataset name for clipping, which is active when the clipRegion is not be set up.
        • isClipInRegion

          boolean isClipInRegion
          
          Specifies which clipping mode to choose. If true is returned, the result within the clipping region will be extracted; if false is returned, the result outside of the clipping region will be extracted. The default value is true.
        • isExactClip

          boolean isExactClip
          
          Specifies whether to use exact clipping. If true, the exact clipping is used to clip the grid or image datasets. If false, the display clip is used. The default is true.
    • Class com.supermap.services.components.commontypes.ClosestFacilityPath extends Path implements Serializable

      • Serialized Fields

        • facilityIndex

          int facilityIndex
          

          The index in the candidate facility point sequence of the closest facility reached by this path.

        • facility

          java.lang.Object facility
          

          The nearest facility point the route arrives at.

    • Class com.supermap.services.components.commontypes.ClosestFacilityPaths extends java.util.ArrayList<ClosestFacilityPath<T>> implements Serializable

      • Serialized Fields

        • facilityIndexes

          int[] facilityIndexes
          

          Closest facility point index set.

          The nearest facility index identifies the location of the facility in the sequence of the selected facility points(starting from 0).

    • Class com.supermap.services.components.commontypes.CloudLayer extends Layer implements Serializable

    • Class com.supermap.services.components.commontypes.CloudLicenseInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          java.lang.String id
          
        • status

          CloudLicenseStatus status
          
        • remianDays

          int remianDays
          
        • productInfo

          java.lang.String productInfo
          
        • moduleNames

          java.lang.String[] moduleNames
          
        • isTrial

          boolean isTrial
          
    • Class com.supermap.services.components.commontypes.CloudLicenseSetting extends CloudLicenseUserSetting implements Serializable

      • Serialized Fields

        • activeLicenseId

          java.lang.String activeLicenseId
          
        • activeLicenseReturnId

          java.lang.String activeLicenseReturnId
          
        • activeMode

          CloudLicenseActiveMode activeMode
          
    • Class com.supermap.services.components.commontypes.CloudLicenseUserSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • userName

          java.lang.String userName
          
        • password

          java.lang.String password
          
        • eMail

          java.lang.String eMail
          
    • Class com.supermap.services.components.commontypes.CodeDomainInfo extends DomainInfo implements Serializable

      • Serialized Fields

        • codeCount

          int codeCount
          
          The number of code range
        • codeInfos

          CodeInfo[] codeInfos
          
          Detailed info of code range
    • Class com.supermap.services.components.commontypes.CodeInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • value

          java.lang.String value
          
          Code
        • valueType

          FieldType valueType
          
          Code type
    • Class com.supermap.services.components.commontypes.Color extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.ComputeDistanceResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • distanceResults

          DistanceResult[] distanceResults
          
          Do not create a result dataset and return the results of the distance calculation directly
        • datasourceName

          java.lang.String datasourceName
          
          The datasource name that the result dataset belongs to
        • datasetName

          java.lang.String datasetName
          
          The name of the result dataset
    • Class com.supermap.services.components.commontypes.ComputeMinDistanceParameterForDatasetInput extends AbstractComputeMinDistanceParameter implements Serializable

      • Serialized Fields

        • inputDatasourceName

          java.lang.String inputDatasourceName
          
          The datasource name which the dataset for calculating exists in
        • inputDatasetName

          java.lang.String inputDatasetName
          
          The name of the dataset for calculating
        • inputFilterQueryParameter

          QueryParameter inputFilterQueryParameter
          
          Optional parameters for filtering elements in a dataset
    • Class com.supermap.services.components.commontypes.ComputeMinDistanceParameterForGeometriesInput extends AbstractComputeMinDistanceParameter implements Serializable

      • Serialized Fields

        • inputGeometries

          Geometry[] inputGeometries
          
          The specified calculated geometry object set, only supports 2D point objects
    • Class com.supermap.services.components.commontypes.CoordSys extends java.lang.Object implements Serializable

      • Serialized Fields

        • unit

          Unit unit
          

          ${services_components_commontypes_CoordSys_attribute_unit_Title}

          ${services_components_commontypes_CoordSys_attribute_unit_Description}

        • datum

          Datum datum
          

          ${services_components_commontypes_CoordSys_attribute_datum_Title}

          ${services_components_commontypes_CoordSys_attribute_datum_Description}

        • name

          java.lang.String name
          

          ${services_components_commontypes_CoordSys_attribute_name_Title}

          ${services_components_commontypes_CoordSys_attribute_name_Description}

        • spatialRefType

          SpatialRefType spatialRefType
          

          ${services_components_commontypes_CoordSys_attribute_spatialRefType_Title}

          ${services_components_commontypes_CoordSys_attribute_spatialRefType_Description}

        • type

          CoordSysType type
          

          ${services_components_commontypes_CoordSys_attribute_type_Title}

          ${services_components_commontypes_CoordSys_attribute_type_Description}

        • primeMeridian

          PrimeMeridian primeMeridian
          

          ${services_components_commontypes_CoordSys_attribute_primeMeridian_Title}

          ${services_components_commontypes_CoordSys_attribute_primeMeridian_Description}

    • Class com.supermap.services.components.commontypes.CostPathLineResult extends GeometrySpatialAnalystResult implements Serializable

      • Serialized Fields

        • cost

          double cost
          
          The total cost of the path.
    • Class com.supermap.services.components.commontypes.CSVDatasetInfo extends BigDataFileShareDatasetInfo implements Serializable

      • Serialized Fields

        • xIndex

          int xIndex
          
          The index of X field in current file, for example: 10
        • yIndex

          int yIndex
          
          The index of Y field in current file, for example: 11
        • separator

          java.lang.String separator
          
          Separator used to separate each column
        • firstRowIsHead

          boolean firstRowIsHead
          
          Whether the content in first line of the current file is the field name, ie., the header
        • prjCoordsys

          int prjCoordsys
          
          The code of the coordinate system
        • fieldInfo

          CSVFieldInfo[] fieldInfo
          
          The fields' information
    • Class com.supermap.services.components.commontypes.CSVFieldInfo extends java.lang.Object implements Serializable

      • Serialized Fields

    • Class com.supermap.services.components.commontypes.CSVMetaData extends java.lang.Object implements Serializable

      • Serialized Fields

        • xIndex

          int xIndex
          
          The index of X field in current file, for example: 10
        • yIndex

          int yIndex
          
          The index of Y field in current file, for example: 11
        • separator

          java.lang.String separator
          
          Separator used to separate each column
        • firstRowIsHead

          boolean firstRowIsHead
          
        • prjCoordsys

          int prjCoordsys
          
          The code of the coordinate system
    • Class com.supermap.services.components.commontypes.CSVTimeFieldInfo extends CSVFieldInfo implements Serializable

      • Serialized Fields

        • timeFormatter

          java.lang.String timeFormatter
          
    • Class com.supermap.services.components.commontypes.CutFillResult extends SpatialAnalystResult implements Serializable

      • Serialized Fields

        • dataset

          java.lang.String dataset
          
          The ID of the result dataset.
        • cutArea

          double cutArea
          

          The cut area in the cut and fill analysis result.

        • cutVolume

          double cutVolume
          

          The cut volume in the cut and fill analysis result.

        • fillArea

          double fillArea
          

          The filled area in the cut and fill analysis result.

        • fillVolume

          double fillVolume
          

          The filled volume in the cut and fill analysis result.

        • remainderArea

          double remainderArea
          

          The area of the part that did not participate in the cut and fill analysis.

    • Class com.supermap.services.components.commontypes.DataPreProcessInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • rowCount

          int rowCount
          
          Row number
        • columnCount

          int columnCount
          
          Column number
    • Class com.supermap.services.components.commontypes.DataReturnOption extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.DatasetGridInfo extends DatasetInfo implements Serializable

      • Serialized Fields

        • blockSize

          int blockSize
          

          The raster dataset is stored in pixels by block, read-only.

          The blocking mode is stored the block as the square, for instance, when blockSize is 4, blocking the square with 4*4 pixel, the image data will be blocked the matrix with 3 rows and 3 columns. Where, if the image data has not enough pixel to be blocked, so using the empty grid to make up for the block.

        • height

          int height
          
          Height of the raster data, read-only.
        • width

          int width
          
          Width of the raster data, read-only.
        • minValue

          double minValue
          
          The minimum value in the grid ranks of raster dataset.
        • maxValue

          double maxValue
          
          the maximum in the grid ranks of raster dataset.
        • noValue

          double noValue
          

          The raster value which doesn't have data.

        • pixelFormat

          PixelFormat pixelFormat
          
          The pixel format of the storage, read-only.

          That is, what format the pixels are stored, and how many bytes are used for each pixel. For more information, please refer to the PixelFormat enumeration class. DatasetImageInfo does not currently support Double, Single, and BIT64 three pixel formats.

    • Class com.supermap.services.components.commontypes.DatasetGridStatisticResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • average

          double average
          
          The average of the cell values.
        • majority

          double[] majority
          
          The Mode of raster values
        • minority

          double[] minority
          
          The sparse of raster values
        • maxValue

          double maxValue
          
          The maximum value of the raster value.
        • medianValue

          double medianValue
          
          The median value of the raster value.
        • minValue

          double minValue
          
          The minimum value of the raster value.
        • stdDeviation

          double stdDeviation
          
          The standard deviation of the raster value.
        • variance

          double variance
          
          The variance of raster values
    • Class com.supermap.services.components.commontypes.DatasetImageInfo extends DatasetInfo implements Serializable

      • Serialized Fields

        • blockSize

          int blockSize
          

          The image dataset is stored in pixels by block, read-only.

          The blocking mode is stored the block as the square, for instance, when blockSize is 4, blocking the square with 4*4 pixel, the image data will be blocked the matrix with 3 rows and 3 columns. Where, if the image data has not enough pixel to be blocked, so using the empty grid to make up for the block.

        • height

          int height
          
          Height of the image data, read-only.
        • width

          int width
          
          Width of the image data, read-only.
        • palette

          java.util.List<E> palette
          
          Deprecated. 
          the color palette of the image dataset.
          See Also:
          DatasetImageInfo.palettes
        • palettes

          java.util.List<E>[] palettes
          
          The color palette of each band in image dataset.
          Since:
          7.0.0
        • pixelFormat

          PixelFormat pixelFormat
          
          The pixel format of the storage, read-only.

          That is, what format the pixels are stored, and how many bytes are used for each pixel. For more information, please refer to the PixelFormat enumeration class. DatasetImageInfo does not currently support Double, Single, and BIT64 three pixel formats.

        • isMultiBand

          boolean isMultiBand
          
          Deprecated. use #bandCount instead
          whether the image dataset is a multi-band image dataset. Read-only.
          See Also:
          DatasetImageInfo.bandCount
        • bandCount

          int bandCount
          
          Returns the count of bands. Readonly.
          Since:
          7.0.0
        • bandNames

          java.lang.String[] bandNames
          
          Band Name. Readonly.
          Since:
          7.0.0
        • colorSpace

          ColorSpaceType colorSpace
          
          The display mode for color
          Since:
          7.0.0
    • Class com.supermap.services.components.commontypes.DatasetInfo extends Named implements Serializable

      • Serialized Fields

        • description

          java.lang.String description
          
          The descriptive information about the dataset.
        • prjCoordSys

          PrjCoordSys prjCoordSys
          
          the projection information of the dataset.
        • isReadOnly

          boolean isReadOnly
          
          Whether the dataset is readonly.
        • tableName

          java.lang.String tableName
          
          Table name. Readonly.

          For database datasources, it's the data table name corresponding to this dataset in the database; for file datasources, it's the table name of this dataset used to store the attributes (files of file datasources store spatial data by .sdb files and store attribute data by .sdd files).

        • encodeType

          EncodeType encodeType
          
          The compact encoding approach. Read-only.

          Using a encoding for a dataset can reduce the space used to store this dataset, decrease the load of the net or the load of the server. The encoding type for the vector dataset can be Byte, Int16, Int24 and Int32, SGL,LZW,DCT, or you can choose not to encode or compress this dataset, which is None. The encoding type of the raster dataset can be DCT, SGL, LZW or None, which means do not compress the data. For more information, please refer to the EncodeType class.

        • type

          DatasetType type
          

          Dataset type, required.

          ${services_components_commontypes_DatasetInfo_attribute_type_Description}

        • dataSourceName

          java.lang.String dataSourceName
          

          Datasource name. Read-only.

          ${services_components_commontypes_DatasetInfo_attribute_dataSourceName_Description}

        • bounds

          Rectangle2D bounds
          

          Dataset bounds. Read-only.

          ${services_components_commontypes_DatasetInfo_attribute_bounds_Description}

        • datasourceConnectionInfo

          DatasourceConnectionInfo datasourceConnectionInfo
          
          The Datasource Connection Info
    • Class com.supermap.services.components.commontypes.DatasetOverlayResultSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • sourceDatasetFields

          java.lang.String[] sourceDatasetFields
          

          The list of field names remain in the result dataset of the source dataset.

        • operateDatasetFields

          java.lang.String[] operateDatasetFields
          

          The list of field names remain in the result dataset of the overlay dataset.

        • tolerance

          double tolerance
          

          The tolerance of the overlay analysis. After the overlay analysis, if the distance between the two nodes is less than this value, the two nodes are merged.

        • dataReturnOption

          DataReturnOption dataReturnOption
          
          The returned result setting, including the name of the returned result dataset, the maximum number of records returned, the data return mode, and so on.
    • Class com.supermap.services.components.commontypes.DatasetSpatialAnalystResult extends SpatialAnalystResult implements Serializable

      • Serialized Fields

        • dataset

          java.lang.String dataset
          
          The ID of the result dataset.
        • recordset

          Recordset recordset
          
          The result recordset.
    • Class com.supermap.services.components.commontypes.DatasetSpatialQuery3DResultSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • sourceDatasetFields

          java.lang.String[] sourceDatasetFields
          

          The list of the retained fields in result dataset from the source dataset.

        • operateDatasetFields

          java.lang.String[] operateDatasetFields
          

          The list of the retained fields in result dataset from the overlay dataset.

        • positionMode

          java.lang.String positionMode
          

          The tolerance of overlay analysis. After performing the overlay analysis, if the distance between two points is less than this value, the two points will be merged.

        • dataReturnOption

          DataReturnOption dataReturnOption
          
          Result settings, including: result dataset name, the maximum records, and return mode.
    • Class com.supermap.services.components.commontypes.DatasetVectorInfo extends DatasetInfo implements Serializable

      • Serialized Fields

        • isFileCache

          boolean isFileCache
          
          whether to use the file cache.
        • charset

          Charset charset
          
          the vector dataset charset.
        • recordCount

          int recordCount
          
          The recordset number of the vector dataset. Read-only.
    • Class com.supermap.services.components.commontypes.DatasourceConnectionInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • alias

          java.lang.String alias
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_alias_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_alias_Description}

        • dataBase

          java.lang.String dataBase
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_dataBase_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_dataBase_Description}

        • driver

          java.lang.String driver
          

          the driver program name needed for the datasource connection.

          For SQL Server database, which uses the ODBC connect, the driver name returned is SQL Server or SQL Native Client.

          For the WMTS service published by iServer, the driver name returned is WMTS.

        • engineType

          EngineType engineType
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_engineType_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_engineType_Description}

        • password

          java.lang.String password
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_password_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_password_Description}

        • server

          java.lang.String server
          

          The database server name, file name or service address.
          1 For the SDB and UDB file, it's the absolute path for the file. Note: when the absolute path length exceeds 260 bytes of UTF-8 encoding format, the datasource cannot be opened.
          2 For the Oracle database datasource, it is the TNS service name.
          3 For the SQL Server database datasource, it is the system DSN(Database System Name).
          4 For PostgreSQL database, the server name is "IP:port number", the default port number is 5432.
          5 For DB2 database, there is no need for setting the server since it has been edited.
          6 For Kingbase database the server name is the IP.
          7 For GoogleMaps datasource, its the service address, the default is "http://maps.google.com", it can't be changed.
          8 For SuperMapCloud datasource, it's the service address.
          9 For MapWorld datasource, its the service address, the default is "http://www.tianditu.cn", it can't be changed.
          10 For OGC and REST datasource, it's the service address.

        • user

          java.lang.String user
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_user_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_user_Description}

        • connect

          boolean connect
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_connect_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_connect_Description}

        • exclusive

          boolean exclusive
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_exclusive_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_exclusive_Description}

        • openLinkTable

          boolean openLinkTable
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_openLinkTable_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_openLinkTable_Description}

        • readOnly

          boolean readOnly
          

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_readOnly_Title}

          ${services_components_commontypes_DatasourceConnectionInfo_attribute_readOnly_Description}

    • Class com.supermap.services.components.commontypes.DataSourceConnectionPoolInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • username

          java.lang.String username
          
          A user with database access authority.
        • password

          java.lang.String password
          
          The user password.
        • dbType

          DataSourceConnectionPoolInfo.DataBaseType dbType
          
          Database type.
        • driverClass

          java.lang.String driverClass
          
          The full name of the database driver, e.g., the MySQL database is: com.mysql.jdbc.Driver.
        • jdbcUrl

          java.lang.String jdbcUrl
          
          url to connect the driver, e.g., the MySQL database is: jdbc:mysql://{ip}:{port}/{database}?useUnicode=true&characterEncoding=UTF-8.
        • maxPoolSize

          java.lang.String maxPoolSize
          
          The max activity connection provided by connection pooling at the same time
        • initialPoolSize

          java.lang.String initialPoolSize
          
          The initialized connection pool size, that is, the number of initial connections.
        • minPoolSize

          java.lang.String minPoolSize
          
          The min activity connection provided by connection pooling at the same time
        • maxIdleTime

          java.lang.String maxIdleTime
          
          Idle connection waiting time, that is, when the current connection is idle, can be retained in milliseconds. If it is not operated after the duration, the current connection is automatically closed. If set to 0, the idle connection is always retained.
        • maxWait

          java.lang.String maxWait
          
          The waiting time for an abnormal connection, that is, when the connection is abnormal, the system waits in milliseconds. If the connection exception is not restored during this time period, the current connection is automatically closed.
    • Class com.supermap.services.components.commontypes.DatasourceInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • description

          java.lang.String description
          
          Datasource description.
        • engineType

          EngineType engineType
          
          Datasource engine type, read-only.
        • prjCoordSys

          PrjCoordSys prjCoordSys
          
          The projection information.
        • coordUnit

          Unit coordUnit
          
          the coordinate unit.
        • distanceUnit

          Unit distanceUnit
          
          Distance unit.
        • name

          java.lang.String name
          

          The alias of the datasource.

          Alias is used to uniquely identify datasource in a workspace and can also be used to call a datasource. The alias of a datasource has been assigned once the datasource was created or opened. You can use a different alias to open a datasource.

    • Class com.supermap.services.components.commontypes.Datum extends java.lang.Object implements Serializable

      • Serialized Fields

        • name

          java.lang.String name
          

          ${services_components_commontypes_Datum_attribute_name_Title}

          ${services_components_commontypes_Datum_attribute_name_Description}

        • type

          DatumType type
          

          The GeoDatum type object.

          When the datum is defined by the user, it is required to specify ellipsoid parameters; other values are predefined.

        • spheroid

          Spheroid spheroid
          

          ${services_components_commontypes_Datum_attribute_spheroid_Title}

          ${services_components_commontypes_Datum_attribute_spheroid_Description}

    • Class com.supermap.services.components.commontypes.DemandResult extends Feature implements Serializable

      • Serialized Fields

        • actualResourceValue

          double actualResourceValue
          

          It indicates the shortest path value from the demand result to the resource supply center in the location analysis.

        • demandID

          int demandID
          

          The ID of the nodes or the arc sections according to the demand results.

          It returns the ID of the edge when the isEdge method is true; it returns the ID of the node when the isEdge method is false.

        • supplyCenter

          SupplyCenter supplyCenter
          

          The resource supply center of the demand result.

        • isEdge

          boolean isEdge
          

          Determines the feature according to the demand results is the arc sections or the nodes.

          True indicates that the corresponding element of the demand result is an arc, false indicates that the corresponding element of the demand result is a node.

    • Class com.supermap.services.components.commontypes.DensityAnalystParameterInput extends java.lang.Object implements Serializable

      • Serialized Fields

        • bounds

          Rectangle2D bounds
          
          The bound of the density analysis.It is used to determine the bound of the output dataset.
        • resultGridDatasetResolution

          double resultGridDatasetResolution
          
          The resolution of density analysis results raster data.
        • searchRadius

          double searchRadius
          
          The radius of the search used to calculate the density in the grid neighborhood.
    • Class com.supermap.services.components.commontypes.DistanceResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • sourceGeometryID

          int sourceGeometryID
          
          Return ID of the calculated object
        • referenceGeometryIDs

          int[] referenceGeometryIDs
          
          Return ID array of the reference object
        • distance

          double distance
          
          Return the distance value
    • Class com.supermap.services.components.commontypes.DomainInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • description

          java.lang.String description
          
          Range description
        • fieldName

          java.lang.String fieldName
          
          The name of the field
        • name

          java.lang.String name
          
          Range name
        • type

          DomainType type
          
          Range type
        • valueType

          FieldType valueType
          
          Range Data Type
    • Class com.supermap.services.components.commontypes.EditResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • succeed

          boolean succeed
          

          ${services_components_commontypes_EditResult_attribute_succeed_Title}

          ${services_components_commontypes_EditResult_attribute_succeed_Description}

        • ids

          int[] ids
          

          ${services_components_commontypes_EditResult_attribute_ids_Title}

          ${services_components_commontypes_EditResult_attribute_ids_Description}

        • bounds

          Rectangle2D bounds
          

          ${services_components_commontypes_EditResult_attribute_bounds_Title}

          ${services_components_commontypes_EditResult_attribute_bounds_Description}

        • message

          java.lang.String message
          

          ${services_components_commontypes_EditResult_attribute_message_Title}

          ${services_components_commontypes_EditResult_attribute_message_Description}

    • Class com.supermap.services.components.commontypes.ExportedDataPathItem extends java.lang.Object implements Serializable

      • Serialized Fields

        • item

          DataPathItem item
          
        • exportingId

          java.lang.String exportingId
          
        • dataPath

          java.lang.String dataPath
          
        • dataSize

          long dataSize
          
        • masterSideId

          java.lang.String masterSideId
          

          The id of master.

          Since:
          8.0.0
    • Class com.supermap.services.components.commontypes.ExporttingScaleState extends TilesetExportScaleState implements Serializable

      • Serialized Fields

    • Class com.supermap.services.components.commontypes.ExternalResourceParameter extends ResourceParameter3D implements Serializable

      • Serialized Fields

        • relativePath

          java.lang.String relativePath
          

          Relative pass of external resource and workspace

    • Class com.supermap.services.components.commontypes.ExtractParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • datumValue

          double datumValue
          
          The fiducial value of the isoline.

          Base Contour is the original value for creating the isoline, it is not necessary the smallest contour line. For instance, the raster data with altitude range from 220 to 1550, if the Base Contour is 0, Contour Interval is 50. Then when the isoline is extracted, the start point would be Base Contour 0, and the Contour Interval would be 50 For the smallest altitude value is 220, so, for the specified range, the smallest altitude for exacting isoline is 250 The result would be: the smallest isoline is 250, the largest isoline is 1550 So, if some of the value is not within the range, then it will extract that within the range

          Also, if the extract value are all not within the range. For instance, if we set the Base Contour as 1600 for the example above, Then there is no isoline that can be extracted within the altitude range, the system will throw an exception

        • interval

          double interval
          
          The contour interval.

          Contour Interval is the interval value between the two contour lines. If the contour Interval is set as 0. Then it will not use the way of adding base contour plus Contour Interval for extracting

        • expectedZValues

          double[] expectedZValues
          
          The expected analysis result Z value collection.

          It is not supported when use point dataset for isoregion extraction. There may be wrong result

          Z value is the specified value used to generate the isoline. that is, only the altitude value that is in the Z collection would be extracted

        • resampleTolerance

          double resampleTolerance
          
          Resampling Tolerance. By default, it is from 0 to raster resolution

          The larger the resample tolerance, the simpler the sample result data.

          If the result is not right, the user can adjust the Resampling Tolerance to a smaller value

        • smoothness

          int smoothness
          
          The smoothness of the isoline or isoregion boundary.

          Take 0-5 for example, 0 represeents there is no smooth operation, the bigger the value, the higher the smoothness The higher the smoothness, the smoother the isolines extracted are, and the time and memory for the calculation would be larger too. If the Contour Interval is too small, the isoline would intersect if the smoothness is too high.

        • smoothMethod

          SmoothMethod smoothMethod
          
          For setting the smooth method, please see the SmoothMethod class.
        • clipRegion

          Geometry clipRegion
          
          The region used to clip the interesting area. If you do not want to clip, you can use null instead of the parameter.
    • Class com.supermap.services.components.commontypes.FacilityAnalyst2DResult extends FacilityAnalyst3DResult implements Serializable

      • Serialized Fields

        • edgesFeatures

          Feature[] edgesFeatures
          

          The features of result edges to pass through.

        • nodesFeatures

          Feature[] nodesFeatures
          

          The features of result nodes to pass through.

    • Class com.supermap.services.components.commontypes.FacilityAnalyst3DContent extends java.lang.Object implements Serializable

      • Serialized Fields

        • directionField

          java.lang.String directionField
          
          The field that identifies the flow direction in the 3D network dataset.
        • edgeIDField

          java.lang.String edgeIDField
          

          The field that identifies the edge ID in the 3D network dataset.

        • fNodeIDfield

          java.lang.String fNodeIDfield
          

          The field that identifies the edge start node ID in the 3D network dataset.

        • tNodeIDField

          java.lang.String tNodeIDField
          
          The field that identifies the edge end node ID in the 3D network dataset.
        • nodeIDField

          java.lang.String nodeIDField
          
          The field that identifies the node ID in the 3D network dataset.
        • tolerance

          double tolerance
          

          The distance tolerance from the node to the arc.

        • weightFieldInfos

          WeightFieldInfo3D[] weightFieldInfos
          
          Weight field information collection object.
        • prjCoordSys

          PrjCoordSys prjCoordSys
          
          the projection information of the dataset.
        • barrierEdges

          int[] barrierEdges
          
          Barrier arc.
        • barrierNodes

          int[] barrierNodes
          
          The barrier point.
    • Class com.supermap.services.components.commontypes.FacilityAnalyst3DResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • cost

          double cost
          

          The cost in the facility network analysis results.

        • edges

          int[] edges
          

          The edge ID array in the facility network analysis results.

        • nodes

          int[] nodes
          

          The node ID array in the facility network analysis results.

    • Class com.supermap.services.components.commontypes.FacilityAnalystParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • isUncertainDirectionValid

          boolean isUncertainDirectionValid
          
          Used to specify whether the uncertain flow direction is valid. If set to true, it represents that the uncertain flow direction is valid. The analysis will continue even though a uncertain flow direction is encountered. If set to false, the uncertain flow direction is invalid. The analysis will stop to further query the direction when a uncertain direction flow is encountered. When the direction field value is 2, it means the flow direction of the edge is uncertain.
        • weightName

          java.lang.String weightName
          
          The name of the specified weight field
        • returnFeatures

          boolean returnFeatures
          
          Whether to return features
    • Class com.supermap.services.components.commontypes.FacilityAnalystResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • edges

          Feature[] edges
          

          The edge feature collection in the analysis result

        • edgeIDs

          int[] edgeIDs
          

          The arc ID collection in the analysis result

    • Class com.supermap.services.components.commontypes.FacilityAnalystResultOption extends java.lang.Object implements Serializable

      • Serialized Fields

        • imageReturn

          boolean imageReturn
          

          Whether the image is returned

        • edgeFeatureReturn

          boolean edgeFeatureReturn
          

          Returns whether the arc feature collection is contained in the analysis result.

          True means it includes the arc feature collection

        • edgeIDReturn

          boolean edgeIDReturn
          

          Returns whether the arc ID array is contained in the analysis result.

          True means it includes the arc ID array

    • Class com.supermap.services.components.commontypes.FareInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • fareStep

          double fareStep
          
          Gets fare increase step.
        • startFare

          double startFare
          
          Gets the start fare.
        • startFareRange

          double startFareRange
          
          Gets the range of the start fare.
        • fareType

          FareType fareType
          
          Gets the type of the bus fare.
    • Class com.supermap.services.components.commontypes.Feature extends java.lang.Object implements Serializable

      • Serialized Fields

        • geometry

          Geometry geometry
          

          ${services_components_commontypes_Feature_attribute_geometry_Title}

          ${services_components_commontypes_Feature_attribute_geometry_Description}

        • fieldValues

          java.lang.String[] fieldValues
          

          ${services_components_commontypes_Feature_attribute_fieldValues_Title}

          ${services_components_commontypes_Feature_attribute_fieldValues_Description}

        • fieldNames

          java.lang.String[] fieldNames
          

          ${services_components_commontypes_Feature_attribute_fieldNames_Title}

          ${services_components_commontypes_Feature_attribute_fieldNames_Description}

    • Class com.supermap.services.components.commontypes.FeatureMetadata extends java.lang.Object implements Serializable

      • Serialized Fields

        • createTime

          long createTime
          
          Created time.

          The millisecond from 8:00:00 on January 1, 1970.

        • createUser

          java.lang.String createUser
          
          creator.
        • lastEditTime

          long lastEditTime
          
          The last edit time.

          The millisecond from 8:00:00 on January 1, 1970.

        • lastEditUser

          java.lang.String lastEditUser
          
          The last editor.
    • Class com.supermap.services.components.commontypes.FeatureWithTimeStamp extends Feature implements Serializable

      • Serialized Fields

        • timeStamp

          long timeStamp
          
    • Class com.supermap.services.components.commontypes.FieldInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • name

          java.lang.String name
          
          Field Name

          The name is used to identifying a field. The name can not be the same

        • caption

          java.lang.String caption
          
          Field Alias

          Alias can be the same. Different field can has the same alias

        • type

          FieldType type
          
          Field type
        • defaultValue

          java.lang.String defaultValue
          
          the default value of the field.
        • maxLength

          int maxLength
          
          the maximum length of the field.
        • isRequired

          boolean isRequired
          
          Whether it is required field. True means it is required, false means it is not required.
        • isZeroLengthAllowed

          boolean isZeroLengthAllowed
          
          Whether zero length is allowed
        • isSystemField

          boolean isSystemField
          
          Whether it is SuperMap system field, true means it is. The value is readOnly

          SuperMap system fields starts with "SM" except for SMUserID

    • Class com.supermap.services.components.commontypes.FieldValuesDisplayFilter extends java.lang.Object implements Serializable

      • Serialized Fields

        • fieldName

          java.lang.String fieldName
          

          Field name, now supports the number type field; otherwise, inavailable.

          Since:
          8.0.0
        • values

          long[] values
          

          The value in the filed.

          Since:
          8.0.0
        • fieldValuesDisplayMode

          FieldValuesDisplayMode fieldValuesDisplayMode
          

          Filter mode.

          Used to control how to process the the filtered feature (display, hide and so on).

          Since:
          8.0.0
    • Class com.supermap.services.components.commontypes.FileInfoItem extends java.lang.Object implements Serializable

      • Serialized Fields

        • isDirectory

          boolean isDirectory
          
          Whether it is the directory. Default is false.
        • fileName

          java.lang.String fileName
          
          File or directory name.
        • filePath

          java.lang.String filePath
          
          The absolute path of file or directory.
        • fileSize

          long fileSize
          
          The file size. Default is 0 byte.
    • Class com.supermap.services.components.commontypes.FileUploadTaskInfo extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.FileVerificationInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • file

          java.lang.String file
          
        • digest

          java.lang.String digest
          
        • size

          java.lang.Long size
          
    • Class com.supermap.services.components.commontypes.Fog extends java.lang.Object implements Serializable

      • Serialized Fields

        • color

          Color color
          

          The fog color.

        • density

          double density
          

          The fog density.

        • mode

          FogMode mode
          

          The fog mode.

          There are three modes of fog, EXP, EXP2 and Linear, please refer to FogMode
        • endDistance

          double endDistance
          

          The terminate distance of the fog. Only valid when the mode of the fog is set as LINEAR

        • startDistance

          double startDistance
          

          The start distance of the fog. Only valid when the mode of the fog is set as LINEAR

        • enable

          boolean enable
          

          Sets whether to enable the fog effect.

    • Class com.supermap.services.components.commontypes.GDPMapLayer extends Layer implements Serializable

    • Class com.supermap.services.components.commontypes.GenerateSpatialDataParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • routeDataset

          java.lang.String routeDataset
          

          The name of the route dataset used to create spatial data.

        • routeIDField

          java.lang.String routeIDField
          

          The route identification field used to generate the spatial data in the routing data set.

        • eventTable

          java.lang.String eventTable
          

          The event table name used to generate spatial data.

        • eventRouteIDField

          java.lang.String eventRouteIDField
          

          The route identification field used to generate the event table for the spatial data.

        • measureField

          java.lang.String measureField
          

          The scale field of the event table used to generate the spatial data is meaningful only if the event is a point event.

        • measureStartField

          java.lang.String measureStartField
          

          The start scale field of the event table used to generate the spatial data is meaningful only if the event is a line event.

        • measureEndField

          java.lang.String measureEndField
          

          The end scale field of the event table used to generate the spatial data is meaningful only if the event is a line event.

        • measureOffsetField

          java.lang.String measureOffsetField
          

          Scale offset field.

        • errorInfoField

          java.lang.String errorInfoField
          

          Error message field, written directly to the original event table, is used to describe the error message of the event failed to generate the corresponding point or line.

        • retainedFields

          java.lang.String[] retainedFields
          

          The set of fields to be retained in the result spatial data (except for the system fields). Note: Route ID field, scale offset field, scale field will always be kept into spatial data results; If returnedFields parameter is not specified or the length of it is 0. Then all the user fields will be returned.

          Since:
          7.0.0

    • Class com.supermap.services.components.commontypes.GeoAddress extends java.lang.Object implements Serializable

      • Serialized Fields

        • address

          java.lang.String address
          
        • location

          Point2D location
          
        • filters

          java.lang.String[] filters
          
        • score

          double score
          
    • Class com.supermap.services.components.commontypes.GeoArc extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          The center point of the arc.

          Since:
          7.1.0
        • radius

          double radius
          

          The radius of the arc.

          Since:
          7.1.0
        • startAngle

          double startAngle
          

          The start angle of the arc.

          Since:
          7.1.0
        • sweepAngle

          double sweepAngle
          

          The sweep angle measured from the start angle defining where the arc ends.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoBSpline extends Geometry implements Serializable

      • Serialized Fields

        • controlPoints

          Point2D[] controlPoints
          

          Control points

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoCardinal extends Geometry implements Serializable

      • Serialized Fields

        • controlPoints

          Point2D[] controlPoints
          

          Control points

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoChord extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          The center of the ellipse which the GeoChord object belongs to.

          Since:
          7.1.0
        • semimajorAxis

          double semimajorAxis
          

          The semi-major axis of the ellipse which the GeoChord object belongs to.

          Since:
          7.1.0
        • semiminorAxis

          double semiminorAxis
          

          The semi-minor axis of the ellipse which the GeoChord object belongs to.

          Since:
          7.1.0
        • startAngle

          double startAngle
          

          The start angle of the elliptical arc which the GeoChord object corresponds to.

          Since:
          7.1.0
        • sweepAngle

          double sweepAngle
          

          The sweep angle of the elliptic arc corresponding to the GeoChord object.

          Since:
          7.1.0
        • rotation

          double rotation
          

          Sets the rotation angle of the GeoChord object. The pivot point is the center of the ellipse which the GeoChord object belongs to.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoCircle extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          The specified center of the circle.

          Since:
          7.1.0
        • radius

          double radius
          

          The specified radius of the circle.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoCodingParam extends java.lang.Object implements Serializable

      • Serialized Fields

        • address

          java.lang.String address
          
        • fromIndex

          int fromIndex
          
        • toIndex

          int toIndex
          
        • maxReturn

          int maxReturn
          
        • filters

          java.lang.String[] filters
          
        • targetPrj

          PrjCoordSys targetPrj
          
    • Class com.supermap.services.components.commontypes.GeoCurve extends Geometry implements Serializable

      • Serialized Fields

        • controlPoints

          Point2D[] controlPoints
          

          Control points

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoDecodingParam extends java.lang.Object implements Serializable

      • Serialized Fields

        • x

          double x
          
        • y

          double y
          
        • fromIndex

          int fromIndex
          
        • toIndex

          int toIndex
          
        • maxReturn

          int maxReturn
          
        • geoDecodingRadius

          double geoDecodingRadius
          
        • targetPrj

          PrjCoordSys targetPrj
          
        • filters

          java.lang.String[] filters
          
    • Class com.supermap.services.components.commontypes.GeoEllipse extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          the center of the ellipse.

          Since:
          7.1.0
        • semimajorAxis

          double semimajorAxis
          

          the length of the semimajor of the ellipse.

          Since:
          7.1.0
        • semiminorAxis

          double semiminorAxis
          

          The length of the semiminor of the ellipse.

          Since:
          7.1.0
        • rotation

          double rotation
          

          the rotation angle of the ellipse. The pivot point is the center of the ellipse.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoEllipticArc extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          the specified center of the ellipse where the elliptic arc lies.

          Since:
          7.1.0
        • semimajorAxis

          double semimajorAxis
          

          the length of the semimajor of the ellipse where the elliptic arc lies.

          Since:
          7.1.0
        • semiminorAxis

          double semiminorAxis
          

          the length of the semiminor of the ellipse where the elliptic arc lies.

          Since:
          7.1.0
        • startAngle

          double startAngle
          

          the start angle of the GeoEllipticArc object.

          Since:
          7.1.0
        • sweepAngle

          double sweepAngle
          

          The sweep angle measured from the start angle ranging from -360 degrees to 360 degrees defining where the elliptical arc ends.

          Since:
          7.1.0
        • rotation

          double rotation
          

          Rotation. The pivot point is the center of the ellipse which the GeoEllipticArc object belongs to.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoGraphicObject extends Geometry3D implements Serializable

      • Serialized Fields

        • libID

          int libID
          

          Label library ID.

          Since:
          8.1.0
        • code

          int code
          

          Symbol code.

          Since:
          8.1.0
        • symbolType

          int symbolType
          

          Symbol type.

          Since:
          8.1.0
        • symbolName

          java.lang.String symbolName
          

          Symbol name.

          Since:
          8.1.0
        • negativeImage

          boolean negativeImage
          

          Mirror.

          Since:
          8.1.0
        • symbolRank

          int symbolRank
          

          Symbol level.

          Since:
          8.1.0
        • scaleByMap

          boolean scaleByMap
          

          Free zoom.

          Since:
          8.1.0
        • limitWidthHeight

          boolean limitWidthHeight
          

          Width lock.

          Since:
          8.1.0
        • symbolSize

          Point2D symbolSize
          

          Symbol Size

          Since:
          8.1.0
        • anchorPoint

          Point2D anchorPoint
          

          Marker.

          Since:
          8.1.0
        • scale2D

          Point3D scale2D
          

          The zoom scale.

          Since:
          8.1.0
        • rotate2D

          Point3D rotate2D
          

          Rotation.

          Since:
          8.1.0
        • subSymbols

          int[] subSymbols
          

          Child symbol array

          Since:
          8.1.0
        • scaleValues

          double[] scaleValues
          

          Scale array

          Since:
          8.1.0
        • scalePoints

          Point2D[] scalePoints
          

          Scale point array.

          Since:
          8.1.0
        • surroundLineType

          int surroundLineType
          

          Line type

          Since:
          8.1.0
        • surroundLineColor

          Color surroundLineColor
          

          Line Color.

          Since:
          8.1.0
        • surroundLineWidth2D

          double surroundLineWidth2D
          

          2D line width.

          Since:
          8.1.0
        • textContent

          java.lang.String textContent
          

          Notation/text

          Since:
          8.1.0
        • annotationPosition

          int annotationPosition
          

          Notation position.

          Since:
          8.1.0
        • textStyle2D

          TextStyle textStyle2D
          

          Notation style.

          Since:
          8.1.0
        • innerCells

          GraphicObjectCell[] innerCells
          

          Internal image info.

          Since:
          8.1.0
        • symbolRanks

          int[] symbolRanks
          

          Symbol level supported.

          Since:
          8.1.0
        • middleMarkExist

          boolean middleMarkExist
          

          Whether it has middle notation.

          Since:
          8.1.0
        • algoMaxEditPts

          int algoMaxEditPts
          

          Max count of symbol

          Since:
          8.1.0
        • algoMinEditPts

          int algoMinEditPts
          

          Min count of symbol

          Since:
          8.1.0
        • middleMarkBounds

          Rectangle2D middleMarkBounds
          

          Notation range.

          Since:
          8.1.0
        • symbolIsCanFill

          boolean symbolIsCanFill
          

          Open graphic fill

          Since:
          8.1.0
    • Class com.supermap.services.components.commontypes.Geometry extends java.lang.Object implements Serializable

      • Serialized Fields

        • id

          int id
          

          ID of geometry

          SMID in SuperMap

        • points

          Point2D[] points
          

          2D coordinate pair collection of the node which forms the geometry object

          1,Geometry Object includes two types: simple one and complex one. The difference: The simple one is one object. The complex one is generated by multiple simple objects joining together or through spatial operation. For instance, the rectangle is the simple object, while the rectangle with a hole is the complex one.

          2, All the geometry objects(point, line, region) is concluded by simple point coordinate. The field stores the point coordinate collection that form the geometry object. For simple object, its start point coordinate and end point coordinate is the same.

          3, For the complex geometry object, the number of the nodes of the simple objects that form the complex object is decided by parts attribute. So the distribution of the coordinate pair of point2DS field can be solved

          4, For point and text object, the point2Ds[0] represents coordinate. The other value is invalid

        • parts

          int[] parts
          

          ${services_components_commontypes_Geometry_attribute_parts_Title}

          ${services_components_commontypes_Geometry_attribute_parts_Description}

        • partTopo

          int[] partTopo
          
          The topology structure of part. Only the Geometry that GeometryType equals REGION includes this field. 1 represents island, -1 means hole.
        • type

          GeometryType type
          

          The type of the geometry object.

        • style

          Style style
          

          ${services_components_commontypes_Geometry_attribute_style_Title}

          ${services_components_commontypes_Geometry_attribute_style_Description}

        • prjCoordSys

          PrjCoordSys prjCoordSys
          

          The projected coordinate system of geoemtry object

    • Class com.supermap.services.components.commontypes.Geometry3D extends Geometry implements Serializable

      • Serialized Fields

        • rotationX

          double rotationX
          

          Returns the rotation angle of the3D geometry object relative to X Axis, in degree.

        • rotationY

          double rotationY
          

          Returns the rotation angle of the3D geometry object relative to Y Axis, in degree.

        • rotationZ

          double rotationZ
          

          Returns the rotation angle of the3D geometry object relative to Z Axis, in degree.

        • scaleX

          double scaleX
          

          The zoom scale of the3D geometry object relative to X Axis.

        • scaleY

          double scaleY
          

          The zoom scale of the3D geometry object relative to Y Axis.

        • scaleZ

          double scaleZ
          

          The zoom scale of the3D geometry object relative to Z Axis.

        • position

          Point3D position
          
          the location of the geometry3D
    • Class com.supermap.services.components.commontypes.GeometryCompound extends Geometry implements Serializable

      • Serialized Fields

    • Class com.supermap.services.components.commontypes.GeometryOverlayResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • operateGeometry

          Geometry operateGeometry
          
          Deprecated. 
        • sourceGeometry

          Geometry sourceGeometry
          
          Deprecated. 
        • result

          java.lang.Object result
          
          Deprecated. 
    • Class com.supermap.services.components.commontypes.GeometrySpatialAnalystResult extends SpatialAnalystResult implements Serializable

      • Serialized Fields

        • resultGeometry

          Geometry resultGeometry
          
          The geometry object spatial analyst result.
        • image

          ImageResult image
          

          The SpatialAnalyst result images

          The description about the images generated by SuperMap iServer spatial analysis. The image parameters can be set by ImageParameter, including the range, scale of the image. The URL address of the image can be obtained by ImageResult.imageURL.

    • Class com.supermap.services.components.commontypes.GeometrySpatialAnalystResultSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • returnGeometry

          boolean returnGeometry
          
          Whether return geometry object when the analysis is finished. The default is true
        • returnImage

          boolean returnImage
          

          Whether return image after analysis

        • imageParameter

          ImageParameter imageParameter
          
          Image parameter setting. Set the range, center point, scale of the image. Please refer to ImageParameter
        • imageOutputOption

          ImageOutputOption imageOutputOption
          
          Image output setting, including the background color, transparency, format, etc. Please refer to imageOutputOption
    • Class com.supermap.services.components.commontypes.GeometryText extends Geometry implements Serializable

      • Serialized Fields

        • textStyle

          TextStyle textStyle
          
          The text style of the text object.
        • texts

          java.lang.String[] texts
          
          The content of the text object.
        • rotations

          double[] rotations
          
          The rotation of the text.
    • Class com.supermap.services.components.commontypes.GeometryWithPrjCoordSys extends Geometry implements Serializable

    • Class com.supermap.services.components.commontypes.GeoModel extends Geometry3D implements Serializable

      • Serialized Fields

        • boundingBox

          BoundingBox3D boundingBox
          

          The Bounding Box of the model.

        • name

          java.lang.String name
          
          The name of geometry object of 3d model.
    • Class com.supermap.services.components.commontypes.GeoModel3D extends Geometry3D implements Serializable

      • Serialized Fields

        • boundingBox

          BoundingBox3D boundingBox
          

          The Bounding Box of the model.

        • model

          byte[] model
          
    • Class com.supermap.services.components.commontypes.GeoPackageMapLayer extends Layer implements Serializable

    • Class com.supermap.services.components.commontypes.GeoPackageSubLayer extends GeoPackageMapLayer implements Serializable

      • Serialized Fields

    • Class com.supermap.services.components.commontypes.GeoPie extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          the center of the ellipse which the GeoPie object belongs to.

          Since:
          7.1.0
        • semimajorAxis

          double semimajorAxis
          

          The length of the semi-major axis of the ellipse which the GeoPie object belongs to.

          Since:
          7.1.0
        • semiminorAxis

          double semiminorAxis
          

          The length of the semi-minor axis of the ellipse which the GeoPie object belongs to.

          Since:
          7.1.0
        • startAngle

          double startAngle
          

          The sweep angle measured from the start angle ranging from -360 degrees to 360 degrees defining where the elliptical arc ends.

          Since:
          7.1.0
        • sweepAngle

          double sweepAngle
          

          The rotation angle of the GeoPie object. The pivot point is the center of the ellipse which the GeoPie object belongs to.

          Since:
          7.1.0
        • rotation

          double rotation
          

          Sets the rotation angle of the GeoPie object. The pivot point is the center of the ellipse which the GeoPie object belongs to.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoRectangle extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          Center point.

          Since:
          7.1.0
        • height

          double height
          

          The height of the GeoRectangle object before rotating.

          Since:
          7.1.0
        • width

          double width
          

          The width of the GeoRectangle object before rotating.

          Since:
          7.1.0
        • rotation

          double rotation
          

          The rotation angle of the Rectangle2D object. The pivot point is the center point of the Rectangle2D object.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoRelationParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • sourceFilter

          QueryParameter sourceFilter
          

          The source dataset query parameter in spatial relation analysis. Only name, ids, attributeFilter and fields are available

        • referenceFilter

          QueryParameter referenceFilter
          

          The reference dataset query parameter in spatial relation analysis. Only name, ids, attributeFilter and fields are available

        • spatialRelationType

          SpatialRelationType spatialRelationType
          

          The spatial relation type specified.

        • isBorderInside

          boolean isBorderInside
          

          Whether the point or line on the border is inside the object, that is whether the line with only one endpoint on the border is intersect with the region.

        • returnFeature

          boolean returnFeature
          

          Whether to return Feature information.

        • returnGeoRelatedOnly

          boolean returnGeoRelatedOnly
          

          Whether to return the spatial object that meet the specified spatial relationship, the default is True.

        • startRecord

          int startRecord
          

          The start location of the spatial relationship analysis, the default is 0.

        • expectCount

          int expectCount
          

          The number of the expected result records in the spatial analysis, the default is 500. If the number of the records is less than 500, then it will return all the analysis results.

    • Class com.supermap.services.components.commontypes.GeoRelationResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • source

          java.lang.Object source
          

          Source spatial object or source spatial data ID. Return the source spatial object if returnFeature=true, return the source spatial data ID otherwise.

        • count

          int count
          

          The number of objects in the action dataset that meets a given georelation with the source dataset.

        • result

          java.lang.Object[] result
          

          The object array or object ID array in the operating dataset that meet the given spatial relation with the source spatial object. Return the object array if returnFeature=true, return object ID array otherwise.

    • Class com.supermap.services.components.commontypes.GeoRoundRectangle extends Geometry implements Serializable

      • Serialized Fields

        • center

          Point2D center
          

          Center point.

          Since:
          7.1.0
        • height

          double height
          

          The height before rotating.

          Since:
          7.1.0
        • width

          double width
          

          The width before rotating.

          Since:
          7.1.0
        • radiusX

          double radiusX
          

          The length of the semi-major axis of the round corner.

          Since:
          7.1.0
        • radiusY

          double radiusY
          

          The length of the semi-minor axis of the round corner.

          Since:
          7.1.0
        • rotation

          double rotation
          

          Rotation. The pivot point is the center point of the Rectangle2D object.

          Since:
          7.1.0
    • Class com.supermap.services.components.commontypes.GeoStyle3D extends java.lang.Object implements Serializable

      • Serialized Fields

        • altitudeMode

          AltitudeMode altitudeMode
          

          The altitude mode.

        • bottomAltitude

          double bottomAltitude
          

          The bottom altitude value. When the two-dimensional geometric object displays as the 3D geometric object in the 3D window, the value can be used to display the two-dimensional geometric object on this altitude.

        • extendedHeight

          double extendedHeight
          

          The extended height value. When the two-dimensional geometric object displays as the 3D geometric object in the 3D window, the value can be used as the extended height to vertically stretch the two-dimensional geometric object.

        • sideTextureFiles

          java.lang.String[] sideTextureFiles
          

          The full paths of a series of image files for texture rendering. The sides of the 3D object will use the property for texture rendering.

        • fillMode

          FillMode3D fillMode
          

          The fill mode of the 3D body object.

          There are three fill modes of the 3D body object: Line, Fill, and Line And Fill.
        • fillForeColor

          Color fillForeColor
          

          The color of the 3D line geometry object.

        • lineColor

          Color lineColor
          

          The color of the 3D line geometry object.

        • lineWidth

          double lineWidth
          

          The width of the 3D line geometry object.

        • markerIconFile

          java.lang.String markerIconFile
          

          The full path of the 3D point geometry object icon. The icon can be used to symbolize 3D point geometry objects.

        • markerIconScale

          double markerIconScale
          

          The zoom ratio of the marker icon.

        • getMarkerColor

          Color getMarkerColor
          

          The color of the 3D point geometry object.

        • markerSize

          double markerSize
          

          The size of the 3D point geometry object and the unit is 0.1 mm.

        • tilingU

          double tilingU
          

          The horizontal repeat numbers of the side texture.

          The specified images can be used to render the sides of the 3D object. When rendering, the image will be stretched according to the image size, the side size, and the vertical and horizontal repeat times. The horizontal repeat times can be a decimal and it is specified by tilingU.
        • tilingV

          double tilingV
          

          The vertical repeat numbers of the side texture.

          The specified images can be used to render the sides of the 3D object. When rendering, the image will be stretched according to the image size, the side size, and the vertical and horizontal repeat times. The vertical repeat times can be a decimal and it is specified by tilingV.
        • topTextureFile

          java.lang.String topTextureFile
          

          The full path of the top texture image.

          If there are several top texture image files, the paths of those files are separated by ";". The top of the 3D body object will use the image for texture rendering.
        • xml

          java.lang.String xml
          
    • Class com.supermap.services.components.commontypes.GetFeatureParameters extends java.lang.Object implements Serializable

      • Serialized Fields

        • datasourceName

          java.lang.String datasourceName
          
          The datasource name.
        • fields

          java.lang.String[] fields
          
          The array of fields to be returned. All the fields are returned if this parameter is null.
        • maxFeatures

          int maxFeatures
          
          The maximum features to be returned.
        • fromIndex

          int fromIndex
          

          The minimum index of the result.

          Since:
          8.1.1
        • toIndex

          int toIndex
          

          The maxmum index of the result, ie., the query results locate in range [fromIndex, toIndex].

          Since:
          8.1.1
        • targetPrj

          PrjCoordSys targetPrj
          
          The coordinate system of the query result.
    • Class com.supermap.services.components.commontypes.GetFeatureParameters.BoundsParameters extends GetFeatureParameters implements Serializable

      • Serialized Fields

        • datasetName

          java.lang.String datasetName
          
          The dataset name.
        • bounds

          Rectangle2D bounds
          
          The specified query bounds.
        • sourcePrj

          PrjCoordSys sourcePrj
          
          The projection used by the bounds for query.
        • attributeFilter

          java.lang.String attributeFilter
          
          The attribute filter condition. For example, fieldValue < 100, name like '%Hotel%'
    • Class com.supermap.services.components.commontypes.GetFeatureParameters.BufferParameters extends GetFeatureParameters implements Serializable

      • Serialized Fields

        • datasetName

          java.lang.String datasetName
          
          The dataset name.
        • geometry

          Geometry geometry
          
          The geometric object.
        • bufferDistance

          double bufferDistance
          
          The buffer distance and the unit is the coordUnit of current dataset.
        • attributeFilter

          java.lang.String attributeFilter
          
          The attribute filter condition. For example, fieldValue < 100, name like '%Hotel%'
    • Class com.supermap.services.components.commontypes.GetFeatureParameters.IDParameters extends GetFeatureParameters implements Serializable

      • Serialized Fields

        • ids

          int[] ids
          
        • datasetName

          java.lang.String datasetName
          
    • Class com.supermap.services.components.commontypes.GetFeatureParameters.SpatialParameters extends GetFeatureParameters implements Serializable

      • Serialized Fields

        • datasetName

          java.lang.String datasetName
          
          The dataset name.
        • geometry

          Geometry geometry
          
          The geometric object.
        • spatialQueryMode

          SpatialQueryMode spatialQueryMode
          
          The spatial query mode.
        • attributeFilter

          java.lang.String attributeFilter
          
          The attribute filter condition. For example, fieldValue < 100, name like '%Hotel%'
    • Class com.supermap.services.components.commontypes.GetFeatureParameters.SQLParameters extends GetFeatureParameters implements Serializable

    • Class com.supermap.services.components.commontypes.GetFeatureResult extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.GetGraphicObjectParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • libID

          int libID
          
          Label library ID.
        • code

          int code
          
          Symbol code.
        • inputPoints

          Point2D[] inputPoints
          
          Input point.
        • symbolRank

          int symbolRank
          
          Symbol level.
        • negativeImage

          boolean negativeImage
          
          Symbol mirror.
        • surroundLineType

          int surroundLineType
          
          Line type
        • subSymbols

          int[] subSymbols
          
          Child symbol.
        • scaleValues

          double[] scaleValues
          
          Scale value.
        • scalePoints

          Point2D[] scalePoints
          
          Original scale point.
        • newScalePoint

          Point2D newScalePoint
          
          Modify scale point.
        • newScalePointIndex

          int newScalePointIndex
          
          Modify scale index.
    • Class com.supermap.services.components.commontypes.GraphicObjectCell extends java.lang.Object implements Serializable

      • Serialized Fields

        • type

          int type
          

          Primitive type.

          Since:
          8.1.0
        • surroundLineFlag

          boolean surroundLineFlag
          

          Line mark.

          Since:
          8.1.0
        • positionPoints

          Point2D[] positionPoints
          

          Point string.

          Since:
          8.1.0
        • style

          Style style
          

          Style.

          Since:
          8.1.0
        • textStyle

          TextStyle textStyle
          

          Text style.

          Since:
          8.1.0
        • surroundLineType

          int surroundLineType
          

          Line type

          Since:
          8.1.0
        • surroundLineColor

          Color surroundLineColor
          

          Line Color.

          Since:
          8.1.0
        • surroundLineWidth

          double surroundLineWidth
          

          2D line width.

          Since:
          8.1.0
        • textContent

          java.lang.String textContent
          

          Text contents.

          Since:
          8.1.0
        • lineTypeLimit

          boolean lineTypeLimit
          

          Line control.

          Since:
          8.1.0
        • lineWidthLimit

          boolean lineWidthLimit
          

          Line wide control.

          Since:
          8.1.0
        • lineColorLimit

          boolean lineColorLimit
          

          Line color control.

          Since:
          8.1.0
        • fillLimit

          boolean fillLimit
          

          Fill control.

          Since:
          8.1.0
        • fillColorLimit

          boolean fillColorLimit
          

          Fill color control.

          Since:
          8.1.0
        • surroundLineLimit

          boolean surroundLineLimit
          

          Line control.

          Since:
          8.1.0
        • fontColorLimit

          boolean fontColorLimit
          

          Font color control.

          Since:
          8.1.0
    • Class com.supermap.services.components.commontypes.GridValue extends java.lang.Object implements Serializable

      • Serialized Fields

        • value

          double value
          
          Grid value.
        • row

          int row
          
          Grid row.
        • column

          int column
          
          Grid column.
        • centerPoint

          Point2D centerPoint
          
          The coordinate of center of grid
    • Class com.supermap.services.components.commontypes.GridValues extends java.lang.Object implements Serializable

      • Serialized Fields

        • rowCount

          int rowCount
          
          Count of grid row.
        • columnCount

          int columnCount
          
          Count of grid column.
        • valuesCount

          int valuesCount
          
          Grid count in 2D array.
        • values

          GridValue[][] values
          
          2D array of grid values.
    • Class com.supermap.services.components.commontypes.HighlightTarget extends java.lang.Object implements Serializable

      • Serialized Fields

        • geometries

          Geometry[] geometries
          

          ${services_components_commontypes_HighlightTarget_attribute_geometries_Title}

          ${services_components_commontypes_HighlightTarget_attribute_geometries_Description}

        • geometryIDs

          int[] geometryIDs
          

          ${services_components_commontypes_HighlightTarget_attribute_geometryIDs_Title}

          ${services_components_commontypes_HighlightTarget_attribute_geometryIDs_Description}

        • style

          Style style
          

          ${services_components_commontypes_HighlightTarget_attribute_style_Title}

          ${services_components_commontypes_HighlightTarget_attribute_style_Description}

        • name

          java.lang.String name
          

          ${services_components_commontypes_HighlightTarget_attribute_name_Title}

          ${services_components_commontypes_HighlightTarget_attribute_name_Description}

    • Class com.supermap.services.components.commontypes.ImageOutputOption extends java.lang.Object implements Serializable

      • Serialized Fields

        • backColor

          Color backColor
          

          ${services_components_commontypes_ImageOutputOption_attribute_backColor_Title}

          ${services_components_commontypes_ImageOutputOption_attribute_backColor_Description}

        • foreColor

          Color foreColor
          

          ${services_components_commontypes_ImageOutputOption_attribute_foreColor_Title}

          ${services_components_commontypes_ImageOutputOption_attribute_foreColor_Description}

        • format

          OutputFormat format
          

          Output format of the image

          Only transparent PNG format is support for the tracking layer

          Note: If the output format is PNG, while setting the background color of the image to transparent, parameter, the background color of the output image will be black, not transparent, if the color quality of the computer is set to 16-bit. However, if the color quality of the computer is set to 32-bit, the output image will have a transparent background.

        • transparent

          boolean transparent
          

          whether the map image are transparent.

          The setting is used for the overlay of multiple map images to build composite map. If the transparency of the map is no transparency, than the setting would not work. Only PNG format image transparency is supported.

          Note: If the output format is PNG, while setting the background color of the image to transparent, parameter, the background color of the output image will be black, not transparent, if the color quality of the computer is set to 16-bit. However, if the color quality of the computer is set to 32-bit, the output image will have a transparent background.

        • pdfOption

          PDFOption pdfOption
          

          ${services_components_commontypes_ImageOutputOption_attribute_pdfOption_Title}

          ${services_components_commontypes_ImageOutputOption_attribute_pdfOption_Description}

    • Class com.supermap.services.components.commontypes.ImageParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • bounds

          Rectangle2D bounds
          
          The range of the image
        • viewer

          Rectangle viewer
          
          View
        • center

          Point2D center
          
          Center point, it decides the range of the image together with the scale
        • scale

          double scale
          
          Scale, it decides the range of the image together with the center point
        • prjCoordSys

          PrjCoordSys prjCoordSys
          
          Setting Projections
        • style

          Style style
          

          Style setting, including the styles of the point, line and region

    • Class com.supermap.services.components.commontypes.ImageResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • imageParameter

          ImageParameter imageParameter
          
          Parameter of the image, including range, scales, style, etc. Please refer to ImageParameter
        • imageURL

          java.lang.String imageURL
          
          The URL address of the image

          GIS server would create the images of the map accroding to the client request. The images are named and saved on a fixed location. The server would provide the URL of the images

        • imageData

          byte[] imageData
          
          The binary streams of the picture.

          Only when the image output format is ImageOutputOption.format of OutputFormat.BINARY, this field would store the binary stream of the image, otherwise it is null

    • Class com.supermap.services.components.commontypes.ImageValue extends java.lang.Object implements Serializable

      • Serialized Fields

        • value

          int value
          
          Image integer value
        • row

          int row
          
        • column

          int column
          
        • bounds

          int[] bounds
          
          Band value array.
        • color

          Color color
          
        • centerPoint

          Point2D centerPoint
          
          The coordinate of center of pixel
    • Class com.supermap.services.components.commontypes.ImageValues extends java.lang.Object implements Serializable

      • Serialized Fields

        • rowCount

          int rowCount
          
          Count of image row.
        • columnCount

          int columnCount
          
          Count of grid column.
        • valuesCount

          int valuesCount
          
          Grid count in 2D array.
        • values

          ImageValue[][] values
          
          2D array of grid values.
    • Class com.supermap.services.components.commontypes.IndexUpdateParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • workspacePath

          java.lang.String workspacePath
          

          Workspace path.

          Since:
          8.1.1
        • datasourceName

          java.lang.String datasourceName
          

          The datasource name.

          Since:
          8.1.1
        • datasetNames

          java.lang.String datasetNames
          

          The dataset name.

          Since:
          8.1.1
        • providerNames

          java.util.List<E> providerNames
          

          The names of service providers

          Since:
          8.1.1
        • isDatasetAppended

          boolean isDatasetAppended
          

          Whether to append dataset

          Since:
          8.1.1
    • Class com.supermap.services.components.commontypes.InstancesAuthorizeSetting extends java.lang.Object implements Serializable

      • Serialized Fields

        • instances

          java.lang.String[] instances
          

          Service instance name array

          Since:
          6.1.3
        • authorizeSetting

          AuthorizeSetting authorizeSetting
          

          The authorization information corresponding to the service instance

          Since:
          6.1.3
        • addRoles

          java.lang.String[] addRoles
          

          The added user

          Since:
          6.1.3
        • removeRoles

          java.lang.String[] removeRoles
          

          The user to be deleted

          Since:
          6.1.3
    • Class com.supermap.services.components.commontypes.InterpolationDensityParameter extends InterpolationParameter implements Serializable

    • Class com.supermap.services.components.commontypes.InterpolationIDWParameter extends InterpolationParameter implements Serializable

      • Serialized Fields

        • power

          int power
          
          The specified power of the weight distance.
    • Class com.supermap.services.components.commontypes.InterpolationKrigingParameter extends InterpolationParameter implements Serializable

      • Serialized Fields

        • angle

          double angle
          
          Angle of rotation in Kelujin algorithm. The attribute is not available when InterpolationParameter.searchMode is SearchMode.QUADTREE.
        • nugget

          double nugget
          
          The nugget effect:
        • range

          double range
          
          The range
        • sill

          double sill
          
          The sill.
        • variogramMode

          VariogramMode variogramMode
          
          The semivariogram used in the Kriging Interpolation Method.
    • Class com.supermap.services.components.commontypes.InterpolationParameter extends java.lang.Object implements Serializable

      • Serialized Fields

        • inputDatasourceName

          java.lang.String inputDatasourceName
          
          The datasource name of the dataset used for interpolation analysis
        • inputDatasetName

          java.lang.String inputDatasetName
          
          The dataset name for interpolation analysis
        • inputPoints

          Point3D[] inputPoints
          
          The discrete point coordinate(including z value) for interpolation, inputDatasourceName,inputDatasetName,zValueFieldName are not necessary when use discrete point for interpolation
        • filterQueryParameter

          QueryParameter filterQueryParameter
          
          The dataset filter.
        • zValueFieldName

          java.lang.String zValueFieldName
          
          Stores the field name which value is used in the interpolation analysis.The field of text type is not supported by interpolation analysis.
        • zValueScale

          double zValueScale
          
          Specifies the zoom scale of the value to be interpolated.
        • outputDatasourceName

          java.lang.String outputDatasourceName
          
          Datasource for storing the output datasets
        • outputDatasetName

          java.lang.String outputDatasetName
          
          Specifies the name of the output dataset.
        • pixelFormat

          PixelFormat pixelFormat
          
          Specify the pixel format stored in the result raster dataset, RGB,RGBA and BIT64 are not supported in interpolation analysis.
        • bounds

          Rectangle2D bounds
          
          The extent of the interpolation analysis, used to specify the extent of the result.
        • resolution

          double resolution
          
          The specified resolution used in interpolation analysis.
        • searchMode

          SearchMode searchMode
          
          The mode of searching operation point in interpolation analysis.
        • searchRadius

          double searchRadius
          
          The search extent used in the operation points.
        • expectedCount

          int expectedCount
          
          The number of points to search.
        • maxPointCountForInterpolation

          int maxPointCountForInterpolation
          
          The maximum count of interpolation points when using the QuadTree method to search for points.
        • maxPointCountInNode

          int maxPointCountInNode
          
          The maximum count of interpolation points in each quad when searching with the QuadTree mode.
        • clipParam

          ClipParameter clipParam
          
          The parameter to clip the interpolation analysis result.
    • Class com.supermap.services.components.commontypes.InterpolationRBFParameter extends InterpolationParameter implements Serializable

      • Serialized Fields

        • smooth

          double smooth
          
          Smooth coefficient, the range is 0-1.
        • tension

          double tension
          
          Tension coefficient.
    • Class com.supermap.services.components.commontypes.InterpolationResult extends java.lang.Object implements Serializable

      • Serialized Fields

        • succeed

          boolean succeed
          

          Returns true if analysis successfully; otherwise false.

        • msg

          java.lang.String msg
          

          The related info during analysis

        • resultDatasetInfo

          DatasetInfo resultDatasetInfo
          
          Analysis results dataset info
    • Class com.supermap.services.components.commontypes.InterpolationSimpleKrigingParameter extends InterpolationKrigingParameter implements Serializable

      • Serialized Fields

        • mean

          double mean
          
          The mean value of the interpolation field, the summation of sampling points’ interpolation field values divided by the amount of the sampling points.
    • Class com.supermap.services.components.commontypes.InterpolationUniversalKrigingParameter extends InterpolationKrigingParameter implements Serializable

      • Serialized Fields

        • exponent

          Exponent exponent
          
          The order of the trend surface equation in the sampling data used for interpolation.
    • Class com.supermap.services.components.commontypes.JobBuildConfig extends JobInfo implements Serializable

      • Serialized Fields

        • jobId

          java.lang.String jobId
          

          Caching task ID.

        • scaleConfigs

          ScaleBuildConfig[] scaleConfigs
          

          The scale information of caching task.

        • mapStatusHashcode

          java.lang.String mapStatusHashcode
          

          A hashcode to mark the map status. The value is null ,which means not distinguishing map status.

        • cutomParameter

          java.lang.String cutomParameter
          
        • isRetile

          boolean isRetile
          
        • prjCoordSys

          PrjCoordSys prjCoordSys
          
        • tileRegions

          java.util.List<E> tileRegions
          

          Tile area list. The same tile areas have the same settings.

        • local

          boolean local
          

          Whether it is the task that local master deployed to worker. It it is, call-back to inform.

          Since:
          7.0.1
        • masterAddress

          java.lang.String masterAddress
          

          The tile server address.

          Since:
          7.0.1
        • tilesetDesc

          TilesetDesc tilesetDesc
          

          Information description of tile result.

          Since:
          7.0.1
    • Class com.supermap.services.components.commontypes.JobDeployingInfo extends TileWorkerInfo implements Serializable

      • Serialized Fields

        • deployingStatus

          JobDeployingInfo.DeployingStatus deployingStatus
          

          The deployment status.

          Since:
          7.0.1
        • errorStatus

          JobDeployingInfo.ErrorStatus errorStatus
          

          The error status.

          Since:
          7.0.1
        • total

          java.math.BigInteger total
          

          The total bytes to be uploaded.

          Since:
          7.0.1
        • uploaded

          java.math.BigInteger uploaded
          

          The uploaded bytes.

          Since:
          7.0.1
        • retryTime

          long retryTime
          

          The retry time if an error occurs and retry. Some errors cannot be given a retry.

          Since:
          7.0.1
        • retryDelay

          long retryDelay
          

          The retry delay if an error occurs and retry. The unit is milliseconds. This field calculates every time when requesting JobInfo according to JobDeployingInfo.retryTime.

          Since:
          7.0.1
        • fileVerificationMode

          FileVerificationMode fileVerificationMode
          

          File verification mode.

          By default, it is verified by file size.

    • Class com.supermap.services.components.commontypes.JobExecutingState extends java.lang.Object implements Serializable

    • Class com.supermap.services.components.commontypes.JobExecutingStates extends java.lang.Object implements Serializable

      • Serialized Fields

        • jobStates

          JobExecutingState[] jobStates
          

          State set on worker

        • updateTime

          long updateTime
          

          Update time.

    • Class com.supermap.services.components.commontypes.JobInfo extends java.lang.Object implements Serializable

      • Serialized Fields

        • dataConnectionString

          java.lang.String dataConnectionString
          

          The connection information of data to be tiled, there are two expressions, one is the service component name, such as "map-china400", the other is service component configuration information.

        • mapName

          java.lang.String mapName
          

          Tiled map name.

        • scaleDenominators

          double[] scaleDenominators
          

          Denominator set of caching scale, such as ["1000000","2000000"].

        • resolutions

          double[] resolutions
          
          Caching resolution set, you can choose one from resolution or scaleDenominators for setting.
        • originalPoint

          Point2D originalPoint
          

          Caching index start, for calculating the node point coordinates of caching, the default point is top-left point of the map.

        • cacheBounds

          Rectangle2D cacheBounds
          

          The caching range, such as [0,0,180,90], the default value is the extent range if not set.

        • tileSize

          TileSize tileSize
          

          The size of the cache image, the default is 256.

        • format

          OutputFormat format
          

          Cache image format, such as "PNG".

        • compressionQuality

          float compressionQuality
          

          JPG image compression rate.

        • transparent

          boolean transparent
          

          Whether the images are transparent, the default value is False.

        • epsgCode

          int epsgCode
          

          The caching coordinate system, it will use the original map coordinate system if not set.

        • storeConfig

          TileSourceInfo storeConfig
          
          Tile storage configuration.
        • createNewTileVersion

          boolean createNewTileVersion
          
          Whether to create new tile version.
        • tileVersionDescription

          java.lang.String tileVersionDescription
          
          The descriptive information of new version. It is supported only when JobInfo.createNewTileVersion is true.
        • parentTileVersion

          java.lang.String parentTileVersion
          
          The father version of current new caching version, null means creating version based on the last update version.
        • actualTileVersion

          java.lang.String actualTileVersion
          
        • refMapRestAdress

          java.lang.String refMapRestAdress
          
        • taskAssignmentType

          TaskAssignmentType taskAssignmentType
          
          Task distribution method.
        • cacheVersion

          CacheVersion cacheVersion
          

          Cache Version

          Configuration is needed only when caching by UGO.

        • storageType

          StorageType storageType
          

          Storage type.

        • vectorBounds

          java.lang.String vectorBounds
          

          The vector range of caching task.

          UDB file path.

        • tileType

          TileType tileType
          

          Tile type.

        The three tile format supported by iServer.
      • Image: Raster tile
      • UTFGrid: Attribute tile
      • Vector: Vector tile

utfGridParameter

UTFGridJobParameter utfGridParameter

UTFGrid configuration parameter.

The parameter is supported only when JobInfo.tileType is UTFGrid.

vectorParameter

VectorJobParameter vectorParameter

Vector tile configuration parameter.

The parameter is supported only when JobInfo.tileType is Vector.

realspaceParameter

RealspaceJobParameter realspaceParameter

3D tiles configuration.

It is valid when JobInfo.tileType is Terrain or RealspaceImage.

createStandardMBTiles

boolean createStandardMBTiles

Whether to create the standard MBTiles.

It is valid when the storage type is SMTiles.

dataPreProcessInfo

DataPreProcessInfo dataPreProcessInfo

Whether to process data

convertToPng8

boolean convertToPng8
Try to convert the image to PNG8.

fileVerificationMode

FileVerificationMode fileVerificationMode

File verification mode.

By default, it is verified by file size.

autoAvoidEffectEnabled

boolean autoAvoidEffectEnabled
Whether to enable auto avoid.

cacheRegions

CacheRegionsInfo cacheRegions
The tile region.

Supports to tile based on irregular polygon. The JobInfo.cacheBounds will be invalid after setting this parameter.

useLocal

boolean useLocal
Whether the main node attends the tiling.

The master node will increase the pressure of the master node tiling, leading to affect the scheduling performance and stability of the master node tiling.
When there are more than two child nodes, it is suggest that set the main node does not tile

Class com.supermap.services.components.commontypes.JoinItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • foreignTableName

      java.lang.String foreignTableName
      

      ${services_components_commontypes_JoinItem_attribute_foreignTableName_Title}

      ${services_components_commontypes_JoinItem_attribute_foreignTableName_Description}

    • joinFilter

      java.lang.String joinFilter
      

      ${services_components_commontypes_JoinItem_attribute_joinFilter_Title}

      ${services_components_commontypes_JoinItem_attribute_joinFilter_Description}

    • joinType

      JoinType joinType
      

      ${services_components_commontypes_JoinItem_attribute_joinType_Title}

      ${services_components_commontypes_JoinItem_attribute_joinType_Description}

Class com.supermap.services.components.commontypes.KeywordsQueryParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      
      Layer names
    • keywords

      java.lang.String keywords
      

      The key words query. Multiple key words are separated by comma or space.

      The layers you query include key words.

Class com.supermap.services.components.commontypes.KeywordsQueryParameterSet extends java.lang.Object implements Serializable

  • Serialized Fields

    • startRecord

      int startRecord
      
      The query start record position, the default is 0.
    • expectCount

      int expectCount
      
      The expect count. The value is greater than 0.
    • keywords

      java.lang.String keywords
      

      The key words query. Multiple key words are separated by comma or space.

      The layers you query include element set of the key words.

      The property is valid only when KeywordsQueryParameterSet#queryParameters is null.

    • queryOption

      QueryOption queryOption
      

      The query result option object used to specify the content contained in the query result. By default, it returns properties and geometric entities, i.e., QueryOption.ATTRIBUTEANDGEOMETRY.

      ${services_components_commontypes_QueryParameterSet_attribute_queryOption_Description}

    • queryParams

      KeywordsQueryParameter[] queryParams
      
      The array of key words query parameters.

Class com.supermap.services.components.commontypes.LabelImageCell extends LabelMatrixCell implements Serializable

  • Serialized Fields

    • height

      double height
      

      ${services_components_commontypes_LabelImageCell_attribute_height_Title}

      ${services_components_commontypes_LabelImageCell_attribute_height_Description}

    • pathField

      java.lang.String pathField
      

      ${services_components_commontypes_LabelImageCell_attribute_pathField_Title}

      ${services_components_commontypes_LabelImageCell_attribute_pathField_Description}

    • rotation

      double rotation
      

      ${services_components_commontypes_LabelImageCell_attribute_rotation_Title}

      ${services_components_commontypes_LabelImageCell_attribute_rotation_Description}

    • width

      double width
      

      ${services_components_commontypes_LabelImageCell_attribute_width_Title}

      ${services_components_commontypes_LabelImageCell_attribute_width_Description}

    • sizeFixed

      boolean sizeFixed
      

      ${services_components_commontypes_LabelImageCell_attribute_sizeFixed_Title}

      ${services_components_commontypes_LabelImageCell_attribute_sizeFixed_Description}

Class com.supermap.services.components.commontypes.LabelMatrixCell extends java.lang.Object implements Serializable

  • Serialized Fields

Class com.supermap.services.components.commontypes.LabelMixedTextStyle extends java.lang.Object implements Serializable

  • Serialized Fields

    • defaultStyle

      TextStyle defaultStyle
      

      ${services_components_commontypes_LabelMixedTextStyle_attribute_defaultStyles_Title}

      ${services_components_commontypes_LabelMixedTextStyle_attribute_defaultStyles_Description}

    • separator

      java.lang.String separator
      

      The text separator, the style of which employs the default style. The separator can be only one character.

      The separator is a symbol which is used to separate the text. Supposes there are the style arrays such as Style1,Style2, DefaultStyle. If "_" is defined as the separator, the text "5_109" is separate into two parts, "5" and "109". At this time the character "5" has the display style with the Style1 and the separator and "_" has the same display style with the DefaultStyle and the rest characters, "1", "0", "9", have the same style with the style3.

    • splitIndexes

      int[] splitIndexes
      

      ${services_components_commontypes_LabelMixedTextStyle_attribute_splitIndexes_Title}

      ${services_components_commontypes_LabelMixedTextStyle_attribute_splitIndexes_Description}

    • styles

      TextStyle[] styles
      

      ${services_components_commontypes_LabelMixedTextStyle_attribute_styles_Title}

      ${services_components_commontypes_LabelMixedTextStyle_attribute_styles_Description}

    • separatorEnabled

      boolean separatorEnabled
      

      ${services_components_commontypes_LabelMixedTextStyle_attribute_separatorEnabled_Title}

      ${services_components_commontypes_LabelMixedTextStyle_attribute_separatorEnabled_Description}

Class com.supermap.services.components.commontypes.LabelSymbolCell extends LabelMatrixCell implements Serializable

  • Serialized Fields

    • style

      Style style
      

      The symbol style. The symbol code of Style (also the style ID) does not work here, the symbol style ID is indicated by LabelSymbolCell.symbolIDField.

      ${services_components_commontypes_LabelSymbolCell_attribute_style_Description}

    • symbolIDField

      java.lang.String symbolIDField
      

      Symbol ID or the field name for recording symbol ID.

      ${services_components_commontypes_LabelSymbolCell_attribute_symbolIDField_Description}

Class com.supermap.services.components.commontypes.LabelThemeCell extends LabelMatrixCell implements Serializable

  • Serialized Fields

    • themeLabel

      ThemeLabel themeLabel
      

      ${services_components_commontypes_LabelThemeCell_attribute_themeLabel_Title}

      ${services_components_commontypes_LabelThemeCell_attribute_themeLabel_Description}

Class com.supermap.services.components.commontypes.LatLonGrid extends java.lang.Object implements Serializable

  • Serialized Fields

    • visible

      boolean visible
      

      Whether the graticule is visible. True means visible.

    • textVisible

      boolean textVisible
      

      Whether the texts on graticule object are visible. True means visible.

Class com.supermap.services.components.commontypes.Layer extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      The layer name.

      The name of a Layer is the unique identifier of a map. The property is case-sensitive.

      SuperMap layer name = "the corresponding dataset name@datasource name". For example, the layer corresponding dataset name is "Dataset1", and the mother datasource of this dataset is "Datasource", so the layer name will be "Dataset1@Datasource". The layer can not be accessed by dataset name or datasource name directly.

    • caption

      java.lang.String caption
      

      The caption of the map layer.

      The layer caption is the same with layer name by default. The layer names displayed in legend control or layer control are the layer captions.

      Users could modify the layer captions so that the layer name in the legend will be changed. For example, a layer (Layer) name is created by the dataset name and datasource name, then the users could modify the name as the layer content (such as "World") by changing the caption, then the layer name displayed in legend control will be "World" .

    • description

      java.lang.String description
      

      ${services_components_commontypes_Layer_attribute_description_Title}

      ${services_components_commontypes_Layer_attribute_description_Description}

    • visible

      boolean visible
      

      ${services_components_commontypes_Layer_attribute_visible_Title}

      ${services_components_commontypes_Layer_attribute_visible_Description}

    • queryable

      boolean queryable
      

      ${services_components_commontypes_Layer_attribute_queryable_Title}

      ${services_components_commontypes_Layer_attribute_queryable_Description}

    • subLayers

      LayerCollection subLayers
      

      ${services_components_commontypes_Layer_attribute_subLayers_Title}

      ${services_components_commontypes_Layer_attribute_subLayers_Description}

    • bounds

      Rectangle2D bounds
      

      ${services_components_commontypes_Layer_attribute_bounds_Title}

      ${services_components_commontypes_Layer_attribute_bounds_Description}

    • type

      LayerType type
      

      ${services_components_commontypes_Layer_attribute_type_Title}

      ${services_components_commontypes_Layer_attribute_type_Description}

Class com.supermap.services.components.commontypes.Layer3D extends Layer implements Serializable

  • Serialized Fields

    • layer3DType

      Layer3DType layer3DType
      

      The type of 3D layer.

    • dataName

      java.lang.String dataName
      

      The data name used in 3D layer.

      If the data is from the 3D cache data directly, it will be full path name of cache configuration file. If it is from dataset, the name will be DatasetName@DatasourceAlias. If it is from the map, the name will be the map name.

    • maxVisibleAltitude

      double maxVisibleAltitude
      

      The maximum visible altitude of 3D layer.

    • minVisibleAltitude

      double minVisibleAltitude
      

      The minimum visible altitude of 3D layer.

    • visibleDistance

      double visibleDistance
      

      The visible distance of objects in 3D layer.

    • alwaysRender

      boolean alwaysRender
      

      Whether the 3D layer is always rendered. True means always rendered.

    • editable

      boolean editable
      

      Whether the 3D layer is editable. True means editable.

    • level

      int level
      

      The cache layer number. The default value is "-1".

      Since the amount of 3D data is very large and it will cost many CPU, so in order to improve the whole performance, SuperMap provides the 3D data pre-processing function to make 3D layer cache based on different levels. This field is used to set the level number after setting the 3D layer cache.

    • oldCache

      boolean oldCache
      
      Whether the layer is the old cache data format.
    • dataConfigPath

      java.lang.String dataConfigPath
      

      The configuration file of cache data.

    • cachePassword

      java.lang.String cachePassword
      

      The password of the cache data.

    • useTwoDimenCache

      boolean useTwoDimenCache
      
    • isWebDatasource

      boolean isWebDatasource
      

      Whether it is the Web data source, such as OGC service, iServer REST and so on.

    • hasLocalCache

      boolean hasLocalCache
      

      Whether to save the network data to local.

Class com.supermap.services.components.commontypes.Layer3DDataset extends Layer3D implements Serializable

  • Serialized Fields

    • displayFilter

      QueryParameter displayFilter
      

      The filter of 3D thematic map.

      By setting the display filter, certain features of the layer can be displayed, and other features will not be displayed. Therefore, the featurs of interest will be highlighted, while other features will be filtered out. .
    • theme

      Theme3D theme
      

      The thematic map object of current 3D thematic map layer.

    • layer3DSetting

      Layer3DSetting layer3DSetting
      

      The layer setting.

    • dataset

      DatasetInfo dataset
      
      The dataset contained in the layer.
    • preCachePath

      java.lang.String preCachePath
      
      The relative path of pre-cache configuration file.

Class com.supermap.services.components.commontypes.Layer3DImageFile extends Layer3D implements Serializable

  • Serialized Fields

    • transparent

      boolean transparent
      
      Whether the layer is transparent.
    • transparentColorTolerance

      int transparentColorTolerance
      
      Transparent color tolerance. If this parameter is set and transparent is true, the transparent color and the colors within the transparent color tolerance would be displayed transparently.
    • transparentColor

      Color transparentColor
      
      .

Class com.supermap.services.components.commontypes.Layer3DMap extends Layer3D implements Serializable

  • Serialized Fields

    • cacheCapacity

      long cacheCapacity
      

      The cache capacity of 3D map layer.

    • cacheEnabled

      boolean cacheEnabled
      

      Whether the cache of 3D map layer is available. True means the cache is available.

    • cacheAutoCleared

      boolean cacheAutoCleared
      

      Whether to clean up the cache automatically.

    • map

      java.lang.String map
      
      The map contained in the layer.

Class com.supermap.services.components.commontypes.Layer3DSetting extends java.lang.Object implements Serializable

  • Serialized Fields

    • layer3DDatasetType

      Layer3DDatasetType layer3DDatasetType
      

      The types of the 3D dataset layers, including image layer, grid layer, vector layer, etc.

Class com.supermap.services.components.commontypes.Layer3DSettingGrid extends Layer3DSetting implements Serializable

  • Serialized Fields

    • transparentColor

      Color transparentColor
      

      The transparent color.

    • transparent

      boolean transparent
      

      Whether to display the transparent color and the colors within the transparent color tolerance transparently.

    • transparentColorTolerance

      int transparentColorTolerance
      

      The transparent color tolerance, which ranges from 0 to 255.

    • colorTable

      java.util.List<E> colorTable
      

      The Layer3DSettingGrid color.

    • specialValue

      double specialValue
      
      The specified grid value of layer.
    • specialValueColor

      Color specialValueColor
      
    • specialValueTransparent

      boolean specialValueTransparent
      
      Whether the area which has the SpecialValue is transparent in the grid layer.

Class com.supermap.services.components.commontypes.Layer3DSettingImage extends Layer3DSetting implements Serializable

  • Serialized Fields

    • transparentColor

      Color transparentColor
      

      The transparent color.

    • transparent

      boolean transparent
      

      Whether to display the transparent color and the colors within the transparent color tolerance transparently.

    • transparentColorTolerance

      int transparentColorTolerance
      

      The transparent color tolerance, which ranges from 0 to 255.

Class com.supermap.services.components.commontypes.Layer3DSettingVector extends Layer3DSetting implements Serializable

  • Serialized Fields

    • bottomAltitudeField

      java.lang.String bottomAltitudeField
      

      The bottom altitude field.

    • extendedHeightField

      java.lang.String extendedHeightField
      

      The extended height field.

    • topTextureField

      java.lang.String topTextureField
      

      The top texture field.

    • tilingUField

      java.lang.String tilingUField
      

      The tilingU field.

    • tilingVField

      java.lang.String tilingVField
      

      The tilingV field..

    • sideTextureField

      java.lang.String sideTextureField
      

      The side texture field.

    • style

      GeoStyle3D style
      

      The display style of 3D geometry object.

Class com.supermap.services.components.commontypes.Layer3DVectorFile extends Layer3D implements Serializable

  • Serialized Fields

    • style

      GeoStyle3D style
      
      Sets the display style of the 3D geometry object, including the altitude mode, bottom altitude, extension, texture path, etc. Please refer to GeoStyle3D for details.

Class com.supermap.services.components.commontypes.LayerCollection extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.LinkItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • datasourceConnectionInfo

      DatasourceConnectionInfo datasourceConnectionInfo
      

      ${services_components_commontypes_LinkItem_attribute_DatasourceConnectionInfo_Title}

      ${services_components_commontypes_LinkItem_attribute_DatasourceConnectionInfo_Description}

    • foreignKeys

      java.lang.String[] foreignKeys
      

      ${services_components_commontypes_LinkItem_attribute_foreignKeys_Title}

      ${services_components_commontypes_LinkItem_attribute_foreignKeys_Description}

    • foreignTable

      java.lang.String foreignTable
      

      About the name of linked external attribute table, currently only SuperMap managed table is supported, which is the DBMS table corresponded with the other vector dataset.

    • linkFields

      java.lang.String[] linkFields
      

      The reserving external attribute table field.

      It will not return to any attribute information of external attribute table if field is not set or the set field does not exist in the external table. A nonexistent field name should be set as the external table field alias if the reserving external table field name is the same with a primary table field name.

    • linkFilter

      java.lang.String linkFilter
      

      The join query condition with external attribute table.

    • name

      java.lang.String name
      

      ${services_components_commontypes_LinkItem_attribute_name_Title}

      ${services_components_commontypes_LinkItem_attribute_name_Description}

    • primaryKeys

      java.lang.String[] primaryKeys
      

      The primary key of external attribute table.

Class com.supermap.services.components.commontypes.LocalTileLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.LocationAnalystParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • returnNodeFeatures

      boolean returnNodeFeatures
      

      Whether to return attribute information of the result edge. Default is true.

    • expectedSupplyCenterCount

      int expectedSupplyCenterCount
      

      The expected number of supply centers for location-allocation analysis.

      When the value is 0, the resources supply centers amount of the final facilities locations is default to be the least needed supply centers number that covers the analysis area

    • supplyCenters

      SupplyCenterCollection supplyCenters
      

      The resource supply center collection.

      The resource supply center collection contains information of resources supply center.

    • turnWeightField

      java.lang.String turnWeightField
      

      The name of the turn weight field.

    • weightName

      java.lang.String weightName
      

      Denotes the field name of the weight field.

      The weight used by the location-allocation analysis contains forward and reverse weights. WeightFieldInfo specifies the name of forward and reverse weight fields. The environmental settings of the transportation network analysis (TransportationAnalystSetting) specifies weight field information collection (weightFieldInfos). weightName is the name of a object.

    • isFromCenter

      boolean isFromCenter
      

      Determines whether to allocate resources from supply center.

      True denotes allocating from SupplyCenter, while false denotes not.

      The edge in network data has both from-to impedance and to-from impedance, which may not be the same. Therefore, allocating resources from supply center to demand node and allocating resources from demand node to supply center may have different analysis result.

      The two examples below will help you better understand the difference. Given that the from-to impedance and the to-from impedance of the edge are different.

      1. Allocating resources from supply center to demand node: If you choose the locations for some stores which are regarded as the supply centers and the demand centers are the shops, in the real world the stores need to supply goods for the shops. Therefore, the IsFromCenter need to be set to true, namely analyzing from the supply centers. .
      2. Not to allocate resources from supply center to demand node: If you choose the locations for some post offices or banks which are regarded as the supply centers and the demand centers are the residential areas, in the real world the people in the residential areas need to go to the post offices or banks to deal with affairs. Therefore, the IsFromCenter need to be set to false, namely not analyzing from the supply centers.

Class com.supermap.services.components.commontypes.LocationAnalystResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • demandResults

      DemandResult[] demandResults
      

      The demand result object array.

    • supplyResults

      SupplyResult[] supplyResults
      

      The demand result object array.

Class com.supermap.services.components.commontypes.LODInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • level

      int level
      
      Level.
    • scale

      double scale
      
      the scale.
    • resolution

      double resolution
      
      The resolution.

Class com.supermap.services.components.commontypes.MapGeometry extends VectorGeometry implements Serializable

  • Serialized Fields

    • points

      double[] points
      

      The point set in geometric object.

      For 2D geometric objects (Point2D,Line,Region), each coordinate is represented by two array members, such as [-180,90,180,-90] indicates two points (-180,90) and (180,-90).

Class com.supermap.services.components.commontypes.MapGeometryText extends MapGeometry implements Serializable

  • Serialized Fields

    • texts

      java.lang.String[] texts
      
      The content of the text object.
    • textStyle

      TextStyle textStyle
      
      The text style of the text object.
    • rotations

      double[] rotations
      
      The rotation of the text.

Class com.supermap.services.components.commontypes.MapHighlightStyle extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.MapImage extends java.lang.Object implements Serializable

  • Serialized Fields

    • customResponse

      java.lang.String customResponse
      

      ${services_components_commontypes_MapImage_attribute_customResponse_Title}

      ${services_components_commontypes_MapImage_attribute_customResponse_Description}

    • imageUrl

      java.lang.String imageUrl
      

      The URL address of the map image.

      GIS server would create the images of the map accroding to the client request. The images are named and saved on a fixed location. The server would provide the URL of the images

    • imageData

      byte[] imageData
      

      Binary stream that the map picture corresponds to.

      Only when the image output format ImageOutputOption.format is OutputFormat.BINARY, this field would store the binary stream of the map image, otherwise it is null.

      See Also:
      ImageOutputOption, OutputFormat
    • image

      java.awt.image.BufferedImage image
      

      BufferedImage object corresponding with map image.

      BufferedImage is actually a java object, GIS server can operate BufferedImage object to achieve the operation for processing the map image, such as picture clipping and merging.

    • lastModified

      long lastModified
      

      The time of modifying map last time.

      Gets the time to finally generate the contents of current map at last through this field.

    • mapParam

      MapParameter mapParam
      

      Map parameter

      Gets the information description of current map through this field, such as: current map name, map range, scale, and son on.

Class com.supermap.services.components.commontypes.MapParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • minScale

      double minScale
      

      ${services_components_commontypes_MapParameter_attribute_minScale_Title}

      ${services_components_commontypes_MapParameter_attribute_minScale_Description}

    • scale

      double scale
      

      ${services_components_commontypes_MapParameter_attribute_scale_Title}

      ${services_components_commontypes_MapParameter_attribute_scale_Description}

    • maxScale

      double maxScale
      

      ${services_components_commontypes_MapParameter_attribute_maxScale_Title}

      ${services_components_commontypes_MapParameter_attribute_maxScale_Description}

    • name

      java.lang.String name
      

      ${services_components_commontypes_MapParameter_attribute_name_Title}

      ${services_components_commontypes_MapParameter_attribute_name_Description}

    • center

      Point2D center
      

      ${services_components_commontypes_MapParameter_attribute_center_Title}

      ${services_components_commontypes_MapParameter_attribute_center_Description}

    • viewBounds

      Rectangle2D viewBounds
      

      The map range corresponding with viewer (MapParameter.viewer, map image range)

      The unit is geographical coordinates.

    • returnType

      ReturnType returnType
      

      The returned type for image.

      Pictures can be returned in binary, file path, URL path, and so on. Valid when returnImage is true.

    • bounds

      Rectangle2D bounds
      

      The full range of the map.

      The unit is geographical coordinates.

    • viewer

      Rectangle viewer
      

      View Also be called the range of map image.

      When requesting a map image, it will ask how much picture (pixel coordinates, such as 512 * 512), that is, the range of the window.

    • returnImage

      boolean returnImage
      

      ${services_components_commontypes_MapParameter_attribute_returnImage_Title}

      ${services_components_commontypes_MapParameter_attribute_returnImage_Description}

    • layers

      java.util.List<E> layers
      

      ${services_components_commontypes_MapParameter_attribute_layers_Title}

      ${services_components_commontypes_MapParameter_attribute_layers_Description}

    • trackingLayer

      TrackingLayer trackingLayer
      

      The tracking layers.

      The tracking layer is a transparent layer at the top of layers of the map, it is used to temporarily store some graphic objects, texts etc., and now it mainly used for storing the highlight information, that's the reason why it can also be called as highlight layer.

    • prjCoordSys

      PrjCoordSys prjCoordSys
      

      ${services_components_commontypes_MapParameter_attribute_prjCoordSys_Title}

      ${services_components_commontypes_MapParameter_attribute_prjCoordSys_Description}

    • customPrjCoordSysType

      PrjCoordSysType customPrjCoordSysType
      
      Stores the projection type of coordinate set by users.
    • cacheEnabled

      boolean cacheEnabled
      

      ${services_components_commontypes_MapParameter_attribute_isCacheEnabled_Title}

      ${services_components_commontypes_MapParameter_attribute_isCacheEnabled_Description}

    • customParams

      java.lang.String customParams
      

      ${services_components_commontypes_MapParameter_attribute_customParams_Title}

      ${services_components_commontypes_MapParameter_attribute_customParams_Description}

    • userToken

      UserInfo userToken
      

      ${services_components_commontypes_MapParameter_attribute_userToken_Title}

      ${services_components_commontypes_MapParameter_attribute_userToken_Description}

    • rectifyType

      RectifyType rectifyType
      

      ${services_components_commontypes_MapParameter_attribute_rectifyType_Title}

      ${services_components_commontypes_MapParameter_attribute_rectifyType_Description}

    • clipRegion

      Geometry clipRegion
      

      ${services_components_commontypes_MapParameter_attribute_clipRegion_Title}

      ${services_components_commontypes_MapParameter_attribute_clipRegion_Description}

    • clipRegionEnabled

      boolean clipRegionEnabled
      

      ${services_components_commontypes_MapParameter_attribute_clipRegionEnabled_Title}

      ${services_components_commontypes_MapParameter_attribute_clipRegionEnabled_Description}

    • customEntireBounds

      Rectangle2D customEntireBounds
      

      Customs the display range of full-size map.

      When the property value of MapParameter.customEntireBoundsEnabled is true, viewEntire() from component Map will be used the range marked by this field to full extent map.

    • customEntireBoundsEnabled

      boolean customEntireBoundsEnabled
      

      Whether it is valid that customing the display range of full-size map.

      When the property value is true, viewEntire() from component Map will be used the range marked by this field MapParameter.customEntireBounds to full extent map.

    • angle

      double angle
      

      ${services_components_commontypes_MapParameter_attribute_angle_Title}

      ${services_components_commontypes_MapParameter_attribute_angle_Description}

    • antialias

      boolean antialias
      

      ${services_components_commontypes_MapParameter_attribute_antialias_Title}

      ${services_components_commontypes_MapParameter_attribute_antialias_Description}

    • backgroundStyle

      Style backgroundStyle
      

      ${services_components_commontypes_MapParameter_attribute_backgroundStyle_Title}

      ${services_components_commontypes_MapParameter_attribute_backgroundStyle_Description}

    • colorMode

      MapColorMode colorMode
      

      ${services_components_commontypes_MapParameter_attribute_colorMode_Title}

      ${services_components_commontypes_MapParameter_attribute_colorMode_Description}

    • coordUnit

      Unit coordUnit
      

      ${services_components_commontypes_MapParameter_attribute_coordUnit_Title}

      ${services_components_commontypes_MapParameter_attribute_coordUnit_Description}

    • distanceUnit

      Unit distanceUnit
      

      ${services_components_commontypes_MapParameter_attribute_distanceUnit_Title}

      ${services_components_commontypes_MapParameter_attribute_distanceUnit_Description}

    • description

      java.lang.String description
      

      ${services_components_commontypes_MapParameter_attribute_description_Title}

      ${services_components_commontypes_MapParameter_attribute_description_Description}

    • dynamicProjection

      boolean dynamicProjection
      

      ${services_components_commontypes_MapParameter_attribute_dynamicProjection_Title}

      ${services_components_commontypes_MapParameter_attribute_dynamicProjection_Description}

    • markerAngleFixed

      boolean markerAngleFixed
      

      ${services_components_commontypes_MapParameter_attribute_markerAngleFixed_Title}

      ${services_components_commontypes_MapParameter_attribute_markerAngleFixed_Description}

    • maxVisibleTextSize

      double maxVisibleTextSize
      

      The maximum visible size of text, unit: mm.

      The default value is 1000, That is, geometric object will not be displayed if its size is more than 1000 mm.

    • maxVisibleVertex

      int maxVisibleVertex
      

      The maximum number of visible nodes of geometric object, geometric object will not be displayed if its nodes number is more than the specified number.

    • minVisibleTextSize

      double minVisibleTextSize
      

      The minimum visible size of text, unit: mm.

      The default value is 0.1.

    • overlapDisplayed

      boolean overlapDisplayed
      

      In the same range, whether the map objects overlay to display, the default is False.

      If it is true, the same range of objects will be overlaid; Otherwise, controlling that the objects do not overlay through MapParameter.overlapDisplayedOptions.

    • overlapDisplayedOptions

      OverlapDisplayedOptions overlapDisplayedOptions
      

      The map's gland filtering display option is valid when MapParameter.overlapDisplayed is false.

      Used to enhance the handling of the map overlay display.

    • paintBackground

      boolean paintBackground
      

      ${services_components_commontypes_MapParameter_attribute_paintBackground_Title}

      ${services_components_commontypes_MapParameter_attribute_paintBackground_Description}

    • textAngleFixed

      boolean textAngleFixed
      

      ${services_components_commontypes_MapParameter_attribute_textAngleFixed_Title}

      ${services_components_commontypes_MapParameter_attribute_textAngleFixed_Description}

    • textOrientationFixed

      boolean textOrientationFixed
      

      ${services_components_commontypes_MapParameter_attribute_textOrientationFixed_Title}

      ${services_components_commontypes_MapParameter_attribute_textOrientationFixed_Description}

    • visibleScales

      double[] visibleScales
      

      Returns the visible scale array of the map.

    • visibleScalesEnabled

      boolean visibleScalesEnabled
      
      Returns whether or not to use a fixed scale to display the map.
    • autoAvoidEffectEnabled

      boolean autoAvoidEffectEnabled
      

      Whether to enable automatic avoidance effect.

    • tileversion

      java.lang.String tileversion
      

Class com.supermap.services.components.commontypes.Material extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      
      Material name.
    • ambient

      java.awt.Color ambient
      
      Ambient light parameters.
    • diffuse

      java.awt.Color diffuse
      

      Diffuse reflectance parameter.

    • emission

      java.awt.Color emission
      
      Luminous parameters.
    • specular

      java.awt.Color specular
      
      Mirror reflectance parameter.
    • shininess

      double shininess
      
      Light intensity.
    • textureFile

      java.lang.String textureFile
      
      The full path of the material texture file.

Class com.supermap.services.components.commontypes.MeasureParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • prjCoordSys

      PrjCoordSys prjCoordSys
      

      The map coordinate system for measurement. If the parameter is null, the original map coordinate reference system is used to calculate.

    • unit

      Unit unit
      

      ${services_components_commontypes_MeasureParameter_attribute_unit_Title}

      ${services_components_commontypes_MeasureParameter_attribute_unit_Description}

    • distanceMode

      DistanceMode distanceMode
      
      Distance measure mode

Class com.supermap.services.components.commontypes.MeasureResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • distance

      double distance
      

      ${services_components_commontypes_MeasureResult_attribute_distance_Title}

      ${services_components_commontypes_MeasureResult_attribute_distance_Description}

    • area

      double area
      

      ${services_components_commontypes_MeasureResult_attribute_area_Title}

      ${services_components_commontypes_MeasureResult_attribute_area_Description}

    • unit

      Unit unit
      

      ${services_components_commontypes_MeasureResult_attribute_unit_Title}

      ${services_components_commontypes_MeasureResult_attribute_unit_Description}

Class com.supermap.services.components.commontypes.Mesh extends java.lang.Object implements Serializable

  • Serialized Fields

    • indexes

      int[] indexes
      
      Vertex index array of mesh region.
    • material

      Material material
      
      Material of mesh region.
    • nomals

      double[] nomals
      
      The vector set of mesh region vertex.
    • textureCoords

      double[] textureCoords
      
      Texture coordinate array of mesh region.
    • vectices

      double[] vectices
      
      Vertex array of mesh.
    • colors

      Color[] colors
      
      Color set of mesh region.

Class com.supermap.services.components.commontypes.MTSPPath extends TSPPath implements Serializable

  • Serialized Fields

    • nodesVisited

      java.lang.Object[] nodesVisited
      

      Via network nodes of this path.

    • center

      java.lang.Object center
      

      The dilivery center of this path.

Class com.supermap.services.components.commontypes.MTSPPaths extends java.util.ArrayList<MTSPPath<T>> implements Serializable

Class com.supermap.services.components.commontypes.MVTStyle extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.Named extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      
      Name

Class com.supermap.services.components.commontypes.NetworkAnalyst3DPublishCapability extends java.lang.Object implements Serializable

  • Serialized Fields

    • hasNetworkDataset3D

      boolean hasNetworkDataset3D
      

      Whether to contain the 3D network dataset.

      Since:
      7.1.0

Class com.supermap.services.components.commontypes.OfflineDataInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • path

      java.lang.String path
      

      The relative path of 3D off-line data

    • url

      java.lang.String url
      

      Downloads the url corresponding with 3D offline data

    • size

      long size
      

      The size of 3D offline data

Class com.supermap.services.components.commontypes.OpenStreetMapLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.Output3DDataToMemoryParam extends java.lang.Object implements Serializable

  • Serialized Fields

    • bounds

      Rectangle2D bounds
      

      The geographic range of tile data files.

    • scale

      double scale
      
      The scale of the tile.
      Since:
      7.1
    • size

      int size
      
      Tile size.
    • format

      OutputFormat format
      
      It need be set when generating the 3D image.

Class com.supermap.services.components.commontypes.OverlapDisplayedOptions extends java.lang.Object implements Serializable

  • Serialized Fields

    • allowPointOverlap

      boolean allowPointOverlap
      

      Whether to display the overlapped point object when a point overlaps a point. Default is true.

    • allowPointWithTextDisplay

      boolean allowPointWithTextDisplay
      

      Whether the points on the label and corresponding normal layer to filtering show together, if filtering showing, Only drawing points in the point style of the smallest index layer of the corresponding dataset in the set of layers. Default is true.

    • allowTextOverlap

      boolean allowTextOverlap
      

      Whether to display overlapped texts, when the texts overlap in the map. Default is true. If it is True, representing to allow the overlapped texts to display in overlapping; If it is False, only displaying first layer, not displaying latter layer.

    • allowTextAndPointOverlap

      boolean allowTextAndPointOverlap
      

      Whether to display the overlapped texts or point objects when texts overlap points(This attribute does not deal with the overlaps in texts and the overlaps in points). Default is true.

    • allowThemeGraduatedSymbolOverlap

      boolean allowThemeGraduatedSymbolOverlap
      

      Whether to display the overlapped rank symbol elements when rank symbol elements overlap. Default is false.

    • allowThemeGraphOverlap

      boolean allowThemeGraphOverlap
      

      Whether to display the overlapped statistics thematic map elements when statistics thematic map elements overlap. Default is false.

    • horizontalOverlappedSpaceSize

      double horizontalOverlappedSpaceSize
      

      The horizontal overlap gap between the two objects, unit is 0.1mm, using with OverlapDisplayedOptions.verticalOverlappedSpaceSize, When the horizontal gap between the two objects is smaller than the value, and longitudinal gap is smaller than OverlapDisplayedOptions.verticalOverlappedSpaceSize, it is considered to be overlapped.

      Positive number represents the horizontal gap between the two objects, negative number represents the horizontal overlap gap between the two objects. The default is 0.

    • verticalOverlappedSpaceSize

      double verticalOverlappedSpaceSize
      

      The horizontal overlap gap between the two objects, unit is 0.1mm, using with OverlapDisplayedOptions.verticalOverlappedSpaceSize, When the horizontal gap between the two objects is smaller than the value, and longitudinal gap is smaller than OverlapDisplayedOptions.verticalOverlappedSpaceSize, it is considered to be overlapped.

      Positive number represents the horizontal gap between the two objects, negative number represents the horizontal overlap gap between the two objects. The default is 0

Class com.supermap.services.components.commontypes.OverlayResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • succeed

      boolean succeed
      

      Returns true if analysis successfully; otherwise false.

    • msg

      java.lang.String msg
      

      The related info during analysis

    • resultDatasetInfo

      DatasetInfo resultDatasetInfo
      
      Analysis results dataset info

Class com.supermap.services.components.commontypes.Overview extends java.lang.Object implements Serializable

  • Serialized Fields

    • mapName

      java.lang.String mapName
      

      ${services_components_commontypes_Overview_attribute_mapName_Title}

      ${services_components_commontypes_Overview_attribute_mapName_Description}

    • lastModified

      long lastModified
      

      The time of modifying image last time.

      Gets the time to finally modify the contents of current image at last through this field.

    • imageUrl

      java.lang.String imageUrl
      

      ${services_components_commontypes_Overview_attribute_imageUrl_Title}

      ${services_components_commontypes_Overview_attribute_imageUrl_Description}

    • viewer

      Rectangle viewer
      

      ${services_components_commontypes_Overview_attribute_viewer_Title}

      ${services_components_commontypes_Overview_attribute_viewer_Description}

    • viewBounds

      Rectangle2D viewBounds
      

      ${services_components_commontypes_Overview_attribute_viewBounds_Title}

      ${services_components_commontypes_Overview_attribute_viewBounds_Description}

Class com.supermap.services.components.commontypes.Page extends java.lang.Object implements Serializable

  • Serialized Fields

    • pageSize

      int pageSize
      
      The page size.
    • currentPage

      int currentPage
      
      The current page number.
    • totalPage

      int totalPage
      
      The total number of pages.
    • total

      int total
      
      The total record number.
    • content

      java.util.List<E> content
      
      Page content.
    • searchParameter

      SearchParameter searchParameter
      
      The search parameter for the current page.

Class com.supermap.services.components.commontypes.Path extends java.lang.Object implements Serializable

  • Serialized Fields

    • edgeIDs

      int[] edgeIDs
      

      Analyzes the collection of the passing through arc ID of the result.

    • nodeIDs

      int[] nodeIDs
      

      Analyzes the collection of the passing through node ID of the result.

    • route

      Route route
      

      Analyzes the route objects corresponding to the result.

    • nodeFeatures

      Feature[] nodeFeatures
      

      Analyzes the collection of passing node elements of the result. Each element in the array may refer to instance of the same Feature, also may be null

    • edgeFeatures

      Feature[] edgeFeatures
      

      Analyzes the collection of passing arc elements of the result.

    • pathGuideItems

      PathGuideItem[] pathGuideItems
      

      Analyzes the collection of the driving guide items corresponding to result.

    • weight

      double weight
      

      The cost of current path.

    • stopWeights

      double[] stopWeights
      

      Returns the array of total cost of each path. The multitraveler analysis as shown below, the analysis result of total cost of 1,3,4,5,6 center point is 5,10,11,13,8, respectively Then returns [5,10,11,13,8].

Class com.supermap.services.components.commontypes.PathGuideItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • description

      java.lang.String description
      

      The description for PathGuide.

    • geometry

      Geometry geometry
      

      The object on ground corresponding with the path guide item.

    • bounds

      Rectangle2D bounds
      

      The range of PathGuide. For arcs, it is the external rectangle of the arc. For point, it is the point self.

    • directionType

      DirectionType directionType
      

      The direction of path.

      There are 5 values returned: East, South, West, North and none direction. When the value returned by isEdge method is True, the directionType can be East, South, West, North; When the value returned by isEdge method is False, the directionType is none direction.

    • distance

      double distance
      

      The distance from the site to the arc.

      The distance is the distance from the site to the nearest arc. As follows, orange points represent the network nodes, blue represents arcs, the gray points indicate the sites, the red lines mean the distance. For example, if the users want to calculate the shortest path from home to hospital riding bus, except the shortest path needs to be calculated, the shortest path from home to the bus station also should be calculated and this path is the distance identified by PathGuideItem.distance.

    • id

      int id
      

      The ID of PathGuideItem object If the item is an arc, this value is the ID of the corresponding arc; If the item is a network node, this value is the ID of the corresponding node; If the item is the site which does not on the network, this value is -1. The analyzed shortest path from site 1 to site 2 is shown as follows, the position of site 1 is as a path guide sub item, the ID value is -1, the next path guide sub item is the arc 1, its ID is the arc's ID; and the next item is the network node A, its ID is the ID of node A.

    • index

      int index
      

      The No. of PathGuideItem object.

  • The index value of item is -1 when the item is a arc.
  • When the items are points which are preset and need to be passed, index value is the number of the specified point. For example, performing the shortest path analysis for P1, P2, P3, the result path passes P1, then P2, finally arrives at P3, the index value of the item corresponding to P3 is 3.

length

double length

The length of arc (when the item is a arc).

name

java.lang.String name

The name of PathGuideItem object

sideType

SideType sideType

Driving position is on the left side of the road, on the right side or on the road.

When PathGuideItem.isEdge is true, returning SideType.NONE.

turnAngle

double turnAngle

Angle of turning. The unit is degree, accurate to 0.1 degrees.

turnType

TurnType turnType

Direction of turning.

When PathGuideItem.isEdge is true, returning TurnType.NONE.

weight

double weight

The weight value of item, that is the cost of item.

isEdge

boolean isEdge

Determines whether the item is an arc.

True means the item is an arc, false means the item isn't an arc.

isStop

boolean isStop

Determines whether the item is an site, that is the point inputed by users for path analysis, Sites may overlap with network nodes, or they may not be on the network.

As the above figure, the site 1,2 are not on the network. True means it is a point, false means it isn't a point.

Class com.supermap.services.components.commontypes.Paths extends java.util.ArrayList<Path> implements Serializable

Class com.supermap.services.components.commontypes.PDFOption extends java.lang.Object implements Serializable

  • Serialized Fields

    • entire

      boolean entire
      

      ${services_components_commontypes_PDFOption_attribute_entire_Title}

      ${services_components_commontypes_PDFOption_attribute_entire_Description}

    • lineStyleRetained

      boolean lineStyleRetained
      

      ${services_components_commontypes_PDFOption_attribute_lineStyleRetained_Title}

      ${services_components_commontypes_PDFOption_attribute_lineStyleRetained_Description}

    • pointStyleRetained

      boolean pointStyleRetained
      

      ${services_components_commontypes_PDFOption_attribute_pointStyleRetained_Title}

      ${services_components_commontypes_PDFOption_attribute_pointStyleRetained_Description}

    • regionStyleRetained

      boolean regionStyleRetained
      

      ${services_components_commontypes_PDFOption_attribute_regionStyleRetained_Title}

      ${services_components_commontypes_PDFOption_attribute_regionStyleRetained_Description}

    • vector

      boolean vector
      

      ${services_components_commontypes_PDFOption_attribute_vector_Title}

      ${services_components_commontypes_PDFOption_attribute_vector_Description}

Class com.supermap.services.components.commontypes.PixelGeometry extends VectorGeometry implements Serializable

  • Serialized Fields

    • points

      int[] points
      

      The point set in geometric object.

      Each coordinate is represented by two array members, such as [0,0,1,1] indicates two points (0,0) and (1,1).

Class com.supermap.services.components.commontypes.PixelGeometryText extends PixelGeometry implements Serializable

  • Serialized Fields

    • texts

      java.lang.String[] texts
      
      The content of the text object.
    • rotations

      double[] rotations
      
      The rotation of the text.
    • textStyle

      TextStyle textStyle
      
      The text style of the text object.

Class com.supermap.services.components.commontypes.Point extends java.lang.Object implements Serializable

  • Serialized Fields

    • x

      int x
      

      ${services_components_commontypes_Point_attribute_x_Title}

      ${services_components_commontypes_Point_attribute_x_Description}

    • y

      int y
      

      ${services_components_commontypes_Point_attribute_y_Title}

      ${services_components_commontypes_Point_attribute_y_Description}

Class com.supermap.services.components.commontypes.Point2D extends java.lang.Object implements Serializable

  • Serialized Fields

    • x

      double x
      

      The X coordinate of the Point2D.

    • y

      double y
      

      The Y coordinate of the Point2D.

Class com.supermap.services.components.commontypes.Point3D extends Point2D implements Serializable

  • Serialized Fields

    • z

      double z
      

      The Z coordinate of the Point3D.

Class com.supermap.services.components.commontypes.PointDatasetInfoForExtract extends SimpleDatasetInfo implements Serializable

  • Serialized Fields

    • filterQueryParameter

      QueryParameter filterQueryParameter
      
      An attribute filter that filters the point object of point data set. Only points that meet the filter criteria are involved in the analysis.
    • zValueField

      java.lang.String zValueField
      
      The name of the field used to extract the operation. When an contour is extracted, the point datset is interpolated using the values in the field to obtain the raster dataset (intermediate result), and then the contours are extracted from the raster dataset.
    • resolution

      double resolution
      
      The resolution of the intermediate result (raster dataset).

Class com.supermap.services.components.commontypes.PointEPS extends Point2D implements Serializable

  • Serialized Fields

    • z

      double z
      

      Z value

    • type

      PointEPSType type
      

      Point type

    • name

      java.lang.String name
      

      Point name

Class com.supermap.services.components.commontypes.PointWithMeasure extends Point2D implements Serializable

  • Serialized Fields

    • measure

      double measure
      

      Measure, is the distance from the routing point to the starting point.

Class com.supermap.services.components.commontypes.PrimeMeridian extends java.lang.Object implements Serializable

  • Serialized Fields

    • longitudeValue

      double longitudeValue
      

      ${services_components_commontypes_PrimeMeridian_attribute_longitudeValue_Title}

      ${services_components_commontypes_PrimeMeridian_attribute_longitudeValue_Description}

    • name

      java.lang.String name
      

      ${services_components_commontypes_PrimeMeridian_attribute_name_Title}

      ${services_components_commontypes_PrimeMeridian_attribute_name_Description}

    • type

      PrimeMeridianType type
      

      ${services_components_commontypes_PrimeMeridian_attribute_type_Title}

      ${services_components_commontypes_PrimeMeridian_attribute_type_Description}

Class com.supermap.services.components.commontypes.PrjCoordSys extends java.lang.Object implements Serializable

  • Serialized Fields

    • epsgCode

      int epsgCode
      

      The EPSG codes corresponding to the projected coordinate system.

      EPSG name space borrows code from the table of the European petroleum mapping group, the codes are defined as CRS code If this projection frame does not have corresponding EPSG Code, The value of this field is -1000.

    • distanceUnit

      Unit distanceUnit
      

      ${services_components_commontypes_PrjCoordSys_attribute_distanceUnit_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_distanceUnit_Description}

    • type

      PrjCoordSysType type
      

      ${services_components_commontypes_PrjCoordSys_attribute_type_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_type_Description}

    • projection

      Projection projection
      

      ${services_components_commontypes_PrjCoordSys_attribute_projectionType_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_projectionType_Description}

    • coordUnit

      Unit coordUnit
      

      ${services_components_commontypes_PrjCoordSys_attribute_coordUnit_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_coordUnit_Description}

    • name

      java.lang.String name
      

      ${services_components_commontypes_PrjCoordSys_attribute_name_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_name_Description}

    • coordSystem

      CoordSys coordSystem
      

      ${services_components_commontypes_PrjCoordSys_attribute_coordSystem_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_coordSystem_Description}

    • projectionParam

      PrjParameter projectionParam
      

      ${services_components_commontypes_PrjCoordSys_attribute_projectionParam_Title}

      ${services_components_commontypes_PrjCoordSys_attribute_projectionParam_Description}

Class com.supermap.services.components.commontypes.PrjParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • falseEasting

      double falseEasting
      

      ${services_components_commontypes_PrjParameter_attribute_falseEasting_Title}

      ${services_components_commontypes_PrjParameter_attribute_falseEasting_Description}

    • falseNorthing

      double falseNorthing
      

      ${services_components_commontypes_PrjParameter_attribute_falseNorthing_Title}

      ${services_components_commontypes_PrjParameter_attribute_falseNorthing_Description}

    • centralMeridian

      double centralMeridian
      

      ${services_components_commontypes_PrjParameter_attribute_centralMeridian_Title}

      ${services_components_commontypes_PrjParameter_attribute_centralMeridian_Description}

    • centralParallel

      double centralParallel
      

      ${services_components_commontypes_PrjParameter_attribute_centralParallel_Title}

      ${services_components_commontypes_PrjParameter_attribute_centralParallel_Description}

    • firstStandardParallel

      double firstStandardParallel
      

      ${services_components_commontypes_PrjParameter_attribute_firstStandardParallel_Title}

      ${services_components_commontypes_PrjParameter_attribute_firstStandardParallel_Description}

    • secondStandardParallel

      double secondStandardParallel
      

      ${services_components_commontypes_PrjParameter_attribute_secondStandardParallel_Title}

      ${services_components_commontypes_PrjParameter_attribute_secondStandardParallel_Description}

    • scaleFactor

      double scaleFactor
      

      ${services_components_commontypes_PrjParameter_attribute_scaleFactor_Title}

      ${services_components_commontypes_PrjParameter_attribute_scaleFactor_Description}

    • azimuth

      double azimuth
      

      ${services_components_commontypes_PrjParameter_attribute_azimuth_Title}

      ${services_components_commontypes_PrjParameter_attribute_azimuth_Description}

    • firstPointLongitude

      double firstPointLongitude
      

      ${services_components_commontypes_PrjParameter_attribute_firstPointLongitude_Title}

      ${services_components_commontypes_PrjParameter_attribute_firstPointLongitude_Description}

    • secondPointLongitude

      double secondPointLongitude
      

      ${services_components_commontypes_PrjParameter_attribute_secondPointLongitude_Title}

      ${services_components_commontypes_PrjParameter_attribute_secondPointLongitude_Description}

    • rectifiedAngle

      double rectifiedAngle
      
      Modifies the correct angle of the oblique projection (ProjectionType.RectifiedSkewedOrthomorphic)parameter, unit is in radian

Class com.supermap.services.components.commontypes.ProfileResult extends SpatialAnalystResult implements Serializable

  • Serialized Fields

    • profile

      Geometry[] profile
      

      Profile line

    • xyCoordinate

      Geometry[] xyCoordinate
      

      Coordinate of point on the profile map.

Class com.supermap.services.components.commontypes.Projection extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      ${services_components_commontypes_Projection_attribute_name_Title}

      ${services_components_commontypes_Projection_attribute_name_Description}

    • type

      ProjectionType type
      

      ${services_components_commontypes_Projection_attribute_type_Title}

      ${services_components_commontypes_Projection_attribute_type_Description}

Class com.supermap.services.components.commontypes.ProviderConnInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      Service provider names.

    • config

      java.lang.Object config
      

      the configuration information of the service provider.

    • type

      java.lang.String type
      

      Service provider type.

    • dataItems

      ExportedDataPathItem[] dataItems
      

      Data path.

    • innerProviders

      java.util.List<E> innerProviders
      

      Internal provider information list.

Class com.supermap.services.components.commontypes.ProximityAnalystParameterForDatasetInput extends AbstractProximityAnalystParameter implements Serializable

  • Serialized Fields

    • inputDatasourceName

      java.lang.String inputDatasourceName
      
      The name of the data source which the point data set to be analyzed belongs to.
    • inputDatasetName

      java.lang.String inputDatasetName
      
      The name of the dataset to be analyzed.
    • filterQueryParameter

      QueryParameter filterQueryParameter
      
      Treats the points in the analysis data set to filter, and it is the optional parameters. The default is null when not set , that is, all points in the dataset for analysis. When not null, only point objects that meet the filter criteria are analyzed.

Class com.supermap.services.components.commontypes.ProximityAnalystParameterForPointsInput extends AbstractProximityAnalystParameter implements Serializable

  • Serialized Fields

    • points

      Point2D[] points
      
      The point array to be proximately analyzed

Class com.supermap.services.components.commontypes.ProximityAnalystResult extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.PureColorInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • rgb

      int rgb
      
    • width

      int width
      
    • height

      int height
      
    • format

      java.lang.String format
      
    • hasAlpha

      boolean hasAlpha
      

Class com.supermap.services.components.commontypes.QueryParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      Data set name, or layer name, depending on the actual functions.

      In general the field is the data set name, but when operating the function related to the map, needs to set name for layer (layer name format: data set name @ data alias). Because a map layer may be from data sets of different data sources, and different data sources may exist the same data sets, using the data set name the data sets cannot be uniquely determined, so when operating the function related to the map, needs to set the value as the layer name.

      Querying CAD data sets and CAD layers is not currently supported

    • joinItems

      JoinItem[] joinItems
      

      Join query item array

      Valid when querying SQL.

    • linkItems

      LinkItem[] linkItems
      

      Join info of foreign table.

      Valid when querying SQL.

    • ids

      int[] ids
      

      ${services_components_commontypes_QueryParameter_attribute_ids_Title}

      ${services_components_commontypes_QueryParameter_attribute_ids_Description}

    • attributeFilter

      java.lang.String attributeFilter
      

      The attributes filter condition.

      The format of WHERE clause of SQL sentence is WHERE < Condition expression >,attributeFilter that is "condition expression".

      The use of this field is attributeFilter = "filter condition".

      For example, to query a record which is less than 100 of fieldValue fields, sets attributeFilter = "fieldValue < 100"; To query a record of fields whose value is "hotel", sets attributeFilter = "name like "%hotel%",and so on.

    • orderBy

      java.lang.String orderBy
      

      The field of results sorting in SQL query and spatial query . The fields used for sorting must be numeric.

      The format of ORDER BY clause of SQL sentence is ORDER BY < Or ORDER BY < Column name sorting rules >. The column name is the name of each column in the attribute table, column can also be called attribute, named as field in SuperMap, sets orderBy as field name. Sorting rules are to sort in ascending or descending order of field, asc represents ascending order, desc represents descending order, if does not specify the sorting rules, sorts by ascending order.

      When sorting single field, the use of this field is orderBy ="field name", ascending order is orderBy = "field name asc"; descending order is orderBy = "field name dec"; When sorting multiple fields, the fields are separated by commas, the use is orderBy = "field name 1, field name 2 asc, field name 2 desc".

      For example, in a national data set, there are two fields and the field names are respectively “SmArea” and “pop_1994”, the area of the country and the population of each country in 1994 are expressed respectively. If the records are sorted according to the population of each country, sets orderBy = "pop_1994"; If you want to sort in area descending and population ascending order, set orderBy = "SmArea desc, pop_1994 asc".

      Valid when querying SQL and space.

    • groupBy

      java.lang.String groupBy
      

      The fields of results grouping conditions in SQL query.

      The format of GROUP BY clause of SQL sentence is GROUP BY < Column name >,the column name is the name of each column in the attribute table, column can also be called attribute, named as field in SuperMap, sets groupBy as field name.

      When grouping single field, the use of this field is groupBy ="field name", When grouping multiple fields, the fields are separated by commas, the use is groupBy = "field name 1, field name 2".

      For example, there is a global cities data set that has two fields, the field names are respectively “Continent” and “Country”, State and country that a city belongs to can be expressed respectively, ;if global cities are grouped according to the countries, sets groupBy = "Country"; if cities are grouped according to the states and countries, sets groupBy = "Continent, Country".

      Valid when querying SQL. Note: Spatial query does not support groupBy field, otherwise, the result of the spatial query may not be correct.

    • fields

      java.lang.String[] fields
      

      ${services_components_commontypes_QueryParameter_attribute_returnFields_Title}

      ${services_components_commontypes_QueryParameter_attribute_returnFields_Description}

Class com.supermap.services.components.commontypes.QueryParameterSet extends java.lang.Object implements Serializable

  • Serialized Fields

    • queryParams

      QueryParameter[] queryParams
      

      ${services_components_commontypes_QueryParameterSet_attribute_queryParams_Title}

      ${services_components_commontypes_QueryParameterSet_attribute_queryParams_Description}

    • startRecord

      int startRecord
      

      ${services_components_commontypes_QueryParameterSet_attribute_startRecord_Title}

      ${services_components_commontypes_QueryParameterSet_attribute_startRecord_Description}

    • expectCount

      int expectCount
      

      The returned number of result records in the query results, it is greater than 0.

      When the query condition is querying distance, and the number of query results is greater than the expectedly returned result record number(expectCount), the distance query results are expectCount geometries randomly selected from the total query records.

      When the query condition is querying the nearest geometry, and the number of query results is greater than the expectedly returned result record number(expectCount), the nearest geometry query results are expectCount geometries closest to the center from the total query records. the expectCount geometries are unordered.

      ${services_components_commontypes_QueryParameterSet_attribute_expectCount_Description}

    • networkType

      GeometryType networkType
      

      Query type corresponding to network data set, divided into two types: point and line, and the default is line geometry object type, which is GeometryType.LINE.

    • customParams

      java.lang.String customParams
      

      Custom parameters for extended use. If user inputs geometry=null, geometry=null is the returned query results.

    • queryOption

      QueryOption queryOption
      

      The query result option object, used to specify the content contained in the query result. By default, it returns properties and geometric entities, i.e., QueryOption.ATTRIBUTEANDGEOMETRY.

      ${services_components_commontypes_QueryParameterSet_attribute_queryOption_Description}

    • resampleExpectCount

      int resampleExpectCount
      

      The number of 2D coordinates pair returned after querying the expected resample of each factor, the default value is -1, indicating that it is not set. Actually resampling, if user can get less result than the value, the number of 2D coordinates pair is equal to the result; If user can not get less result than the value, the minimum value after resampling is still greater than that value,the number of 2D coordinates pair is equal to the minimum value after resampling;

      ${services_components_commontypes_QueryParameterSet_attribute_expectCount_Description}

    • ignoreTotalCount

      boolean ignoreTotalCount
      

      Whether the query results returns accurate totalCount When querying multi-layer, if the number of query results of some layers meets the requirements of QueryParameterSet.expectCount, to calculate the value of QueryResult.totalCount, it will continue to query the remaining layers, if the field is set as false, it will not continue to query. Default is false.

    • prjCoordSys

      PrjCoordSys prjCoordSys
      

Class com.supermap.services.components.commontypes.QueryResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • totalCount

      int totalCount
      

      ${services_components_commontypes_MeasureResult_attribute_unit_Title}

      ${services_components_commontypes_QueryParameterSet_attribute_expectCount_Description}

    • recordsets

      Recordset[] recordsets
      

      Query record set.

      SuperMap iServer places the query results in different record sets by layer classification respectively. Geometric information of a record set is in the same layer.

    • customResponse

      java.lang.String customResponse
      

      ${services_components_commontypes_QueryResult_attribute_customResponse_Title}

      ${services_components_commontypes_QueryResult_attribute_customResponse_Description}

    • currentCount

      int currentCount
      

      ${services_components_commontypes_QueryResult_attribute_currentCount_Title}

      ${services_components_commontypes_QueryResult_attribute_currentCount_Description}

Class com.supermap.services.components.commontypes.RangeDomainInfo extends DomainInfo implements Serializable

  • Serialized Fields

    • rangeCount

      int rangeCount
      
      The number of range domain
    • rangeInfos

      RangeInfo[] rangeInfos
      
      Detailed info of range domain

Class com.supermap.services.components.commontypes.RangeInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • min

      java.lang.String min
      
      MinValue
    • max

      java.lang.String max
      
      MaxValue
    • type

      RangeType type
      
      Range type
    • valueType

      FieldType valueType
      
      Value type

Class com.supermap.services.components.commontypes.RealspaceDataInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • dataName

      java.lang.String dataName
      

      The name of the 3D data.

      Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

    • dataType

      RealspaceDataType dataType
      

      The 3D datas type. Including SuperMap vector data, image data, terrain data, model data, KML data, etc.

Class com.supermap.services.components.commontypes.RealspaceDataParam extends java.lang.Object implements Serializable

  • Serialized Fields

    • dataName

      java.lang.String dataName
      

      The name of the 3D data.

      The name of the 3D layer in the 3D scene (LayerName), when the 3D data is the terrain data, corresponding to the topographic layer Caption (Caption).

    • dataFindType

      DataFindType dataFindType
      

      How to get the three-dimensional cache file.

    • xIndex

      int xIndex
      

      The index of the tile data file in the X direction.

    • yIndex

      int yIndex
      

      The index of the tile data file in the Y direction.

    • level

      int level
      

      The cache layer number. The default value is "-1".

      Since the data amount of 3D data is very large and it will cost many CPU, in order to improve the whole performance, SuperMap provides the 3D data pre-processing function This field is used to set the layer number after setting the data layering cache.

    • fileExtension

      java.lang.String fileExtension
      

      The extension of the tile data file.

    • relativePath

      java.lang.String relativePath
      

      The relative path of tile data file.

      If the relative cache configuration file is set, the settings for the tile data relative path are as follows:

  • For terrain and image 3D cache data, the relative path starts with the directory where the cache configuration file (SCT and SCI3D) resides, that is, from the cache layer number, the hierarchical cache data is stored in the cache configuration file. Such as the cache layer number is 12, then the relative path is "12 /.../.../ cache file".
  • For the three-dimensional cache data of the model, the relative path starts from the parent-level directory of the cache configuration file, that is, the same level as the cache layer number. The model data is different from the terrain and image data. In the hierarchical directory, it is not the data after the cache, but the index of the model cache file. The cache data file (SGM) is stored in the directory of the cache configuration file.
  • For KML data, the relative path is set to a KML file.

dataVersion

java.lang.String dataVersion

The version of the tile data file.

bounds

Rectangle2D bounds

The geographic range of tile data files.

scale

double scale
The scale of the tile.
Since:
7.1

relativePathType

RelativePathType relativePathType

The relative path type can be relative to the data file, or relative to the workspace file.

compressType

CompressType compressType
3D data compression type

Class com.supermap.services.components.commontypes.RealspaceDataResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • dataParam

      RealspaceDataParam dataParam
      

      Generates data query parameter of the result.

    • dataContent

      byte[] dataContent
      
      The binary stream of 3D data file, or cache data.
    • dataUrl

      java.lang.String dataUrl
      

      URL of 3D cache file. In the local, that is the full path of identifying the 3D cache file.

Class com.supermap.services.components.commontypes.RealspaceException extends java.lang.Exception implements Serializable

Class com.supermap.services.components.commontypes.RealspaceJobParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • layerName

      java.lang.String layerName
      
    • sceneName

      java.lang.String sceneName
      
    • isDataFloat

      boolean isDataFloat
      

Class com.supermap.services.components.commontypes.RealspaceTileDataNotFonudException extends java.lang.Exception implements Serializable

Class com.supermap.services.components.commontypes.RealspaceTilesRevisionInfo extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.RealspaceTilesRevisionInfo.Tile extends java.lang.Object implements Serializable

  • Serialized Fields

    • scale

      double scale
      
    • x

      long x
      
    • y

      long y
      

Class com.supermap.services.components.commontypes.Recordset extends java.lang.Object implements Serializable

  • Serialized Fields

    • fields

      java.lang.String[] fields
      

      The name of all fields in the recordset.

      Fields include:

  • System fields, fields names start with "SM".
  • Custom fields, fields names start with non-" SM ".
See Also:
FieldInfo

fieldCaptions

java.lang.String[] fieldCaptions

The alias name of all fields in the recordset.

See Also:
FieldInfo

features

Feature[] features

All the terrain features in recordset.

Note: The element array got by recordset.features, each element object does not contain field name (Feature.fieldNames). If users gets the elements of the record and wants to get the field names of the elements, user can use Recordset.getFeature(int) method or Recordset.getFeatures() method.

fieldTypes

FieldType[] fieldTypes

All the fields types in recordset.

datasetName

java.lang.String datasetName

The name of dataset, is the unique identifier of the dataset.

Class com.supermap.services.components.commontypes.Rectangle extends java.lang.Object implements Serializable

  • Serialized Fields

    • leftTop

      Point leftTop
      

      ${services_components_commontypes_Rectangle_attribute_leftTop_Title}

      ${services_components_commontypes_Rectangle_attribute_leftTop_Description}

    • rightBottom

      Point rightBottom
      

      ${services_components_commontypes_Rectangle_attribute_rightBottom_Title}

      ${services_components_commontypes_Rectangle_attribute_rightBottom_Description}

Class com.supermap.services.components.commontypes.Rectangle2D extends java.lang.Object implements Serializable

  • Serialized Fields

    • leftBottom

      Point2D leftBottom
      

      ${services_components_commontypes_Rectangle2D_attribute_leftBottom_Title}

      ${services_components_commontypes_Rectangle2D_attribute_leftBottom_Description}

    • rightTop

      Point2D rightTop
      

      ${services_components_commontypes_Rectangle2D_attribute_rightTop_Title}

      ${services_components_commontypes_Rectangle2D_attribute_rightTop_Description}

Class com.supermap.services.components.commontypes.RequestSearchParameter extends SearchParameter implements Serializable

  • Serialized Fields

    • orderField

      java.lang.String orderField
      

      Sort fields, sorted by time order by default

      Since:
      7.1.0

Class com.supermap.services.components.commontypes.ResourceParameter extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.ResourceParameter3D extends java.lang.Object implements Serializable

  • Serialized Fields

    • resourceType

      ResourceType resourceType
      

      The resource type.

    • returnType

      ReturnType returnType
      

      The returned type for resource.

Class com.supermap.services.components.commontypes.ResourceResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • resourceURI

      java.lang.String resourceURI
      

      The URI address corresponding with resource file.

    • resourceData

      byte[] resourceData
      

      The binary stream corresponding with resource file, that is the cache data.

Class com.supermap.services.components.commontypes.RestProviderCacheConfig extends java.lang.Object implements Serializable

  • Serialized Fields

    • maxElementsInMemory

      int maxElementsInMemory
      
      The maximum number of records allowed in memory.
      0 stands for unlimited; 1 means no memory cache is used.
    • maxSizeOnDisk

      int maxSizeOnDisk
      

      Maximum disk capacity.

      The unit is MB, the default size is 2048MB.

    • timeToLiveSeconds

      int timeToLiveSeconds
      
      Calculate from the record creation, record the time of survival.
      The unit is second.
      0 for record permanent survival.
    • timeToIdleSeconds

      int timeToIdleSeconds
      
      Calculate the time from the last time the record was last accessed., record the time of survival.
      The unit is second.
      0 for record permanent survival.

Class com.supermap.services.components.commontypes.Route extends Geometry implements Serializable

  • Serialized Fields

    • line

      Geometry line
      
      Deprecated. 

      The line geometric object corresponding with route.

    • region

      Geometry region
      
      Deprecated. 

      The region geometric object corresponding with route.

    • length

      double length
      

      The length of route object, the unit is the same as the dataset unit.

    • maxM

      double maxM
      

      The maximum value in the Route object's Measure value.

    • minM

      double minM
      

      The minimum value in the Route object's Measure value.

Class com.supermap.services.components.commontypes.RouteCalculateMeasureResult extends SpatialAnalystResult implements Serializable

  • Serialized Fields

    • measure

      double measure
      

Class com.supermap.services.components.commontypes.ScaleBuildConfig extends java.lang.Object implements Serializable

  • Serialized Fields

    • scaleDenominator

      double scaleDenominator
      

      The scale denominator.

    • resolution

      double resolution
      

      Resolution. Unit map: unit per pixel

    • tileBoundsWidth

      java.math.BigDecimal tileBoundsWidth
      

      The width range of tile.

    • tileBoundsHeight

      java.math.BigDecimal tileBoundsHeight
      

      The height range of tile.

    • cacheRegions

      Geometry[] cacheRegions
      
      Used to re-cache the white map to indicate the regions which need be re-cached. Indicating the regions which need be re-cached with ScaleBuildConfig.excludeRegions. When the field exists, JobInfo.cacheBounds will be ignored. ScaleBuildConfig.excludeRegions can be null.
    • excludeRegions

      Geometry[] excludeRegions
      

Class com.supermap.services.components.commontypes.ScaleExportJobConfig extends java.lang.Object implements Serializable

  • Serialized Fields

    • scaleDenominator

      double scaleDenominator
      
    • resolution

      double resolution
      
    • tileMatrix

      TileMatrix tileMatrix
      

Class com.supermap.services.components.commontypes.SceneInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      3D scene name.

    • atmosphere

      Atmosphere atmosphere
      

      Atmosphere.

    • camera

      Camera camera
      

      The the camera object of current scene, it is equivalent to the viewpoint.

    • cameraFOV

      double cameraFOV
      

      The angle of the scene camera, in degrees, in the range of 0-90 degrees.

    • fog

      Fog fog
      

      The fog object.

    • fogVisibleAltitude

      double fogVisibleAltitude
      

      The visible height of the fog in the three-dimensional scene, that is, the altitude from the surface of the earth.

    • scaleLegendVisible

      boolean scaleLegendVisible
      

      Whether the scale is visible. True means visible, false means it is not visible.

    • latLonGrid

      LatLonGrid latLonGrid
      

      The LatLonGrid setting.

    • maxCameraDistance

      double maxCameraDistance
      

      The maximum distance of the scene camera, in meters.

    • minCameraDistance

      double minCameraDistance
      

      The minimum distance of the scene camera, in meters.

    • screenLayer

      ScreenLayer screenLayer
      

      The screen layer.

      The 3D scene only has one screen layer. The layer can add any 3D geometric objects and they are not changed with the operation of the sphere in the three-dimensional scene. The objects on the screen layer are still relative to the 3D window and can be used to display still contents in a three-dimensional window.

    • terrainExaggeration

      double terrainExaggeration
      

      The exaggerated proportions of terrain.

      The following two pictures were the effects before and after setting the terrain exaggerated.

      The terrain data overlaying the image data (without terrain exaggerated):

      After the terrain data is exaggerated (exaggeration coefficient is 3):

    • layers

      java.util.List<E> layers
      

      The 3D layer collection. That is all layers included in 3D scene. The elements of collection can be any 3D layer. About the types of 3D layer, please see: Layer3DType.

    • trackingLayer

      TrackingLayer3D trackingLayer
      

      The 3D tracking layer.

    • xml

      java.lang.String xml
      
      The description of the XML form of the 3D scene.
    • sceneType

      SceneType sceneType
      

Class com.supermap.services.components.commontypes.ScreenLayer extends java.lang.Object implements Serializable

  • Serialized Fields

    • geometrys

      java.util.Map<K,V> geometrys
      

      Geometric object set of screen layer.

    • xUnit

      ScreenCoordinateUnit xUnit
      

      Coordinate type of screen layer X axis.

    • yUnit

      ScreenCoordinateUnit yUnit
      

      Coordinate type of screen layer Y axis.

    • visible

      boolean visible
      

      Whether the screen layer is visible or not. True means visible, false means it is not visible.

Class com.supermap.services.components.commontypes.SearchParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • keywords

      java.lang.String[] keywords
      
      Key word.
    • currentPage

      int currentPage
      
      Paging request, page number
    • pageSize

      int pageSize
      
      The page size.
    • orderType

      SearchParameter.OrderType orderType
      
      Sort

Class com.supermap.services.components.commontypes.ServiceAreaResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • nodeIDs

      int[] nodeIDs
      

      The ID collection of network nodes contained in this service area.

    • nodeFeatures

      Feature[] nodeFeatures
      

      The point element collection of network nodes contained in this service area.

    • edgeIDs

      int[] edgeIDs
      

      The ID collection of network arcs contained in this service area.

    • edgeFeatures

      Feature[] edgeFeatures
      

      The point element collection of network arcs contained in this service area.

    • routes

      Route[] routes
      

      The routing objects collection in this service area.

    • serviceRegion

      Geometry serviceRegion
      

      The surface object corresponding to this service area, namely service range.

Class com.supermap.services.components.commontypes.ServiceAreaResults extends java.util.ArrayList<ServiceAreaResult<T>> implements Serializable

Class com.supermap.services.components.commontypes.SimpleDatasetInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • datasourceName

      java.lang.String datasourceName
      

      The data source name.

    • datasetName

      java.lang.String datasetName
      

      Dataset name.

Class com.supermap.services.components.commontypes.SMLInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • SMLFileName

      java.lang.String SMLFileName
      

      Situation map file name.

    • SMLName

      java.lang.String SMLName
      

      Situation map name.

    • SMLDesc

      java.lang.String SMLDesc
      

      Situation map description.

    • SMLSeclevel

      java.lang.String SMLSeclevel
      

      Situation map confidential level

    • SMLDepat

      java.lang.String SMLDepat
      

      The department that the situation map belongs to.

    • SMLAuthor

      java.lang.String SMLAuthor
      

      The author of situation map.

    • SMLTime

      java.lang.String SMLTime
      

      The creation time of situation map.

Class com.supermap.services.components.commontypes.SMTilesLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.SpatialAnalystResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • succeed

      boolean succeed
      
      Whether the analysis is successful.
    • message

      java.lang.String message
      

      The information to return when it fails to analyze.

Class com.supermap.services.components.commontypes.SpatialQuery3DResult extends SpatialAnalystResult implements Serializable

  • Serialized Fields

    • posMode

      PositionMode posMode
      
      Position relations.
    • ids

      int[] ids
      
      The id array of the results.

Class com.supermap.services.components.commontypes.Spheroid extends java.lang.Object implements Serializable

  • Serialized Fields

    • axis

      double axis
      

      ${services_components_commontypes_Spheroid_attribute_axis_Title}

      ${services_components_commontypes_Spheroid_attribute_axis_Description}

    • flatten

      double flatten
      

      ${services_components_commontypes_Spheroid_attribute_flatten_Title}

      ${services_components_commontypes_Spheroid_attribute_flatten_Description}

    • name

      java.lang.String name
      

      ${services_components_commontypes_Spheroid_attribute_name_Title}

      ${services_components_commontypes_Spheroid_attribute_name_Description}

    • type

      SpheroidType type
      

      ${services_components_commontypes_Spheroid_attribute_type_Title}

      ${services_components_commontypes_Spheroid_attribute_type_Description}

Class com.supermap.services.components.commontypes.Style extends java.lang.Object implements Serializable

  • Serialized Fields

    • fillGradientAngle

      double fillGradientAngle
      

      Rotation angle of Gradient fill.

      In unit of degree, the accuracy is 0.1 degree, counterclockwise direction is positive.

      For definitions of each gradient fill style type, please see FillGradientMode.

      For different gradient fill, the effect after its rotation is different, but each rotating center is the center of the smallest external rectangle, rotating anticlockwise.

      1、Linear gradient(Linear)

      When setting angle as arbitrary angle of 0-360 degrees, the passing start and end points rotates anticlockwise, its rotation center is the center of the minimum circumscribed rectangle, the gradient style rotates, the linear gradient still graduates from the start to the termination of the line. The gradient style of the special angle is displayed below:

      (a) When the gradient fill angle is set to 0 degree or 360 degrees, then the gradient fill style is the linear gradient from left to right from the start color to the termination color, the start color is yellow, the termination color is pink as shown in figure;

      (b) When the gradient fill angle is set to 180 degrees, the gradient fill style is opposite to the style described in (a), that is from right to left from the start color to the termination color;

      (c) When the gradient fill angle is set to 90 degrees, the gradient fill style is from bottom to top from the start color to the termination color;

      (d) When the gradient fill angle is set to 270 degrees, the gradient fill style is opposite to the style described in (c), that is from top to bottom from the start color to the termination color;

      2、Radial gradient(Radial)

      When the gradient angle is set to any angle (not beyond the normal range), it will define the radiation gradient round rotating according to the set angle, because the circle is symmetrical about the center of minimum circumscribed rectangle of the filling range, so after rotation, the gradient fill style always stays the same, that is, the radial gradient from center to the boundary of filling range, from foreground color to background color.

      3、Conical gradient (Conical)

      When the gradient Angle is set to any angle between 0-360 degrees, all generating lines of the cone will rotate, in the center of the cone, the center of the minimum circumscribed rectangle of the fill area is as the center of rotation, rotating anticlockwise. As the example shown in figure, the rotation angle is 90 degrees, all the generating lines rotate from the starting position (the position of the zero rotation angle) to the specified angle, takes the generating lines which pass the starting point as an example, they rotate from 0 degree to 90 degrees.

      4、Square gradient (Square)

      According to the given gradient angle, the gradient square rotates as the center of the fill area range, all the square start to rotate from the initial default position where the rotation angle is zero. The gradient is still from the internal square to the external square, from the start color to the termination color.

    • fillBackColor

      Color fillBackColor
      

      ${services_components_commontypes_Style_attribute_fillBackColor_Title}

      ${services_components_commontypes_Style_attribute_fillBackColor_Description}

    • fillBackOpaque

      boolean fillBackOpaque
      

      ${services_components_commontypes_Style_attribute_fillBackOpaque_Title}

      ${services_components_commontypes_Style_attribute_fillBackOpaque_Description}

    • fillGradientOffsetRatioX

      double fillGradientOffsetRatioX
      

      ${services_components_commontypes_Style_attribute_fillGradientOffsetRatioX_Title}

      ${services_components_commontypes_Style_attribute_fillGradientOffsetRatioX_Description}

    • fillGradientOffsetRatioY

      double fillGradientOffsetRatioY
      

      ${services_components_commontypes_Style_attribute_fillGradientOffsetRatioY_Title}

      ${services_components_commontypes_Style_attribute_fillGradientOffsetRatioY_Description}

    • fillForeColor

      Color fillForeColor
      

      ${services_components_commontypes_Style_attribute_fillForeColor_Title}

      ${services_components_commontypes_Style_attribute_fillForeColor_Description}

    • fillGradientMode

      FillGradientMode fillGradientMode
      

      The gradient type of gradient fill style.

    • fillOpaqueRate

      int fillOpaqueRate
      

      ${services_components_commontypes_Style_attribute_fillOpaqueRate_Title}

      ${services_components_commontypes_Style_attribute_fillOpaqueRate_Description}

    • fillSymbolID

      int fillSymbolID
      

      ${services_components_commontypes_Style_attribute_fillSymbolID_Title}

      ${services_components_commontypes_Style_attribute_fillSymbolID_Description}

    • lineColor

      Color lineColor
      

      When the symbol is a linear symbol, the color of the sideline is represented; When the symbol is a maker symbol, the color of the maker is represented.

    • lineSymbolID

      int lineSymbolID
      

      ${services_components_commontypes_Style_attribute_lineSymbolID_Title}

      ${services_components_commontypes_Style_attribute_lineSymbolID_Description}

    • lineWidth

      double lineWidth
      

      ${services_components_commontypes_Style_attribute_lineWidth_Title}

      ${services_components_commontypes_Style_attribute_lineWidth_Description}

    • markerAngle

      double markerAngle
      

      ${services_components_commontypes_Style_attribute_markerAngle_Title}

      ${services_components_commontypes_Style_attribute_markerAngle_Description}

    • markerSize

      double markerSize
      
      Deprecated. 

      The size of maker symbol.

      The unit is : mm. The size of maker symbol and the display size of the maker are two concepts, and the set is the size of the maker symbol here.

      Abolishes from 7.2.0, uses markerWidth和markerHeight instead

    • markerWidth

      double markerWidth
      

      The width of maker symbol.

      The unit is : mm.

    • markerHeight

      double markerHeight
      

      The height of maker symbol.

      The unit is : mm.

    • markerSymbolID

      int markerSymbolID
      

      ${services_components_commontypes_Style_attribute_markerSymbolID_Title}

      ${services_components_commontypes_Style_attribute_markerSymbolID_Description}

Class com.supermap.services.components.commontypes.SupplyCenter extends java.lang.Object implements Serializable

  • Serialized Fields

    • nodeID

      int nodeID
      

      Node ID of resource supply center.

    • maxWeight

      double maxWeight
      

      Maximum cost (resistance) of resource supply center node.

      The maximum resistance of the center point is set larger, the influence of the resources provided by the center point is greater.

      The maximum resistance value is used to limit the cost from the demand point to the center point. If the cost from the demand point (arc or node) to this center is greater than the maximum resistance value, the demand point is filtered out.

    • resourceValue

      double resourceValue
      
      Deprecated. 

      Resource quantity of the resource supply center, does not take effect after setting.

    • type

      SupplyCenterType type
      

      Type of resource supply center.

      About the type of resource supply center, please see SupplyCenterType enumeration class.

      Types of resource supply center include non-center, fixed center and optional center. Fixed center is used for resource allocation analysis; Fixed center and optional center is used for location analysis; Non-centers is not considered when analyzing two networks.

Class com.supermap.services.components.commontypes.SupplyCenterCollection extends java.util.ArrayList<SupplyCenter> implements Serializable

Class com.supermap.services.components.commontypes.SupplyResult extends Feature implements Serializable

  • Serialized Fields

    • actualResourceValue

      double actualResourceValue
      

      The quantity of resources actually provided by the resource supply center.

    • averageWeight

      double averageWeight
      

      The average cost(resistance) from the resource supply center to each demand point.

    • demandCount

      int demandCount
      

      The number of served demand points (arc).

    • totalWeights

      double totalWeights
      

      The sum cost(resistance) from the resource supply center to each demand point.

    • resourceValue

      double resourceValue
      

      Resource quantity of resource supply center.

    • type

      SupplyCenterType type
      

      Type of resource supply center.

      About the type of resource supply center, please see SupplyCenterType enumeration class.

      Types of resource supply center point include non-center, fixed center and optional center. Fixed center is used for resource allocation analysis; Fixed center and optional center is used for location analysis; Non-centers is not considered when analyzing two networks.

    • nodeID

      int nodeID
      

      Node ID of resource supply center.

    • maxWeight

      double maxWeight
      

      The maximum cost (resistance) of each demand object to the resource supply center. If the cost from the demand object(such as arc or node) to this center is greater than the value, the object is filtered out.

Class com.supermap.services.components.commontypes.SurfaceAnalystResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • geometries

      Geometry[] geometries
      

      The geometric object used to surface analysis.

    • datasetInfo

      DatasetInfo datasetInfo
      

      Data set information. For details please refer to DatasetInfo

Class com.supermap.services.components.commontypes.SVTilesMapLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.SVTilesSubLayer extends SVTilesMapLayer implements Serializable

Class com.supermap.services.components.commontypes.SymbolFill3DResourceParameter extends ResourceParameter3D implements Serializable

  • Serialized Fields

    • fill3dID

      int fill3dID
      

      The ID of 3D fill symbol.

Class com.supermap.services.components.commontypes.SymbolLib extends java.lang.Object implements Serializable

  • Serialized Fields

    • libID

      int libID
      

      Label library ID.

    • symbolCount

      int symbolCount
      

      The number of symbol.

    • symbolLibName

      java.lang.String symbolLibName
      

      The name of symbol library.

    • classFication

      java.lang.String classFication
      

      The classification of symbol library.

    • createTime

      java.lang.String createTime
      

      The time of created symbol library.

    • creator

      java.lang.String creator
      

      The unit of symbol library.

    • modifyTime

      java.lang.String modifyTime
      

      The time of the symbol modified.

    • version

      java.lang.String version
      

      The version of symbol library.

    • rootSymbolIconUrl

      java.lang.String rootSymbolIconUrl
      

      The root URI of symbol Icon.

    • rootSymbolLibNode

      SymbolLibNode rootSymbolLibNode
      

      The root node of symbol library.

    • dotCount

      int dotCount
      

      The number of marker symbol.

    • algoCount

      int algoCount
      

      The number of line and region symbol.

Class com.supermap.services.components.commontypes.SymbolLibNode extends java.lang.Object implements Serializable

  • Serialized Fields

    • libID

      int libID
      

      Label library ID.

    • symbolCode

      int symbolCode
      

      Symbol code.

    • symbolName

      java.lang.String symbolName
      

      Symbol name.

    • symbolNodeType

      SymbolNodeType symbolNodeType
      

      The node type of symbol, group node or leaf node.

    • symbolType

      GraphicObjectType symbolType
      

      The symbol type, marker symbol, line symbol or region symbol.

    • childNodeCount

      int childNodeCount
      

      The number of sub nodes from group nodes.

    • childNodes

      java.util.ArrayList<E> childNodes
      

      The sub nodes from group nodes.

Class com.supermap.services.components.commontypes.SymbolLine3DResourceParameter extends ResourceParameter3D implements Serializable

  • Serialized Fields

    • line3dID

      int line3dID
      

      The ID of 3D line. Through specifying SymbolLine3DItemType as LINELIB and setting the parameter lineSymbolID to get the line library file corresponded with the line whose ID is lineSymbolID.

    • modelID

      int modelID
      

      ID of the model in the internal symbol library which is corresponded with the 3D line. Through specifying SymbolLine3DItemType as GEOMODEL and setting the parameter modelID to get the corresponding model file whose ID is modelID in the symbol library which corresponds with line library.

    • baseLineID

      int baseLineID
      

      ID of the base line where the material corresponding with 3D line locates. The parameter should be used with SymbolLine3DResourceParameter.strokeID parameter. Through specifying SymbolLine3DItemType as MATERIAL and setting the parameter baseLineID and @link #strokeID} to get the corresponding material file in the symbol library which corresponds with line library.

    • strokeID

      int strokeID
      

      Stroke ID of the material corresponding with 3D line locates. The parameter should be used with SymbolLine3DResourceParameter.baseLineID parameter. Through specifying SymbolLine3DItemType as MATERIAL and setting SymbolLine3DResourceParameter.baseLineID and strokeID to get the corresponding material file in the symbol library which corresponds with line library.

    • smbolLine3DItemType

      SymbolLine3DItemType smbolLine3DItemType
      

      The feature types of the got 3D line.

Class com.supermap.services.components.commontypes.SymbolMarker3DResourceParameter extends ResourceParameter3D implements Serializable

  • Serialized Fields

    • markerID

      int markerID
      

      3D symbol maker ID

Class com.supermap.services.components.commontypes.SymbolPipeNode3DResourceParameter extends ResourceParameter3D implements Serializable

  • Serialized Fields

    • pipeNodeID

      int pipeNodeID
      

      3D self-adapting pipe-point symbol ID.

Class com.supermap.services.components.commontypes.TADefaultPublishCapability extends java.lang.Object implements Serializable

  • Serialized Fields

    • support

      boolean support
      

      Whether to support to publish by default. Default is false.

      Since:
      7.0.0
    • networkDatasetCount

      int networkDatasetCount
      

      The number of the network dataset.

      Since:
      7.0.0
    • iServerStandard

      boolean iServerStandard
      

      Whether it is iServer Standard. Default is false.

      Since:
      7.0.0
    • noTALicense

      boolean noTALicense
      

      Whether it has transportation analyst license. Default is false.

      Since:
      7.0.0

Class com.supermap.services.components.commontypes.TaskExecutingState extends java.lang.Object implements Serializable

  • Serialized Fields

    • scaleDenominators

      double[] scaleDenominators
      

      The scale denominator.

    • tileMatrixs

      TileMatrix[] tileMatrixs
      

      The tile matrix set.

    • tileTaskBounds

      Rectangle2D[] tileTaskBounds
      

      The current tile task corresponds to a collection of tile ranges

      Corresponds to TileTask.tileMatrixToBuilds, a tile matrix corresponds to a tile range.

    • total

      long total
      

      Tile is always, unit sheet.

    • completed

      long completed
      

      Completed tiles

    • speed

      double speed
      
      Mapping speed of task, unit sheet/second
    • startTime

      long startTime
      

      Task start time.

    • taskId

      java.lang.String taskId
      

      Task ID.

    • step

      TaskExecutingStep step
      

      Task status.

    • tileRegion

      TileRegion tileRegion
      

      Tile area.

    • taskType

      TaskType taskType
      

      Task type

Class com.supermap.services.components.commontypes.TerrainAnalystSetting extends java.lang.Object implements Serializable

  • Serialized Fields

    • bounds

      Rectangle2D bounds
      
      The geographic range of the result data set. BoundType only works when it's Custom.
    • boundsType

      BoundsType boundsType
      
      Analyzes the result data set range type.
    • cellSize

      double cellSize
      
      The size of results data set cell. It works when cell type is Custom.
    • cellSizeType

      CellSizeType cellSizeType
      
      The size of results data set cell.

Class com.supermap.services.components.commontypes.TerrainLayer extends Layer3D implements Serializable

  • Serialized Fields

    • datasetGrid

      DatasetGridInfo datasetGrid
      
      Rater data set.

      If a terrain layer is formed by a raster data set, then the field is not null, If a terrain layer is formed by caches, then the field is null.

    • isDatasetGridFloat

      boolean isDatasetGridFloat
      

Class com.supermap.services.components.commontypes.TextStyle extends java.lang.Object implements Serializable

  • Serialized Fields

    • align

      TextAlignment align
      

      ${services_components_commontypes_TextStyle_attribute_align_Title}

      ${services_components_commontypes_TextStyle_attribute_align_Description}

    • stringAlignment

      StringAlignment stringAlignment
      
      This field represents the multiline text layout type
    • backColor

      Color backColor
      

      ${services_components_commontypes_TextStyle_attribute_backColor_Title}

      ${services_components_commontypes_TextStyle_attribute_backColor_Description}

    • foreColor

      Color foreColor
      

      ${services_components_commontypes_TextStyle_attribute_foreColor_Title}

      ${services_components_commontypes_TextStyle_attribute_foreColor_Description}

    • backOpaque

      boolean backOpaque
      

      ${services_components_commontypes_TextStyle_attribute_backOpaque_Title}

      ${services_components_commontypes_TextStyle_attribute_backOpaque_Description}

    • sizeFixed

      boolean sizeFixed
      

      ${services_components_commontypes_TextStyle_attribute_sizeFixed_Title}

      ${services_components_commontypes_TextStyle_attribute_sizeFixed_Description}

    • fontHeight

      double fontHeight
      

      Text font height, default value is 6, unit relates to TextStyle.sizeFixed. When TextStyle.sizeFixed is False, that is non-fixed text using map coordinate units, for example, the unit is degree in maps of geographic coordinates ; When TextStyle.sizeFixed is True, unit is mm.

    • fontWidth

      double fontWidth
      

      ${services_components_commontypes_TextStyle_attribute_fontWidth_Title}

      ${services_components_commontypes_TextStyle_attribute_fontWidth_Description}

    • fontWeight

      int fontWeight
      

      ${services_components_commontypes_TextStyle_attribute_fontWeight_Title}

      ${services_components_commontypes_TextStyle_attribute_fontWeight_Description}

    • fontName

      java.lang.String fontName
      

      ${services_components_commontypes_TextStyle_attribute_fontName_Title}

      ${services_components_commontypes_TextStyle_attribute_fontName_Description}

    • bold

      boolean bold
      

      ${services_components_commontypes_TextStyle_attribute_bold_Title}

      ${services_components_commontypes_TextStyle_attribute_bold_Description}

    • italic

      boolean italic
      

      ${services_components_commontypes_TextStyle_attribute_italic_Title}

      ${services_components_commontypes_TextStyle_attribute_italic_Description}

    • italicAngle

      double italicAngle
      

      ${services_components_commontypes_TextStyle_attribute_italicAngle_Title}

      ${services_components_commontypes_TextStyle_attribute_italicAngle_Description}

    • shadow

      boolean shadow
      

      ${services_components_commontypes_TextStyle_attribute_shadow_Title}

      ${services_components_commontypes_TextStyle_attribute_shadow_Description}

    • strikeout

      boolean strikeout
      

      ${services_components_commontypes_TextStyle_attribute_strikeout_Title}

      ${services_components_commontypes_TextStyle_attribute_strikeout_Description}

    • outline

      boolean outline
      

      ${services_components_commontypes_TextStyle_attribute_outline_Title}

      ${services_components_commontypes_TextStyle_attribute_outline_Description}

    • outlineWidth

      int outlineWidth
      

      Returns the width of the text contour, the unit of the value is: pixel.

      The numerical range is any integer between 0 and 5.

    • borderSpacingWidth

      int borderSpacingWidth
      

      Returns the spacing between the edge of the text background rectangle and the edge of the text, in pixels.

    • fontScale

      double fontScale
      

      ${services_components_commontypes_TextStyle_attribute_fontScale_Title}

      ${services_components_commontypes_TextStyle_attribute_fontScale_Description}

    • opaqueRate

      int opaqueRate
      

      Note the non-transparency of the text, only valid for 3D fonts.

      The non-transparency range is from 0 to 100.

    • underline

      boolean underline
      

      ${services_components_commontypes_TextStyle_attribute_underline_Title}

      ${services_components_commontypes_TextStyle_attribute_underline_Description}

    • rotation

      double rotation
      

      ${services_components_commontypes_TextStyle_attribute_rotation_Title}

      ${services_components_commontypes_TextStyle_attribute_rotation_Description}

Class com.supermap.services.components.commontypes.Theme extends java.lang.Object implements Serializable

  • Serialized Fields

    • type

      ThemeType type
      

      ${services_components_commontypes_Theme_attribute_type_Title}

      ${services_components_commontypes_Theme_attribute_type_Description}

    • memoryData

      java.util.Map<K,V> memoryData
      

      Theme graph memory data.

      When drawing a theme graph, if user sets the memory data, user will draw a theme graph based on the memory data. The specific implementation is: after using theme value to draw theme graph, it will replace thematic value with the external value to draw the corresponding theme graph.

      The first parameter represents the theme value, which is the field or the value of expressions used to draw theme graphs in the data set; The second parameter represents the external value.

Class com.supermap.services.components.commontypes.Theme3D extends java.lang.Object implements Serializable

  • Serialized Fields

Class com.supermap.services.components.commontypes.Theme3DLabel extends Theme3D implements Serializable

  • Serialized Fields

    • labelExpression

      java.lang.String labelExpression
      

      3D annotation field expressions.

      3D annotation field expressions are filed names or the SQL expressions of field. Determines the content displayed by the label, which is a field or the result of an SQL expression for a field.

    • uniformStyle

      TextStyle uniformStyle
      

      Uniform text style.

Class com.supermap.services.components.commontypes.Theme3DRange extends Theme3D implements Serializable

  • Serialized Fields

    • rangeExpression

      java.lang.String rangeExpression
      

      3D range field expression.

      By comparing the value of the 3D range field expression of a elements and (determined according to certain range mode) the range values of each range, to determine the range where the element locates, to set the different style for the element falling in a different range.

    • items

      java.util.List<E> items
      

      Range theme graph item collection.

Class com.supermap.services.components.commontypes.Theme3DRangeItem extends ThemeRangeItem implements Serializable

  • Serialized Fields

    • style

      GeoStyle3D style
      

      The style corresponding to theme graph item.

Class com.supermap.services.components.commontypes.Theme3DUnique extends Theme3D implements Serializable

  • Serialized Fields

    • defaultStyle

      GeoStyle3D defaultStyle
      

      Defauly style.

      This style is displayed for objects that are not in the 3D unique theme graph item. If not set, uses the default layer display style.

    • uniqueExpression

      java.lang.String uniqueExpression
      

      3D unique theme graph field expression.

      3D unique theme graph field expression is used to create the field or field expression of 3D unique theme graph. This field can be an attribute of a element (such as the time or component of a geological map), and the data type of its value can be numeric type or character type.

    • items

      java.util.List<E> items
      

      3D unique theme graph item collection.

Class com.supermap.services.components.commontypes.Theme3DUniqueItem extends ThemeUniqueItem implements Serializable

  • Serialized Fields

    • style

      GeoStyle3D style
      

      The style corresponding to theme graph item.

Class com.supermap.services.components.commontypes.ThemeCustom extends Theme implements Serializable

  • Serialized Fields

    • fillBackColorExpression

      java.lang.String fillBackColorExpression
      

      The field expressions of filling the background color.

      Since:
      7.1.0
    • fillForeColorExpression

      java.lang.String fillForeColorExpression
      

      The field expressions of filling the color.

      Since:
      7.1.0
    • fillGradientAngleExpression

      java.lang.String fillGradientAngleExpression
      

      The field expressions of filling the angle.

      Since:
      7.1.0
    • fillGradientModeExpression

      java.lang.String fillGradientModeExpression
      

      The field expressions of filling the gradient type.

      Since:
      7.1.0
    • fillGradientOffsetRatioXExpression

      java.lang.String fillGradientOffsetRatioXExpression
      

      The field expressions of filling the X offset of center point.

      Since:
      7.1.0
    • fillGradientOffsetRatioYExpression

      java.lang.String fillGradientOffsetRatioYExpression
      

      The field expressions of filling the Y offset of center point.

      Since:
      7.1.0
    • fillOpaqueRateExpression

      java.lang.String fillOpaqueRateExpression
      

      The field expressions of filling the non-transparency.

      Since:
      7.1.0
    • fillSymbolIDExpression

      java.lang.String fillSymbolIDExpression
      

      The field expressions of filling the symbol style.

      Since:
      7.1.0
    • lineColorExpression

      java.lang.String lineColorExpression
      

      The field expressions of the color of line symbol or point symbol.

      Since:
      7.1.0
    • lineSymbolIDExpression

      java.lang.String lineSymbolIDExpression
      

      The field expressions of filling the line symbol style.

      Since:
      7.1.0
    • lineWidthExpression

      java.lang.String lineWidthExpression
      

      The field expressions of filling the line symbol width.

      Since:
      7.1.0
    • markerAngleExpression

      java.lang.String markerAngleExpression
      

      The field expressions of point symbol rotation angle. Only the point symbol can set this field on the desktop.

      Since:
      7.1.0
    • markerSizeExpression

      java.lang.String markerSizeExpression
      

      The field expressions of point symbol size.

      Since:
      7.1.0
    • markerSymbolIDExpression

      java.lang.String markerSymbolIDExpression
      

      The field expressions of filling the point symbol style.

      Since:
      7.1.0

Class com.supermap.services.components.commontypes.ThemeDotDensity extends Theme implements Serializable

  • Serialized Fields

    • value

      double value
      

      ${services_components_commontypes_ThemeDotDensity_attribute_value_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_value_Description}

    • dotExpression

      java.lang.String dotExpression
      

      Creates a field or field expression for a dot density theme graph.

      A source of the number of dots or the density degree.

    • style

      Style style
      

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Description}

Class com.supermap.services.components.commontypes.ThemeGraduatedSymbol extends Theme implements Serializable

  • Serialized Fields

    • expression

      java.lang.String expression
      

      ${services_components_commontypes_ThemeLabel_attribute_labelEexpression_Title}

      ${services_components_commontypes_ThemeLabel_attribute_numericPrecision_Description}

    • graduatedMode

      GraduatedMode graduatedMode
      

      ${services_components_commontypes_GraduatedMode_attribute_SQUAREROOT_Title}

      ${services_components_commontypes_GraduatedMode_attribute_SQUAREROOT_Description}

    • offsetX

      java.lang.String offsetX
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Description}

    • offsetY

      java.lang.String offsetY
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Description}

    • leaderLineStyle

      Style leaderLineStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Title}

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Description}

    • leaderLineDisplayed

      boolean leaderLineDisplayed
      

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Title}

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Description}

    • flowEnabled

      boolean flowEnabled
      

      ${services_components_commontypes_ThemeLabel_attribute_flowEnabled_Title}

      ${services_components_commontypes_ThemeLabel_attribute_angleFixed_Description}

    • negativeStyle

      Style negativeStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Description}

    • negativeDisplayed

      boolean negativeDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_graphTextDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_graphTextDisplayed_Description}

    • zeroStyle

      Style zeroStyle
      

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Description}

    • zeroDisplayed

      boolean zeroDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_axesGridDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_graphTextDisplayed_Description}

    • positiveStyle

      Style positiveStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_uniformStyle_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_style_Description}

    • baseValue

      double baseValue
      

      ${services_components_commontypes_ThemeDotDensity_attribute_value_Title}

      ${services_components_commontypes_ThemeDotDensity_attribute_value_Description}

    • offsetFixed

      boolean offsetFixed
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Description}

Class com.supermap.services.components.commontypes.ThemeGraph extends Theme implements Serializable

  • Serialized Fields

    • items

      ThemeGraphItem[] items
      

      The subitem collection of a statistical theme graph.

      Where, when the area graph is displayed, multiple item will be merged into one surface, and the style of the surface will be rendered in the style of the first item.

      Since:
      6.1.3
    • offsetX

      java.lang.String offsetX
      

      ${services_components_commontypes_ThemeGraph_attribute_offsetX_Title}

      ${services_components_commontypes_ThemeGraph_attribute_offsetX_Description}

    • offsetY

      java.lang.String offsetY
      

      ${services_components_commontypes_ThemeGraph_attribute_offsetY_Title}

      ${services_components_commontypes_ThemeGraph_attribute_offsetY_Description}

    • graphType

      ThemeGraphType graphType
      

      Statistics theme graph type.

      SuperMap iServer Java defines 13 types of statistical graphs, which are area graph, ladder graph, line graph , dot graph, histogram graph, the 3D histogram graph, pie graph, 3D pie graph, rose graph, 3D rose graph, stacked bar graph, 3D stacked bar graph, circular graph, respectively.

    • barWidth

      double barWidth
      

      ${services_components_commontypes_ThemeGraph_attribute_barWidth_Title}

      ${services_components_commontypes_ThemeGraph_attribute_barWidth_Description}

    • startAngle

      double startAngle
      

      ${services_components_commontypes_ThemeGraph_attribute_startAngle_Title}

      ${services_components_commontypes_ThemeGraph_attribute_startAngle_Description}

    • roseAngle

      double roseAngle
      

      ${services_components_commontypes_ThemeGraph_attribute_roseAngle_Title}

      ${services_components_commontypes_ThemeGraph_attribute_roseAngle_Description}

    • flowEnabled

      boolean flowEnabled
      

      ${services_components_commontypes_ThemeGraph_attribute_flowEnabled_Title}

      ${services_components_commontypes_ThemeGraph_attribute_flowEnabled_Description}

    • leaderLineStyle

      Style leaderLineStyle
      

      ${services_components_commontypes_ThemeGraph_attribute_leaderLineStyle_Title}

      ${services_components_commontypes_ThemeGraph_attribute_leaderLineStyle_Description}

    • leaderLineDisplayed

      boolean leaderLineDisplayed
      

      Whether to show the leader line between the statistics graph and the objects it represents.

      If the render symbol offsets the object, the graph and the object can be connected by a leader line. The leader line works only when setting ThemeGraph.flowEnabled to be true.

    • negativeDisplayed

      boolean negativeDisplayed
      

      In the theme graph, whether the attribute is shown in negative values, true represents displayed, false represents not displayed.

      This method is invalid to area graph, ladder graph, line graph , dot graph, histogram graph, the 3D histogram graph, because negative data is always displayed when drawing; For pie graph, 3D pie graph, rose graph, 3D rose graph, pyramid theme graph - bar, pyramid theme graph - plane, if the user sets the method parameter to be true, then after the negative value is taken as the positive value, and if it is set to be false, it is not drawn (positive and negative data are not drawn).

    • axesColor

      Color axesColor
      

      Coordinate axis color is valid when ThemeGraph.axesDisplayed=true.

      ${services_components_commontypes_ThemeGraph_attribute_axesColor_Description}

    • axesDisplayed

      boolean axesDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_axesDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_axesDisplayed_Description}

    • axesTextStyle

      TextStyle axesTextStyle
      

      Coordinate axis text style. It is valid when ThemeGraph.axesTextDisplayed=true. In which, for the text alignment method, the text alignment method of the coordinate axes in the statistics theme graph adopts the alignment method of lower right corner to prevent coordinate axis overlapping the text.

    • axesTextDisplayed

      boolean axesTextDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_axesTextDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_axesTextDisplayed_Description}

    • axesGridDisplayed

      boolean axesGridDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_axesGridDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_axesGridDisplayed_Description}

    • graphTextStyle

      TextStyle graphTextStyle
      

      The text annotation style on the graph works when ThemeGraph.graphTextDisplayed=true .

      ${services_components_commontypes_ThemeGraph_attribute_graphTextStyle_Description}

    • graphTextFormat

      GraphTextFormat graphTextFormat
      

      Statistics theme graph text display format, such as percentage, real value, title, title + percentage, title + true value.

      Details about statistics theme graph text display format, please refers to GraphTextFormat enumeration class.

    • graphTextDisplayed

      boolean graphTextDisplayed
      

      ${services_components_commontypes_ThemeGraph_attribute_graphTextDisplayed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_graphTextDisplayed_Description}

    • minGraphSize

      double minGraphSize
      

      ${services_components_commontypes_ThemeGraph_attribute_minGraphSize_Title}

      ${services_components_commontypes_ThemeGraph_attribute_minGraphSize_Description}

    • maxGraphSize

      double maxGraphSize
      

      ${services_components_commontypes_ThemeGraph_attribute_maxGraphSize_Title}

      ${services_components_commontypes_ThemeGraph_attribute_maxGraphSize_Description}

    • graphSizeFixed

      boolean graphSizeFixed
      

      ${services_components_commontypes_ThemeGraph_attribute_graphSizeFixed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_graphSizeFixed_Description}

    • graduatedMode

      GraduatedMode graduatedMode
      

      The mapping relationship (constants, logarithms, square roots) between the values of geographical elements in the statistics graph and the dimensions of the chart , which is classification method.

      The classification is mainly to reduce the difference between the data size in drawing statistics theme graph. If the difference between the data is bigger, logarithmic or square root classification method can be used, thus reducing the differences of absolute size between data, visual effect of the statistics graph is better, at the same time, the comparison between different classes is still meaningful.

      There are three classifications: constants, logarithms and square roots, and logarithms and square roots classification methods are not adopted to fields with negative values. Different classification methods are used to determine that the values of the symbol size are not the same, the constant is carried out in accordance with the original data of the field, the logarithm takes its natural logarithm of the sum of each components firstly, the square root takes its square root of the sum of each components firstly, to determine its level symbol size with the final results.

    • graphAxesTextDisplayMode

      GraphAxesTextDisplayMode graphAxesTextDisplayMode
      

      The display mode of the axis text of the graph map.

    • memoryKeys

      int[] memoryKeys
      

      An key array when drawing a theme graph in an array of memory.

      The value in an key array represents SmID value, it and value array(ThemeGraphItem.memoryDoubleValues) of ThemeGraphItem class Are associated with the application. The number of values in the key array must be consistent with the number of value array. The values in the value array will replace the original theme value to draw the statistics theme graph.

      For example: Uses area fields and perimeter fields (that is, two statistics theme graph subitem) as theme variables to draw statistics theme graph.

      Key array is set to(1,3,8,9), the value array whose theme variable is the "area" is set to (5.2,6.1,3.4,8.5),the value array whose theme variable is the "perimeter" is set to (10.2,12.44,6.4,16.1).

      After completely drawing, there will be four statistics graphs, they are statistics graphs corresponding to the recorded SmID values which are 1, 3, 8 and 9 respectively. Each statistic has two items, representing area and perimeter respectively.

      It should be noted that, at this time, the record whose SmID value is 1, the value of the corresponding area field is replaced by "5.2" of the value array, and the value of the perimeter field is replaced by "10.2" of the value array. The record whose SmID value is 3, the value of the corresponding area field value is replaced by "6.1" of the value array, the value of the perimeter field is replaced by "12.44" of the value array, and so on.

    • offsetFixed

      boolean offsetFixed
      

      ${services_components_commontypes_ThemeGraph_attribute_offsetFixed_Title}

      ${services_components_commontypes_ThemeGraph_attribute_offsetFixed_Description}

    • overlapAvoided

      boolean overlapAvoided
      

      ${services_components_commontypes_ThemeGraph_attribute_overlapAvoided_Title}

      ${services_components_commontypes_ThemeGraph_attribute_overlapAvoided_Description}

Class com.supermap.services.components.commontypes.ThemeGraphItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • caption

      java.lang.String caption
      

      ${services_components_commontypes_ThemeGraphItem_attribute_caption_Title}

      ${services_components_commontypes_ThemeGraphItem_attribute_caption_Description}

    • graphExpression

      java.lang.String graphExpression
      

      The theme variable of the statistics theme graph.

      The theme variable can be a field or field expression. Setting this item without setting @link #memoryDoubleValues}.

    • uniformStyle

      Style uniformStyle
      

      ${services_components_commontypes_ThemeGraphItem_attribute_uniformStyle_Title}

      ${services_components_commontypes_ThemeGraphItem_attribute_uniformStyle_Description}

    • memoryDoubleValues

      double[] memoryDoubleValues
      

      An value array when drawing a theme graph in an array of memory.

      Setting this item without setting ThemeGraphItem.graphExpression.

      When drawing a theme graph in an array of memory, only drawing a theme graph for the SmID values recorded in key array (ThemeGraph.memoryKeys). The number of values in the value array must be consistent with the number of key array. The values in the value array will replace the original theme value to draw the statistics theme graph.

      For example: Uses area fields and perimeter fields (that is, two statistics theme graph subitem) as theme variables to draw statistics theme graph.

      Key array is set to(1,3,8,9), the value array whose theme variable is the "area" is set to (5.2,6.1,3.4,8.5),the value array whose theme variable is the "perimeter" is set to (10.2,12.44,6.4,16.1).

      After completely drawing, there will be four statistics graphs, they are statistics graphs corresponding to the recorded SmID values which are 1, 3, 8 and 9 respectively. Each statistic has two items, representing area and perimeter respectively.

      It should be noted that, at this time, the record whose SmID value is 1, the value of the corresponding area field is replaced by "5.2" of the value array, and the value of the perimeter field is replaced by "10.2" of the value array. The record whose SmID value is 3, the value of the corresponding area field value is replaced by "6.1" of the value array, the value of the perimeter field is replaced by "12.44" of the value array, and so on.

Class com.supermap.services.components.commontypes.ThemeGridRange extends Theme implements Serializable

  • Serialized Fields

    • items

      ThemeGridRangeItem[] items
      

      ${services_components_commontypes_ThemeGridRange_attribute_items_Title}

      The grid ranges map items are the ranges got from the subdivision of thematic values with a certain method.

    • rangeMode

      RangeMode rangeMode
      

      ${services_components_commontypes_ThemeGridRange_attribute_rangeMode_Title}

      The grid ranges map supports four range modes: Equal Interval, Square Root, Logarithm, and Defined Interval.

    • rangeParameter

      double rangeParameter
      

      ${services_components_commontypes_ThemeGridRange_attribute_rangeParameter_Title}

      This parameter is the range count when the adopted segmentation method is one of the equal interval, the square root, or the logarithm method.

    • reverseColor

      boolean reverseColor
      

      ${services_components_commontypes_ThemeGridRange_attribute_reverseColor_Title}

      ${services_components_commontypes_ThemeGridRange_attribute_reverseColor_Description}

    • colorGradientType

      ColorGradientType colorGradientType
      

      The mode of graduated colors.

    • specialValueTransparent

      boolean specialValueTransparent
      

      Whether to transparently display the special values (currently supports null value).

    • specialValue

      int specialValue
      
      The special values of the grid thematic map.

Class com.supermap.services.components.commontypes.ThemeGridRangeItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • caption

      java.lang.String caption
      

      ${services_components_commontypes_ThemeGridRangeItem_attribute_caption_Title}

      ${services_components_commontypes_ThemeGridRangeItem_attribute_caption_Description}

    • color

      Color color
      
      ${services_components_commontypes_ThemeGridRangeItem_attribute_color_Title}

      ${services_components_commontypes_ThemeGridRangeItem_attribute_color_Description}

    • start

      double start
      
      ${services_components_commontypes_ThemeGridRangeItem_attribute_start_Title}

      ${services_components_commontypes_ThemeGridRangeItem_attribute_start_Description}

    • end

      double end
      
      ${services_components_commontypes_ThemeGridRangeItem_attribute_end_Title}

      ${services_components_commontypes_ThemeGridRangeItem_attribute_end_Description}

    • visible

      boolean visible
      
      ${services_components_commontypes_ThemeGridRangeItem_attribute_visible_Title}

      ${services_components_commontypes_ThemeGridRangeItem_attribute_visible_Description}

Class com.supermap.services.components.commontypes.ThemeGridUnique extends Theme implements Serializable

  • Serialized Fields

    • items

      ThemeGridUniqueItem[] items
      

      The items for setting the grid unique value thematic map.

      The grid unique value thematic map categorizes pixels with the same attribute value into one class. Different classes are represented with different colors. Each class is a unique values map item.

    • defaultcolor

      Color defaultcolor
      

      ${services_components_commontypes_ThemeGridUnique_attribute_defaultcolor_Title}

      Displays features that not in the grid unique values map item list by using this color.

    • specialValueTransparent

      boolean specialValueTransparent
      

      Whether to transparently display the special values (currently supports null value).

    • specialValue

      int specialValue
      
      The special values of the grid unique map.

Class com.supermap.services.components.commontypes.ThemeGridUniqueItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • caption

      java.lang.String caption
      

      The name of grid unique theme graph item.

      ${services_components_commontypes_ThemeGridUniqueItem_attribute_caption_Description}

    • color

      Color color
      

      The display color of grid unique theme graph item.

      ${services_components_commontypes_ThemeGridUniqueItem_attribute_color_Description}

    • unique

      double unique
      

      The theme value of grid unique theme graph item, which the value of cell, the cells with same value are in one item.

      ${services_components_commontypes_ThemeGridUniqueItem_attribute_unique_Description}

    • visible

      boolean visible
      

      ${services_components_commontypes_ThemeGridUniqueItem_attribute_visible_Title}

      ${services_components_commontypes_ThemeGridUniqueItem_attribute_visible_Description}

Class com.supermap.services.components.commontypes.ThemeLabel extends Theme implements Serializable

  • Serialized Fields

    • items

      ThemeLabelItem[] items
      

      ${services_components_commontypes_ThemeLabel_attribute_items_Title}

      The elements in each subitem displays labels according to the style of the subitem.

    • uniqueItems

      ThemeLabelUniqueItem[] uniqueItems
      
      Unique label theme graph subitem collection
    • backStyle

      Style backStyle
      

      Label background style of label theme graph.

      When sets the back shape ThemeLabel.labelBackShape attribute as default NONE, that is, when not displaying any style, backStyle attribute is invalid.

    • labelBackShape

      LabelBackShape labelBackShape
      

      The shape type of background of label theme graph.

      Background types can be rectangles, rounded rectangles, rhomboids, ellipses, triangles, symbols, etc., and default to NONE, i.e. not using any shape as the background of the label.

    • labelOverLengthMode

      LabelOverLengthMode labelOverLengthMode
      

      Overlong label processing mode.

      The length of a label that exceeds the set maximum length of the label is called a super long label, and the maximum length of the label can be set by ThemeLabel.maxLabelLength.

      SuperMap provides three ways to deal with the overlong labels: NewLine, Omit, and None.

    • flowEnabled

      boolean flowEnabled
      

      ${services_components_commontypes_ThemeLabel_attribute_flowEnabled_Title}

      For the geometric objects which crosses large area and line, in a case that a map window can't fully display, if the label position is fixed, the label of the object in the current map window is not visible, And needs to view the label information of the object by a panning map. If the effect of the flow display is used, even if the object is partly displayed in the current map window, and its label is displayed in the current map window. When panning map, the label of object will move, in order to make sure the object partly or fully displayed in the current, its label is visible, which can easily view the label information of each element.

      The graph below shows the effect schematic graph of the non-flow display and flow display.

      non-flow display flow display

      ${services_components_commontypes_ThemeLabel_attribute_flowEnabled_Description}

    • alongLine

      boolean alongLine
      

      ${services_components_commontypes_ThemeLabel_attribute_alongLine_Title}

      ${services_components_commontypes_ThemeLabel_attribute_alongLine_Description}

    • angleFixed

      boolean angleFixed
      

      ${services_components_commontypes_ThemeLabel_attribute_angleFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_angleFixed_Description}

      If angle is fixed, all the labels are displayed according to the rotation angle of the front set in the text style, not to consider the direction of marking along the line. If it is not fixed, it will consider the rotation angle of the font and the direction of marking along the line. The schematic graph is below:

    • overlapAvoided

      boolean overlapAvoided
      

      ${services_components_commontypes_ThemeLabel_attribute_overlapAvoided_Title}

      ${services_components_commontypes_ThemeLabel_attribute_overlapAvoided_Description}

    • repeatedLabelAvoided

      boolean repeatedLabelAvoided
      

      Returns whether to avoid repeated marker of map.

      For the line data representing the Beijing subway line 4, if it is composed of 4 subsegments, when using the name field (the field value is: subway line 4) as the theme variable to draw label theme graph, If user does not choose to avoid repeated marker of map, the display effect is as left graph, if user chooses to avoid repeated marker of map, system will regard 4 sub-lines of this broken line as a line to mark, the display effect is shown in the figure below.

    • labelRepeatInterval

      double labelRepeatInterval
      

      The interval of the cyclic annotation when marking along the line.

      The unit of length is consistent with the geographical unit of the map. The labelRepeatInterval attribute works only when setting ThemeLabel.repeatedLabelAvoided to be true.

    • offsetX

      java.lang.String offsetX
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetX_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetX_Description}

    • offsetY

      java.lang.String offsetY
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetY_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetY_Description}

    • maxLabelLength

      int maxLabelLength
      

      ${services_components_commontypes_ThemeLabel_attribute_maxLabelLength_Title}

      ${services_components_commontypes_ThemeLabel_attribute_maxLabelLength_Description}

    • leaderLineStyle

      Style leaderLineStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Title}

      ${services_components_commontypes_ThemeLabel_attribute_leaderLineStyle_Description}

    • leaderLineDisplayed

      boolean leaderLineDisplayed
      

      Whether to show the leader line between the label and the object it marks.

      Default is false, that is, not showing the leader line between the label and the object it marks. When the label flow is displayed, its position is not fixed, as the leader line always points to the inner point of the element, so the display function of the leader line can be used to find the actually corresponding elements of the flowing label.

      The following graph shows the drawn label theme graph in the condition of displaying the leader line:

      Note: The leader line works only when setting ThemeLabel.flowEnabled to be true.

    • uniqueExpression

      java.lang.String uniqueExpression
      

      Single value filed expression

      Expression can be a field, but also can be constructed by multiple fields, controls the style of object label by the value of expression, the object labels with same expression values are displayed using the same style.

    • rangeExpression

      java.lang.String rangeExpression
      

      ${services_components_commontypes_ThemeLabel_attribute_rangeExpression_Title}

      ${services_components_commontypes_ThemeLabel_attribute_rangeExpression_Description}

    • labelExpression

      java.lang.String labelExpression
      

      ${services_components_commontypes_ThemeLabel_attribute_labelEexpression_Title}

      The system displays the fields or values of the field expression corresponding to the labelExpression in the form of label.

    • uniformStyle

      TextStyle uniformStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_uniformStyle_Title}

      ${services_components_commontypes_ThemeLabel_attribute_uniformStyle_Description}

    • uniformMixedStyle

      LabelMixedTextStyle uniformMixedStyle
      

      ${services_components_commontypes_ThemeLabel_attribute_uniformMixedSytle_Title}

      ${services_components_commontypes_ThemeLabel_attribute_uniformMixedSytle_Description}

    • matrixCells

      LabelMatrixCell[][] matrixCells
      

      ${services_components_commontypes_ThemeLabel_attribute_matrixCells_Title}

      ${services_components_commontypes_ThemeLabel_attribute_matrixCells_Description}

    • alongLineDirection

      AlongLineDirection alongLineDirection
      

      ${services_components_commontypes_ThemeLabel_attribute_alongLineDirection_Title}

      ${services_components_commontypes_ThemeLabel_attribute_alongLineDirection_Description}

    • maxTextHeight

      int maxTextHeight
      

      ${services_components_commontypes_ThemeLabel_attribute_maxTextHeight_Title}

      ${services_components_commontypes_ThemeLabel_attribute_maxTextHeight_Description}

    • maxTextWidth

      int maxTextWidth
      

      ${services_components_commontypes_ThemeLabel_attribute_maxTextWidth_Title}

      ${services_components_commontypes_ThemeLabel_attribute_maxTextWidth_Description}

    • minTextHeight

      int minTextHeight
      

      ${services_components_commontypes_ThemeLabel_attribute_minTextHeight_Title}

      ${services_components_commontypes_ThemeLabel_attribute_minTextHeight_Description}

    • minTextWidth

      int minTextWidth
      

      ${services_components_commontypes_ThemeLabel_attribute_minTextWidth_Title}

      ${services_components_commontypes_ThemeLabel_attribute_minTextWidth_Description}

    • numericPrecision

      int numericPrecision
      

      ${services_components_commontypes_ThemeLabel_attribute_numericPrecision_Title}

      ${services_components_commontypes_ThemeLabel_attribute_numericPrecision_Description}

    • offsetFixed

      boolean offsetFixed
      

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_offsetFixed_Description}

    • repeatIntervalFixed

      boolean repeatIntervalFixed
      

      ${services_components_commontypes_ThemeLabel_attribute_repeatIntervalFixed_Title}

      ${services_components_commontypes_ThemeLabel_attribute_repeatIntervalFixed_Description}

    • smallGeometryLabeled

      boolean smallGeometryLabeled
      

      ${services_components_commontypes_ThemeLabel_attribute_smallGeometryLabeled_Title}

      ${services_components_commontypes_ThemeLabel_attribute_smallGeometryLabeled_Description}

    • textSpace

      double textSpace
      
      Marking along the line, the spacing between the two characters, the current unit is font height.

Class com.supermap.services.components.commontypes.ThemeLabelItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • start

      double start
      

      ${services_components_commontypes_ThemeLabelItem_attribute_start_Title}

      ${services_components_commontypes_ThemeLabelItem_attribute_start_Description}

    • end

      double end
      

      ${services_components_commontypes_ThemeLabelItem_attribute_end_Title}

      ${services_components_commontypes_ThemeLabelItem_attribute_end_Description}

    • caption

      java.lang.String caption
      

      ${services_components_commontypes_ThemeLabelItem_attribute_caption_Title}

      ${services_components_commontypes_ThemeLabelItem_attribute_caption_Description}

    • style

      TextStyle style
      

      ${services_components_commontypes_ThemeLabelItem_attribute_style_Title}

      ${services_components_commontypes_ThemeLabelItem_attribute_style_Description}

    • visible

      boolean visible
      

      ${services_components_commontypes_ThemeLabelItem_attribute_visible_Title}

      ${services_components_commontypes_ThemeLabelItem_attribute_visible_Description}

Class com.supermap.services.components.commontypes.ThemeLabelUniqueItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • unique

      java.lang.String unique
      
      Specified unique
    • caption

      java.lang.String caption
      
      The name of unique label theme graph item
    • style

      TextStyle style
      
      The text style corresponding to unique
    • offsetX

      double offsetX
      
      Offset in the X direction of label
    • offsetY

      double offsetY
      
      Offset in the Y direction of label
    • visible

      boolean visible
      
      Theme graph visibility

Class com.supermap.services.components.commontypes.ThemeRange extends Theme implements Serializable

  • Serialized Fields

    • rangeMode

      RangeMode rangeMode
      

      Range mode of range theme graph.

      The method is adopted to divide range segmentations in accordance with the value of segmentation field expression (ThemeRange.rangeExpression), including equal distance segmentation method, square root segmentation method, standard deviation segmentation method, logarithmic segmentation method, and other counting segmentation methods, and custom distance method.

    • rangeParameter

      double rangeParameter
      

      Segmentation parameter.

      When the segmented mode is one mode of equal distance segmentation method, square segmentation method, logarithmic segmentation method, and other counting segmentation methods, the parameter is the number of segments (note: it is invalid when the number of segments is ); When the segmentation mode is the standard deviation segmentation method, the parameter is not effective; When the segmented mode is the custom distance, this parameter represents the custom distance.

      The default value is -1.

    • items

      ThemeRangeItem[] items
      

      The range theme graph item array of range theme graph.

      The range theme graph item is the range segment divided by the value of range field expression(ThemeRange.rangeExpression), the factors of same range segment belong to same range theme graph item.

    • rangeExpression

      java.lang.String rangeExpression
      

      Range field expression.

      The theme value is calculated to divide the range theme graph item. Range theme graph range method divides according to a certain distance, therefore the value of range field expression must be numeric type.

    • colorGradientType

      ColorGradientType colorGradientType
      

      The color gradient mode.

      The color gradient refers to the gradually mixture of multiple colors. It can be gradient from the starting color to the end color. It can also be gradient from the starting color to the end color with a variety of intermediate colors. The color gradient type can be applied to the color schema of theme graph object, such as: unique theme graph, range theme graph, grid range theme graph, etc.) objects.

    • precision

      double precision
      

      Sets the rounding accuracy of the range segment theme graph, and the default value is 0.1.

Class com.supermap.services.components.commontypes.ThemeRangeItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • start

      double start
      

      The initial value of range theme graph item, which is the minimum value of this theme range.

      If the item is the first item in the segment, the starting value is the minimum value of the theme value; If the sequence number of the item is greater than or equal to 1, the starting value must be the same as the termination value of the previous item, otherwise the system will throw an exception.

    • end

      double end
      

      The initial value of range theme graph item, which is the maximum value of this theme range.

      If the item is the last item in the segment, the termination value is the minimum value of the theme value; If it is not the last item, the termination value must be the same as the starting value of the previous item, otherwise the system will throw an exception.

    • visible

      boolean visible
      

      Whether the range theme item is visible.

      ${services_components_commontypes_ThemeRangeItem_attribute_visible_Description}

    • caption

      java.lang.String caption
      

      ${services_components_commontypes_ThemeRangeItem_attribute_caption_Title}

      ${services_components_commontypes_ThemeRangeItem_attribute_caption_Description}

    • style

      Style style
      

      The style of range theme graph item.

      Each range theme graph item corresponds to a display style.

Class com.supermap.services.components.commontypes.ThemeUnique extends Theme implements Serializable

  • Serialized Fields

    • items

      ThemeUniqueItem[] items
      

      Unique theme graph item array.

      In the unique theme graph, projects the factors with the same filed expression as a category, sets a rendering style for each category, therefore in which each category is a unique theme graph item.

      For example, using the unique theme graphs to make administrative maps, the Name field represents the province/municipality name, the field is used to make theme variables, if the field values of the field totally have five different values, then the administrative maps have five theme graph items, the Name field values of factor in each item are the same.

    • uniqueExpression

      java.lang.String uniqueExpression
      

      ${services_components_commontypes_ThemeType_attribute_UNIQUE_Title}

      The field or field expression used to draw unique theme graphs, sets the factor with the same filed expression as a unique theme graph item. In which, the field can be an attribute of a factor (such as the time or component of a geological map), and the data type of its value can be numeric type or character type.

    • defaultStyle

      Style defaultStyle
      

      Default style of unique theme graph.

      Unique theme graph item(ThemeUnique.items) may not contain all of the factors, and for those factors that are not contained, namely the factors that do not participate in the unique theme expression, use this style to display.

    • colorGradientType

      ColorGradientType colorGradientType
      

      The color gradient mode.

Class com.supermap.services.components.commontypes.ThemeUniqueItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • unique

      java.lang.String unique
      

      The unique of unique theme graph item.

      That is the value of field expression (ThemeUnique.uniqueExpression)corresponding to unique of unique theme graph item.

    • visible

      boolean visible
      

      ${services_components_commontypes_ThemeUniqueItem_attribute_visible_Title}

      ${services_components_commontypes_ThemeUniqueItem_attribute_visible_Description}

    • caption

      java.lang.String caption
      

      The name of unique theme graph item.

    • style

      Style style
      

      The display style of unique theme graph item.

      That is the display style of factor in item.

Class com.supermap.services.components.commontypes.ThreadRunningInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • threadId

      long threadId
      
    • threadName

      java.lang.String threadName
      
    • operation

      java.lang.String operation
      
    • updateTime

      long updateTime
      

Class com.supermap.services.components.commontypes.TiandituLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.TileBoundle extends java.lang.Object implements Serializable

  • Serialized Fields

    • start

      TileIndex start
      
      Start tile.
    • end

      TileIndex end
      
      End tile.
    • rectLeft

      int rectLeft
      
      The left region column number.
    • rectWidth

      int rectWidth
      
      Area width.

Class com.supermap.services.components.commontypes.TileIndex extends java.lang.Object implements Serializable

  • Serialized Fields

    • columnIndex

      int columnIndex
      

      The column number of the tile.

    • rowIndex

      int rowIndex
      

      The row number of the tile.

Class com.supermap.services.components.commontypes.TileMatrix extends java.lang.Object implements Serializable

  • Serialized Fields

    • startingIndex

      TileIndex startingIndex
      

      Starting index.

    • columnCount

      int columnCount
      

      Column count.

    • rowCount

      int rowCount
      

      Row count.

    • novalueFlags

      boolean[][] novalueFlags
      
      The unvalued identification matrix, the first dimension of the array is the row index, and the second dimension is the column index.

Class com.supermap.services.components.commontypes.TileRegion extends java.lang.Object implements Serializable

  • Serialized Fields

    • setting

      TileRegionSetting setting
      

      Tile range setting info.

    • leftTopPoint

      Point2D leftTopPoint
      

      The coordinates of the top-left corner.

    • tileWidth

      double tileWidth
      

      Tile width

    • tileHeight

      double tileHeight
      

      Tile height

    • rowCount

      int rowCount
      

      Row count

    • colCount

      int colCount
      

      Column count

    • completed

      boolean completed
      

      Finished or not

    • rows

      java.util.List<E> rows
      

      TileRegionRow list.

Class com.supermap.services.components.commontypes.TileRegionRow extends java.lang.Object implements Serializable

  • Serialized Fields

    • rowIndex

      int rowIndex
      

      Row index

    • items

      java.util.List<E> items
      

Class com.supermap.services.components.commontypes.TileRegionRowItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • colStart

      int colStart
      
    • colEnd

      int colEnd
      

Class com.supermap.services.components.commontypes.TileRegionSetting extends java.lang.Object implements Serializable

  • Serialized Fields

    • colorType

      TileColorType colorType
      
    • suitableResolutions

      double[] suitableResolutions
      
      The applicable resolution array, is empty, representing the current setting is for all the resolution.

Class com.supermap.services.components.commontypes.TileScaleInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • scaleDenominator

      double scaleDenominator
      

      The scale denominator.

    • total

      long total
      

      The total number under this scale.

    • completed

      long completed
      

      The completed tile number under this scale.

    • completedBytes

      long completedBytes
      
    • totalMatrix

      TileMatrix totalMatrix
      

      The tile matrix under current scale.

    • completedRegion

      Geometry completedRegion
      

      The range of completing tile.

    • failedRegion

      Geometry failedRegion
      

      The range of failed tile.

    • workerBuildingInfos

      WorkerBuildingInfo[] workerBuildingInfos
      

      Worker info of tile.

    • matrixes

      java.util.List<E> matrixes
      

Class com.supermap.services.components.commontypes.TilesetExportJobConfig extends TilesetExportJobInfo<T1 extends TileSourceInfo,T2 extends TileSourceInfo> implements Serializable

  • Serialized Fields

    • scaleConfigs

      java.util.List<E> scaleConfigs
      
    • tileHeight

      int tileHeight
      
    • tileWidth

      int tileWidth
      

Class com.supermap.services.components.commontypes.TilesetExportJobInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • sourceTileSourceInfo

      TileSourceInfo sourceTileSourceInfo
      
    • sourceTilesetIdentifier

      java.lang.String sourceTilesetIdentifier
      
    • targetTileSourceInfo

      TileSourceInfo targetTileSourceInfo
      
    • targetTilesetIdentifier

      java.lang.String targetTilesetIdentifier
      
    • scaleDenominators

      double[] scaleDenominators
      
    • bounds

      Rectangle2D bounds
      
    • tileVersions

      java.lang.String[] tileVersions
      
    • targetInfo

      java.lang.String targetInfo
      
    • relatedObject

      java.lang.String relatedObject
      

Class com.supermap.services.components.commontypes.TilesetExportJobState extends java.lang.Object implements Serializable

  • Serialized Fields

    • runState

      TilesetExportJobRunState runState
      
      Current state of support.
    • total

      int total
      

      Total number of tiles

    • completed

      int completed
      

      Completed tiles

    • actualCompleted

      int actualCompleted
      

      The number of non-empty tiles

    • startTime

      long startTime
      

      Start time of tile

    • elapsedTime

      long elapsedTime
      

      Time cost, the unit is millisecond.

    • remainTime

      long remainTime
      

      Time rest, the unit is millisecond.

    • speedPerSecond

      int speedPerSecond
      

      Exports the speed of tile

    • toExportScales

      java.util.List<E> toExportScales
      

      A exported progress list at the scale level.

    • exporttingScale

      ExporttingScaleState exporttingScale
      
      The progress of exporting at the current scale level.
    • completedScales

      java.util.List<E> completedScales
      

      Scale or other information of completed tiles.

Class com.supermap.services.components.commontypes.TilesetExportScaleState extends java.lang.Object implements Serializable

  • Serialized Fields

    • tileMatrix

      TileMatrix tileMatrix
      
    • scaleDenominator

      double scaleDenominator
      
    • resolution

      double resolution
      
    • total

      int total
      
    • completed

      int completed
      

      The sum of completed tiles.

      The number of non-empty tiles

Class com.supermap.services.components.commontypes.TileTask extends java.lang.Object implements Serializable

  • Serialized Fields

    • taskType

      TaskType taskType
      

      Type of tile job

    • jobId

      java.lang.String jobId
      

      ID of tile job

    • id

      java.lang.String id
      

      ID of tile task.

    • scaleConfigs

      ScaleBuildConfig[] scaleConfigs
      

      The scale information.

    • tileMatrixToBuilds

      TileMatrix[] tileMatrixToBuilds
      

      Tile matrix collection of tile task.

      Corresponds to TileTask.scaleConfigs, a scale corresponds to a tile matrix.

    • totalTileCount

      long totalTileCount
      

      The sum number of tiles of tile task.

    • state

      TileTaskState state
      

      The state of tile job.

    • masterAddress

      java.lang.String masterAddress
      
      Deprecated. 

      The tile worker address of distributed tile job.

    • deployTime

      long deployTime
      

      The time that tile worker distributes TileTask to the Worker, using the time difference between the distributed time and the coordinated universal time (midnight on 1 January 1970) to represent, unit is millisecond.

    • isRetile

      boolean isRetile
      

      Whether it is a re-cutting task? iServer provides the function of re-cutting problem area after detected by white map.

    • dataPreProcessInfo

      DataPreProcessInfo dataPreProcessInfo
      
    • originalPoint

      Point2D originalPoint
      

      The start of tile index, calculating the start coordinate point of tile row and column index, the default is top-left point of the map.

Class com.supermap.services.components.commontypes.TileTaskState extends java.lang.Object implements Serializable

  • Serialized Fields

    • workerId

      java.lang.String workerId
      

      ID of tile worker of building tile work.

    • runState

      RunState runState
      

      Running state.

    • lastIndex

      TileIndex lastIndex
      

      Tile index.

    • completed

      long completed
      

      The completed tile task number.

Class com.supermap.services.components.commontypes.TileWorkerInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • ip

      java.lang.String ip
      
    • port

      int port
      
    • hostName

      java.lang.String hostName
      
    • address

      java.lang.String address
      
    • id

      java.lang.String id
      
    • name

      java.lang.String name
      
    • token

      java.lang.String token
      
    • controllable

      boolean controllable
      
    • local

      boolean local
      
    • masterAddress

      java.lang.String masterAddress
      

Class com.supermap.services.components.commontypes.TileWorkerState extends TileWorkerInfo implements Serializable

Class com.supermap.services.components.commontypes.TopoCheckResult extends SpatialAnalystResult implements Serializable

  • Serialized Fields

Class com.supermap.services.components.commontypes.TopoErrorInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • sourceObjectID

      long sourceObjectID
      

      The source object ID that violates the topology rules.

    • targetObjectID

      long targetObjectID
      

      The target object ID that conforms to the topology rules. Corresponds to source object ID. Represents the objects corresponding to these two ID do not conform to the corresponding topological rules of topologyRule .

    • topologyRule

      TopologyRule topologyRule
      

      Topology rules.

    • resultGeometry

      Geometry resultGeometry
      

      Topology error result object.

Class com.supermap.services.components.commontypes.TrackingLayer extends java.lang.Object implements Serializable

  • Serialized Fields

    • highlightTargets

      java.util.List<E> highlightTargets
      

      ${services_components_commontypes_TrackingLayer_attribute_highlightTargets_Title}

Class com.supermap.services.components.commontypes.TrackingLayer3D extends java.lang.Object implements Serializable

  • Serialized Fields

    • geometrys

      java.util.Map<K,V> geometrys
      

      Geometric objects of 3D tracking layer.

    • symbolScalable

      boolean symbolScalable
      

      Whether the symbol size of the 3D tracking layer is scaled with the graph. true indicates that when it is scaled with the graph, the map zooms in, and the symbol also zooms in at the same time

    • antialias

      boolean antialias
      

      Whether it is anti-aliasing.

    • visible

      boolean visible
      

      Whether it is visible.

    • symbolScale

      double symbolScale
      

      The natural scale of scaling the 3D tracking layer's symbol.

      The natural scale of scaling the symbol works when the symbol is allowed to be scalable with graph. Specifies the symbol size corresponding to the map display scale when scaled with the graph. The symbol size will zoom in or out on the same scale, according to the ratio of the natural scale and the display scale in the map. For example, the symbol size is 30, the natural scale is 1:50000, and when the local map scale is 1:10000. The symbol size is 150.

Class com.supermap.services.components.commontypes.TrafficTransferAnalystParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • transferPreference

      TransferPreference transferPreference
      
      Transfer preference, default is TransferPreference.NONE.
    • transferTactic

      TransferTactic transferTactic
      
      Transfer tactic, default is TransferTactic.LESS_TIME.
    • solutionCount

      int solutionCount
      
      The returned number of solutions, default is 5.
    • walkingRatio

      double walkingRatio
      
      The weight ratio of walking and bus, default is 10.
    • evadeLines

      long[] evadeLines
      
      Line ID of avoiding line
    • evadeStops

      long[] evadeStops
      
      Station ID of avoiding station
    • priorLines

      long[] priorLines
      
      Line ID of priority line
    • priorStops

      long[] priorStops
      
      Station ID of priority station
    • travelTime

      java.util.Date travelTime
      
      The time of travel, setting this parameter, when analyzing, it will consider the limit of opening time of the line. Filtering out the line whose running time does not include travel time.

Class com.supermap.services.components.commontypes.TrafficTransferAnalystResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • isSupport

      boolean isSupport
      

      Whether to support to publish by default. Default is false.

      Since:
      7.0.0
    • isStandardVersion

      boolean isStandardVersion
      

      Whether it is iServer Standard. Default is false.

      Since:
      7.0.0
    • noTALicense

      boolean noTALicense
      

      Whether it has traffic transfer analyst license. Default is false. Default is false.

      Since:
      7.0.0
    • noLineDataset

      boolean noLineDataset
      

      Whether the analysis result has not the line dataset. Default is false.

      Since:
      7.0.0
    • noPointDataset

      boolean noPointDataset
      

      Whether the analysis result has not the point dataset. Default is false.

      Since:
      7.0.0
    • noTabularDataset

      boolean noTabularDataset
      

      Whether the analysis result has not the attribute dataset. Default is false.

      Since:
      7.0.0

Class com.supermap.services.components.commontypes.TransferGuide extends java.lang.Object implements Serializable

  • Serialized Fields

    • items

      TransferGuideItem[] items
      
      Returns item object of bus transfer guide according to specified number.
    • count

      int count
      
      Returns the number of items of bus transfer guide object.
    • totalDistance

      double totalDistance
      
      Returns the total distance of bus transfer guide, which is the total distance of current transfer solution.
    • transferCount

      int transferCount
      
      Returns bus transfer times, because there may be a walking item, the bus transfer times cannot be easily calculated according to the number of the transfer guide item.

Class com.supermap.services.components.commontypes.TransferGuideItem extends java.lang.Object implements Serializable

  • Serialized Fields

    • distance

      double distance
      
      The distance of a transfer or walking route represented by the TransferGuideItem object.
    • endIndex

      int endIndex
      
      The station positon of the whole bus route which the termination station of a transfer route locates in, represented by the TransferGuideItem object.
    • endStopName

      java.lang.String endStopName
      

      The name of termination station of a transfer route represented by the TransferGuideItem object.

    • endStopAliasName

      java.lang.String endStopAliasName
      

      The alias of termination station of a transfer route represented by the TransferGuideItem object.

    • endPosition

      Point2D endPosition
      

      The position coordinates of termination station of a transfer or working route represented by the TransferGuideItem object.

    • lineName

      java.lang.String lineName
      

      The name of a transfer route represented by the TransferGuideItem object.

    • lineAliasName

      java.lang.String lineAliasName
      

      The alias of a transfer route represented by the TransferGuideItem object.

    • lineType

      int lineType
      

      The type of a transfer route represented by the TransferGuideItem object.

      The value is determined by the field value representing line type in bus line data set by lineTypeField of transfer line environment settings. The appointed data in the Supermap product is as follows: the field value is 0 denoting the bus; The field value is 1 denoting the subway; The field value is 2 denoting the trolleybus.

    • passStopCount

      int passStopCount
      
      Returns the number of passed stations of a transfer route represented by the TransferGuideItem object.
    • route

      Geometry route
      

      Returns the line object of a transfer or walking route represented by the TransferGuideItem object.

    • startIndex

      int startIndex
      
      Returns the station position of the whole bus route which the termination station of a transfer route locates in, represented by the TransferGuideItem object.
    • startPosition

      Point2D startPosition
      

      Returns the position coordinates of termination station of a transfer or working route represented by the TransferGuideItem object.

    • startStopName

      java.lang.String startStopName
      

      Returns the name of starting station of a transfer route represented by the TransferGuideItem object.

    • startStopAliasName

      java.lang.String startStopAliasName
      

      Returns the alias of starting station of a transfer route represented by the TransferGuideItem object.

    • isWalking

      boolean isWalking
      
      Returns a working route or bus route represented by the TransferGuideItem object.
    • firstTime

      java.util.Date firstTime
      
      The first departure time
    • lastTime

      java.util.Date lastTime
      
      The last departure time

Class com.supermap.services.components.commontypes.TransferLine extends java.lang.Object implements Serializable

  • Serialized Fields

    • startStopName

      java.lang.String startStopName
      

      The station name to get on the bus.

    • startStopAliasName

      java.lang.String startStopAliasName
      

      The alias of station to get on the bus.

    • startStopIndex

      int startStopIndex
      

      The index of the bus station in the bus route.

    • lineName

      java.lang.String lineName
      

      Travel route name.

    • lineAliasName

      java.lang.String lineAliasName
      

      Travel route alias.

    • lineID

      long lineID
      

      Travel route ID.

    • endStopName

      java.lang.String endStopName
      

      The station name to get off the bus.

    • endStopAliasName

      java.lang.String endStopAliasName
      

      The alias of station to get off the bus.

    • endStopIndex

      int endStopIndex
      

      The index of the bus station in the bus route.

Class com.supermap.services.components.commontypes.TransferLines extends java.lang.Object implements Serializable

  • Serialized Fields

    • lineItems

      TransferLine[] lineItems
      

      The collection of available routes in this line.

Class com.supermap.services.components.commontypes.TransferSolution extends java.lang.Object implements Serializable

  • Serialized Fields

    • linesItems

      TransferLines[] linesItems
      

      Transfer lines array. Selects a bus route from each transfer line to make up the whole transfer line info.

    • transferCount

      int transferCount
      

      The transfer times corresponding to transfer solution.

Class com.supermap.services.components.commontypes.TransferSolutions extends java.lang.Object implements Serializable

  • Serialized Fields

    • solutionItems

      TransferSolution[] solutionItems
      

      The item array of traffic transfer scheme.

    • defaultGuide

      TransferGuide defaultGuide
      

      The default transfer route for the traffic transfer plan collection.

    • suggestWalking

      boolean suggestWalking
      

      Whether to walk or not.

Class com.supermap.services.components.commontypes.TransferStopInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • alias

      java.lang.String alias
      
      The alias of transfer stop.
    • id

      int id
      
      SMID of transfer stop.
    • name

      java.lang.String name
      
      The name of transfer stop.
    • position

      Point2D position
      

      The coordinate of transfer stop.

    • stopID

      long stopID
      
      The ID of transfer stop.

Class com.supermap.services.components.commontypes.TransportationAnalystParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • barrierEdgeIDs

      int[] barrierEdgeIDs
      

      ID list of obstacles arc.

    • barrierNodeIDs

      int[] barrierNodeIDs
      

      The collection of obstacle node ID.

    • barrierPoints

      Point2D[] barrierPoints
      

      Obstacle coordinate array, set obstacle in form of obstacle.

    • turnWeightField

      java.lang.String turnWeightField
      

      The name of the turning weight field.

    • weightFieldName

      java.lang.String weightFieldName
      

      The name of the weight field, identifies the weight fields used for network analyst.

      The weight used by the network analyst contains forward and reverse weights. WeightFieldInfo specifies the name of forward and reverse weight fields. The environmental settings of the transportation network analyst (TransportationAnalystSetting) specifies weight field information collection (weightFieldInfos). weightName is the name corresponding to a WeightFieldInfo object. If not set, uses the first WeightFieldInfo object of weightFieldInfos to analyze network.

    • uCross

      int[][] uCross
      

      Forbidding limit fields of U type road.

      Sets forbidding limit for U type road. The forbidding limit is designed for the adjacent three arcs, indicating that in one analysis, the result road cannot successively pass through these three arcs. The set is 2D array, the first represents the number of forbidding limit groups, the second represents the forbidding limited arc ID of each group (note that the arc ID numbers in each group must be equal to 3, the limit does not work if it is not equal to 3). The three arcs ID of each group must be adjacent arcs.

    • resultSetting

      TransportationAnalystResultSetting resultSetting
      

      Analyst result should contain settings of contents.

Class com.supermap.services.components.commontypes.TransportationAnalystResultSetting extends java.lang.Object implements Serializable

  • Serialized Fields

    • returnEdgeIDs

      boolean returnEdgeIDs
      

      Returns whether the collection of passing arc ID is contained in the analysis result.

      True means it includes the collection of passing arc ID.

    • returnNodeIDs

      boolean returnNodeIDs
      

      Returns whether the collection of passing node ID is contained in the analysis result.

      True means it includes the collection of passing node ID.

    • returnPathGuides

      boolean returnPathGuides
      

      Returns whether the collection of driving guide is contained in the analysis result.

      True means it includes the collection of driving guide, default is true.

    • returnRoutes

      boolean returnRoutes
      

      Returns whether the collection of the route object is contained in the analysis result.

      True means it includes the collection of the route object.

    • returnEdgeFeatures

      boolean returnEdgeFeatures
      

      Whether to contain the collection of arc factor in the analysis result.

      True means it includes the collection of arc factor.

    • returnEdgeGeometry

      boolean returnEdgeGeometry
      

      Whether to return the geometric object info contained in the collection of arc factor in the analysis result.

      Default is false, not to return the geometric object info contained in the collection of arc factor in the analysis result.

    • returnNodeFeatures

      boolean returnNodeFeatures
      

      Whether to contain the collection of node factor in the analysis result.

      True means it contains the collection of node factor.

    • returnNodeGeometry

      boolean returnNodeGeometry
      

      Whether to return the geometric object info contained in the collection of node factor in the analysis result.

      Default is false, not to return the geometric object info contained in the collection of node factor in the analysis result.

Class com.supermap.services.components.commontypes.TSPPath extends Path implements Serializable

  • Serialized Fields

    • stopIndexes

      int[] stopIndexes
      

      Uses index to represent the order of nodes passed by TSP path.

      For example, in a TSP analysis, the target node is int[] nodeIDs = {1, 3, 5, 7}, and the order of nodes passed by TSP path through the analysis is 5, 3, 7, 1. And stopIndexes = {2, 1, 3, 0}. Because the first node is 5, the index in nodeIDs is 2, so stopIndexes[0] is 2.

Class com.supermap.services.components.commontypes.TSPPaths extends java.util.ArrayList<TSPPath> implements Serializable

Class com.supermap.services.components.commontypes.UDBDatasetInfo extends BigDataFileShareDatasetInfo implements Serializable

  • Serialized Fields

    • datasetType

      java.lang.String datasetType
      
    • datasetName

      java.lang.String datasetName
      
    • bounds

      java.lang.String bounds
      
    • epsgCode

      int epsgCode
      
    • readOnly

      boolean readOnly
      
    • fieldInfos

      java.util.List<E> fieldInfos
      

Class com.supermap.services.components.commontypes.UGCChartLayer extends UGCLayer implements Serializable

Class com.supermap.services.components.commontypes.UGCGridLayer extends UGCLayer implements Serializable

  • Serialized Fields

    • colors

      Color[] colors
      

      Color table object.

      Used for displaying grid layer, when setting this parameter, UGCGridLayer.colorGradientType parameter is invalid. When setting UGCGridLayer.colorDictionary parameter, this parameter is invalid.

    • colorDictionary

      java.util.Map<K,V> colorDictionary
      

      Color comparison table object.

      The key name in the color comparison table is called the specific elevation value, and the key value indicates the color that the elevation value will display. For the point that the elevation value in grid layer is less than the minimum elevation value in the color comparison table, uses the color corresponding to the minimum elevation value in the color comparison table, for the point that the elevation value in grid layer is more than the maximum elevation value in the color comparison table, uses the color corresponding to the maximum elevation value in the color comparison table, for the point that the elevation value in grid layer does not have corresponding color in the color comparison table, then checks corresponding color of two elevations adjacent to current elevation in the color table, and then calculate the color to display by gradient. If color comparison table is set, the color table setting is invalid.

    • colorGradientType

      ColorGradientType colorGradientType
      

      The gradient type pre-defined by the system, generates a default gradient color table with a height of 32 by type.

      When setting UGCGridLayer.colors or UGCGridLayer.colorDictionary parameters, this parameter is invalid.

    • specialValue

      double specialValue
      

      ${services_components_commontypes_UGCGridLayer_attribute_specialValue_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_specialValue_Description}

    • specialColor

      Color specialColor
      

      ${services_components_commontypes_UGCGridLayer_attribute_specialColor_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_specialColor_Description}

    • dashStyle

      Style dashStyle
      

      The color of data in special value of grid data sets.

      The special value of layer. When newly adding a Grid layer, it is the same as NoValue attribute of data set.

    • horizontalSpacing

      double horizontalSpacing
      

      ${services_components_commontypes_UGCGridLayer_attribute_horizontalSpacing_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_horizontalSpacing_Description}

    • solidStyle

      Style solidStyle
      

      ${services_components_commontypes_UGCGridLayer_attribute_solidStyle_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_solidStyle_Description}

    • gridType

      GridType gridType
      

      ${services_components_commontypes_UGCGridLayer_attribute_type_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_type_Description}

    • verticalSpacing

      double verticalSpacing
      

      ${services_components_commontypes_UGCGridLayer_attribute_verticalSpacing_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_verticalSpacing_Description}

    • sizeFixed

      boolean sizeFixed
      

      ${services_components_commontypes_UGCGridLayer_attribute_sizeFixed_Title}

      ${services_components_commontypes_UGCGridLayer_attribute_sizeFixed_Description}

    • brightness

      int brightness
      

      The brightness of Grid layer.

      The brightness of Grid layer, default is 0. The range of the values is -100 to 100, positive when increasing the brightness, negative when reducing the brightness.

    • contrast

      int contrast
      

      The contrast of Grid layer.

      The contrast of Grid layer, default is 0. The range of the values is -100 to 100, positive when increasing the contrast, negative when reducing the contrast.

    • specialValueTransparent

      boolean specialValueTransparent
      

      Whether the area where the SpecialValue is transparent.

      Whether the area where the SpecialValue is transparent.

Class com.supermap.services.components.commontypes.UGCHeatmapLayer extends UGCLayer implements Serializable

  • Serialized Fields

    • kernelRadius

      int kernelRadius
      
      The influence radius of the point factor, which is the circle radius corresponding to the point factor in the map.
    • maxColor

      Color maxColor
      
      The color of the maximum weight of the same data set
    • minColor

      Color minColor
      
      The color of the minimum weight of the same data set
    • maxValue

      double maxValue
      
    • minValue

      double minValue
      
    • weightField

      java.lang.String weightField
      
      Weight field
    • geometries

      Geometry[] geometries
      

Class com.supermap.services.components.commontypes.UGCImageLayer extends UGCLayer implements Serializable

  • Serialized Fields

    • displayBandIndexes

      int[] displayBandIndexes
      

      ${services_components_commontypes_UGCImageLayer_attribute_displayBandIndexes_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_displayBandIndexes_Description}

    • colorSpaceType

      ColorSpaceType colorSpaceType
      

      ${services_components_commontypes_UGCImageLayer_attribute_colorSpaceType_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_colorSpaceType_Description}

    • transparentColor

      Color transparentColor
      

      ${services_components_commontypes_UGCImageLayer_attribute_transparentColor_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_transparentColor_Description}

    • transparent

      boolean transparent
      

      ${services_components_commontypes_UGCImageLayer_attribute_transparent_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_transparent_Description}

    • contrast

      int contrast
      

      ${services_components_commontypes_UGCImageLayer_attribute_contrast_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_contrast_Description}

    • brightness

      int brightness
      

      ${services_components_commontypes_UGCImageLayer_attribute_brightness_Title}

      ${services_components_commontypes_UGCImageLayer_attribute_brightness_Description}

    • transparentColorTolerance

      int transparentColorTolerance
      

      Background transparence tolerance.

      Background transparence tolerance, the range is (0~255).

    • backgroundValue

      double backgroundValue
      
      The background value of the image layer.
    • backgroundValueColor

      Color backgroundValueColor
      
      The style of the background value of the image layer.
    • backgroundValueTransparent

      boolean backgroundValueTransparent
      
      Whether the background value of the image layer is transparent.
    • specialValue

      double specialValue
      
      Special value of the image layer.
    • specialValueColor

      Color specialValueColor
      
      The style of the special value of the image layer.
    • specialValueTransparent

      boolean specialValueTransparent
      
      Whether the style of the special value of the image layer is transparent.

Class com.supermap.services.components.commontypes.UGCLayer extends UGCMapLayer implements Serializable

  • Serialized Fields

    • ugcLayerType

      UGCLayerType ugcLayerType
      

      ${services_components_commontypes_UGCLayer_attribute_ugcLayerType_Title}

      ${services_components_commontypes_UGCLayer_attribute_ugcLayerType_Description}

    • displayFilter

      java.lang.String displayFilter
      

      ${services_components_commontypes_UGCLayer_attribute_displayFilter_Title}

      ${services_components_commontypes_UGCLayer_attribute_displayFilter_Description}

      When the corresponding layer contains fields such as id (integer), the following codes show how to use id as the filter condition to filter out The factor displayed in the layer :

       layer.displayFilter = "id=2";
       
      
    • displayOrderBy

      java.lang.String displayOrderBy
      

      Layer factor displays order field.

      When some factors in the layer exist overlaps, by setting the layer display order fields, user can customize the overlapping oder of factors existing overlaps, the sort fields can be specified as asc or desc, in which the asc denoting ascending oder, the desc denoting descending oder. The fields used for sorting must be numeric.

    • representationField

      java.lang.String representationField
      

      ${services_components_commontypes_UGCLayer_attribute_representationField_Title}

      ${services_components_commontypes_UGCLayer_attribute_representationField_Description}

    • datasetInfo

      DatasetInfo datasetInfo
      

      ${services_components_commontypes_UGCLayer_attribute_datasetInfo_Title}

      ${services_components_commontypes_UGCLayer_attribute_datasetInfo_Description}

    • joinItems

      JoinItem[] joinItems
      

      ${services_components_commontypes_UGCLayer_attribute_joinItems_Title}

      ${services_components_commontypes_UGCLayer_attribute_joinItems_Description}

    • fieldValuesDisplayFilter

      FieldValuesDisplayFilter fieldValuesDisplayFilter
      

      According to the factor value, determines whether the filter is displayed on the map.

      Since:
      8.0.0

Class com.supermap.services.components.commontypes.UGCMapLayer extends Layer implements Serializable

  • Serialized Fields

    • minScale

      double minScale
      

      ${services_components_commontypes_UGCMapLayer_attribute_minScale_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_minScale_Description}

    • maxScale

      double maxScale
      

      ${services_components_commontypes_UGCMapLayer_attribute_maxScale_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_maxScale_Description}

    • minVisibleGeometrySize

      double minVisibleGeometrySize
      

      ${services_components_commontypes_UGCMapLayer_attribute_minVisibleGeometrySize_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_minVisibleGeometrySize_Description}

    • completeLineSymbolDisplayed

      boolean completeLineSymbolDisplayed
      

      ${services_components_commontypes_UGCMapLayer_attribute_completeLineSymbolDisplayed_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_completeLineSymbolDisplayed_Description}

    • opaqueRate

      int opaqueRate
      

      ${services_components_commontypes_UGCMapLayer_attribute_opaqueRate_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_opaqueRate_Description}

    • symbolScalable

      boolean symbolScalable
      

      ${services_components_commontypes_UGCMapLayer_attribute_symbolScalable_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_symbolScalable_Description}

    • symbolScale

      double symbolScale
      

      ${services_components_commontypes_UGCMapLayer_attribute_symbolScale_Title}

      ${services_components_commontypes_UGCMapLayer_attribute_symbolScale_Description}

Class com.supermap.services.components.commontypes.UGCThemeLayer extends UGCLayer implements Serializable

  • Serialized Fields

    • theme

      Theme theme
      

      ${services_components_commontypes_UGCThemeLayer_attribute_theme_Title}

      ${services_components_commontypes_UGCThemeLayer_attribute_theme_Description}

    • themeElementPosition

      java.util.HashMap<K,V> themeElementPosition
      

      ${services_components_commontypes_UGCThemeLayer_attribute_themeElementPosition_Title}

      ${services_components_commontypes_UGCThemeLayer_attribute_themeElementPosition_Description}

Class com.supermap.services.components.commontypes.UGCVectorLayer extends UGCLayer implements Serializable

  • Serialized Fields

    • style

      Style style
      

      ${services_components_commontypes_UGCVectorLayer_attribute_style_Title}

      ${services_components_commontypes_UGCVectorLayer_attribute_style_Description}

Class com.supermap.services.components.commontypes.UnauthorizedException extends java.lang.RuntimeException implements Serializable

Class com.supermap.services.components.commontypes.UserInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • userID

      java.lang.String userID
      

      ${services_components_commontypes_UserInfo_attribute_userID_Title}

      ${services_components_commontypes_UserInfo_attribute_userID_Description}

Class com.supermap.services.components.commontypes.UTFGridJobParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • pixCell

      int pixCell
      
      The pixel width of the cell raster.
    • layerName

      java.lang.String layerName
      

Class com.supermap.services.components.commontypes.UTFGridParameter extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.UTFGridResult extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.ValidateInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • type

      java.lang.String type
      
    • value

      java.lang.String value
      

Class com.supermap.services.components.commontypes.ValidateResult extends java.lang.Object implements Serializable

  • Serialized Fields

    • hasDataPublishCapability

      boolean hasDataPublishCapability
      
      Data service publishing capability
      Since:
      8.1.0
    • hasMapPublishCapability

      boolean hasMapPublishCapability
      
      Map service publishing capability
      Since:
      8.1.0
    • hasRealspaceCapability

      boolean hasRealspaceCapability
      
    • taDefaultPublishCapability

      TADefaultPublishCapability taDefaultPublishCapability
      
    • trafficTransferAnalystResult

      TrafficTransferAnalystResult trafficTransferAnalystResult
      
    • networkAnalyst3DPublishCapability

      NetworkAnalyst3DPublishCapability networkAnalyst3DPublishCapability
      

Class com.supermap.services.components.commontypes.VectorFeature extends java.lang.Object implements Serializable

  • Serialized Fields

    • id

      int id
      
      id
    • geometry

      VectorGeometry geometry
      
      The geometry object.
    • attributes

      java.util.Map<K,V> attributes
      
      Attributes
    • searchValues

      java.lang.String searchValues
      

Class com.supermap.services.components.commontypes.VectorGeometry extends java.lang.Object implements Serializable

  • Serialized Fields

    • parts

      int[] parts
      

      ${services_components_commontypes_Geometry_attribute_parts_Title}

      ${services_components_commontypes_Geometry_attribute_parts_Description}

    • type

      GeometryType type
      

      The type of the geometry object.

      new
    • cutEdges

      int[] cutEdges
      

      Cuts edges.

      Two adjacent array members represent a cut edge.
      Example: [0,1,3,5] indicates the line segment between the zeroth point to the first point, the line segment between the third point to the fifth point is the cut edge.

      Only valid for surface object.

    • partTopo

      int[] partTopo
      
      The topology structure of part. Only the Geometry that GeometryType equals REGION includes this field. 1 represents island, -1 means hole.

Class com.supermap.services.components.commontypes.VectorJobParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • expands

      java.lang.String expands
      
      Deprecated. 
    • containAttributes

      boolean containAttributes
      
    • layers

      VectorTileLayer[] layers
      
    • compressTolerance

      int compressTolerance
      

Class com.supermap.services.components.commontypes.VectorRecordSet extends java.lang.Object implements Serializable

  • Serialized Fields

    • layerName

      java.lang.String layerName
      
      The layer name corresponding to recordset.
    • features

      VectorFeature[] features
      

      All the terrain factors in recordset.

    • fields

      java.lang.String[] fields
      

      The name of all fields in the recordset.

      Fields include:

  • System fields, fields names start with "SM".
  • Custom fields, fields names start with non-" SM ".
See Also:
FieldInfo

fieldTypes

FieldType[] fieldTypes

All the fields types in recordset.

Class com.supermap.services.components.commontypes.VectorStyleQueryResult extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.VectorTileData extends java.lang.Object implements Serializable

Class com.supermap.services.components.commontypes.VectorTileLayer extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      
      Layer names.
    • expandPixels

      int expandPixels
      
      Pixels expanded by tiles.
    • minScale

      double minScale
      
      The smallest display scale.
    • maxScale

      double maxScale
      
      The largest display scale.
    • searchFields

      java.lang.String[] searchFields
      
      The key field name used to search.
    • fields

      java.lang.String[] fields
      

      The name of whole fields.

    • fieldTypes

      FieldType[] fieldTypes
      

      All the filed types.

Class com.supermap.services.components.commontypes.VectorTileParameter extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      
      The target map name.
    • bounds

      Rectangle2D bounds
      

      The geographical extent of the map

    • scale

      double scale
      
      The corresponding scale of the tile.
    • layers

      VectorTileLayer[] layers
      
      The included layer.
    • viewBounds

      Rectangle2D viewBounds
      
      The geographical extent of the tile.
    • originPoint

      Point2D originPoint
      
      Origin of the tiles.
    • prjCoordSys

      PrjCoordSys prjCoordSys
      
      The tile projection
    • viewer

      Rectangle viewer
      

      View. The range of pixels for vector map tile.

    • cacheEnabled

      boolean cacheEnabled
      
      Whether to enable cache.
    • expands

      java.lang.String expands
      
      Deprecated. 

      The pixel value that each layer extends.

      On the basis of layer encoding (the layersID coding method of the tileImage resource), the pixels extended by each layer are defined. The specific method is to add “_{pixel}” after the layer ID, to identify the pixel that the layer needs to extend; If “_{pixel}” is not added, the layer style will be calculated according to the default layer style.

      For example:
      • 0_15:0_5,1_10. The pixels of 0 and 1 sublayer of top 0 layer are 5 and 10 pixels respectively; Under the top layer 0, the extended pixels of the sublayer except the 0 and 1 layers are 15 pixels.
      • 0:0_5,1_10. The 0 and 1 sublayer of the top 0 layer is 5 and 10 pixels respectively; On top layer 0, the extension pixels of the sub-layer except the 0 and 1 layers are 15 pixels.
      • Replaced by VectorTileParameter.layers.

    • returnAttributes

      boolean returnAttributes
      
      Whether to return attribute info.
      Since:
      7.0.1
    • returnCutEdges

      boolean returnCutEdges
      
      Whether to return cut edge info.
      Since:
      7.0.1
    • compressTolerance

      int compressTolerance
      

      Vacuates tolerance.

      The units are pixels, and merges the coordinate sequences within the tolerance range.

      Since:
      7.0.1
    • coordinateType

      CoordinateType coordinateType
      
      Returned coordinate type.

Class com.supermap.services.components.commontypes.ViewShedResult3D extends SpatialAnalystResult implements Serializable

  • Serialized Fields

    • resultDataset

      java.lang.String resultDataset
      

      Result grid dataset name.

Class com.supermap.services.components.commontypes.VisibleResult3D extends java.lang.Object implements Serializable

  • Serialized Fields

    • barrierInfos

      Barrier3DInfo[] barrierInfos
      

      The collection of obstacle point information.

    • lineInvisible

      Geometry3D lineInvisible
      

      Invisible object.

    • lineVisible

      Geometry3D lineVisible
      

      Visible object.

    • targetPoint

      Point3D targetPoint
      

      Observation point object.

    • viewPoint

      Point3D viewPoint
      

      Target point object.

    • isVisible

      boolean isVisible
      

      Whether the observation point and target point are visible. true represents visible, false represents invisible.

Class com.supermap.services.components.commontypes.WeightFieldInfo extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      The name of weight info, identifying this WeightFieldInfo object.

    • forwardWeightField

      java.lang.String forwardWeightField
      

      Forward weight field name.

    • backWeightField

      java.lang.String backWeightField
      

      Reverse weight field name.

    • unit

      Unit unit
      

      Weight unit.

Class com.supermap.services.components.commontypes.WeightFieldInfo3D extends java.lang.Object implements Serializable

  • Serialized Fields

    • name

      java.lang.String name
      

      The name of weight field info.

    • ftWeightField

      java.lang.String ftWeightField
      
      The forward weight field or field expression.
    • tfWeightField

      java.lang.String tfWeightField
      

      The reverse weight field or field expression.

Class com.supermap.services.components.commontypes.WFSDatasetInfo extends DatasetVectorInfo implements Serializable

  • Serialized Fields

    • crsCode

      java.lang.String crsCode
      

      A projected coordinate system represented in format of POSC.

Class com.supermap.services.components.commontypes.WFSLayer extends Layer implements Serializable

  • Serialized Fields

    • url

      java.lang.String url
      

      ${services_components_commontypes_WFSLayer_attribute_url_Title}

      ${services_components_commontypes_WFSLayer_attribute_url_Description}

    • version

      java.lang.String version
      

      ${services_components_commontypes_WFSLayer_attribute_version_Title}

      ${services_components_commontypes_WFSLayer_attribute_version_Description}

    • service

      java.lang.String service
      

      ${services_components_commontypes_WFSLayer_attribute_service_Title}

      ${services_components_commontypes_WFSLayer_attribute_service_Description}

    • request

      java.lang.String request
      

      ${services_components_commontypes_WFSLayer_attribute_request_Title}

      ${services_components_commontypes_WFSLayer_attribute_request_Description}

    • typeName

      java.lang.String typeName
      

      ${services_components_commontypes_WFSLayer_attribute_typeName_Title}

      ${services_components_commontypes_WFSLayer_attribute_typeName_Description}

Class com.supermap.services.components.commontypes.WMSLayer extends Layer implements Serializable

  • Serialized Fields

    • url

      java.lang.String url
      

      ${services_components_commontypes_WMSLayer_attribute_url_Title}

      ${services_components_commontypes_WMSLayer_attribute_url_Description}

    • version

      java.lang.String version
      

      ${services_components_commontypes_WMSLayer_attribute_version_Title}

      ${services_components_commontypes_WMSLayer_attribute_version_Description}

    • service

      java.lang.String service
      

      ${services_components_commontypes_WMSLayer_attribute_service_Title}

      ${services_components_commontypes_WMSLayer_attribute_service_Description}

    • format

      java.lang.String format
      

      ${services_components_commontypes_WMSLayer_attribute_format_Title}

      ${services_components_commontypes_WMSLayer_attribute_format_Description}

    • styles

      java.lang.String styles
      

      ${services_components_commontypes_WMSLayer_attribute_styles_Title}

      ${services_components_commontypes_WMSLayer_attribute_styles_Description}

    • layerStyles

      UserStyleElement[] layerStyles
      
      Layer style info.
    • request

      java.lang.String request
      

      ${services_components_commontypes_WMSLayer_attribute_request_Title}

      ${services_components_commontypes_WMSLayer_attribute_request_Description}

    • exceptions

      java.lang.String exceptions
      

      ${services_components_commontypes_WMSLayer_attribute_exceptions_Title}

      ${services_components_commontypes_WMSLayer_attribute_exceptions_Description}

    • title

      java.lang.String title
      

      ${services_components_commontypes_WMSLayer_attribute_title_Title}

      ${services_components_commontypes_WMSLayer_attribute_title_Description}

    • latLonBoundingBox

      Rectangle2D latLonBoundingBox
      
    • boundsWithCRSs

      BoundsWithCRS[] boundsWithCRSs
      

Class com.supermap.services.components.commontypes.WMTSLayer extends Layer implements Serializable

Class com.supermap.services.components.commontypes.WorkerBuildingInfo extends TileWorkerInfo implements Serializable

  • Serialized Fields

    • lastTileRegion

      Geometry lastTileRegion
      

      The geographical range of the last tile.

    • completed

      long completed
      

      The number of completed tiles.

Class com.supermap.services.components.commontypes.ZXYTilesLayer extends Layer implements Serializable

Package com.supermap.services.components.impl

Package com.supermap.services.components.spi

Package com.supermap.services.components.spi.ogc

  • Class com.supermap.services.components.spi.ogc.WMSCapabilities extends java.lang.Object implements Serializable

    • Serialized Fields

      • exceptionTypes

        java.lang.String[] exceptionTypes
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_exceptionTypes_Title}

        ${services_components_spi_ogc_WmsCapabilities_attribute_exceptionTypes_Description}

      • featureInfoFormats

        java.lang.String[] featureInfoFormats
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_exceptionTypes_Description}

        ${services_components_spi_ogc_WmsCapabilities_attribute_featureInfoFormats_Description}

      • mapFormats

        java.lang.String[] mapFormats
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_mapFormats_Title}

        ${services_components_spi_ogc_WmsCapabilities_attribute_mapFormats_Description}

      • mapTitle

        java.lang.String mapTitle
        

        The map title.

        The map title is the value of the & lt; Title & gt; element record in the & lt; Layer & gt; element in the returned service level metadata information.

      • layers

        java.util.List<E> layers
        

        Map layer list.

      • requestList

        java.util.List<E> requestList
        

        A list of requests for service support

      • srss

        java.lang.String[] srss
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_srss_Title}

        ${services_components_spi_ogc_WmsCapabilities_attribute_srss_Description}

      • version

        java.lang.String version
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_version_Title}

        ${services_components_spi_ogc_WmsCapabilities_attribute_version_Description}

      • serviceDescription

        ServiceDescription serviceDescription
        

        ${services_components_spi_ogc_WmsCapabilities_attribute_serviceDescription_Title}

      • crss

        java.lang.String[] crss
        
  • Class com.supermap.services.components.spi.ogc.WMSFeatureInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • version

        java.lang.String version
        

        ${services_components_spi_ogc_WmsFeatureInfo_attribute_version_Title}

        ${services_components_spi_ogc_WmsFeatureInfo_attribute_version_Description}

      • nameSpaceURI

        java.lang.String nameSpaceURI
        

        ${services_components_spi_ogc_WmsFeatureInfo_attribute_nameSpaceURI_Title}

        ${services_components_spi_ogc_WmsFeatureInfo_attribute_nameSpaceURI_Description}

      • fieldNames

        java.lang.String[] fieldNames
        

        The attribute field name of the feature.

        Is a String array that corresponds to the # fieldValues attribute, that is, the value field of the corresponding position in the fieldNames array is the value in the same position of the fieldValues array.

      • fieldValues

        java.lang.String[] fieldValues
        

        The attribute field value of the feature.

        Is a String array that corresponds to the # fieldNames attribute, that is, the value field of the corresponding position in the fieldNames array is the value in the same position of the fieldValues array.

  • Class com.supermap.services.components.spi.ogc.WMSMapParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • mapName

        java.lang.String mapName
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_mapName_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_mapName_Description}

      • width

        int width
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_width_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_width_Description}

      • height

        int height
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_height_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_height_Description}

      • layers

        java.lang.String[] layers
        

        Map layer name list.

      • center

        Point2D center
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_center_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_center_Description}

      • entireBounds

        Rectangle2D entireBounds
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_entireBounds_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_entireBounds_Description}

      • bounds

        Rectangle2D bounds
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_bounds_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_bounds_Description}

      • styles

        java.lang.String[] styles
        

        Request a list of style names for the layer.

        The value of the element in the list corresponds to the value of the & lt; Style & gt; element of the & lt; Layer & gt; element in the service metadata acquired by the GetCapabilities operation of the WMS. # styles attribute array is one-to-one with the # layers attribute array, which identifies the display style for each layer.

        If the style that requested does not exist, the server will return a service exception (code = StyleNotDefined).

      • srs

        java.lang.String srs
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_srs_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_srs_Description}

      • transparent

        boolean transparent
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_transparent_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_transparent_Description}

      • bgcolor

        java.lang.String bgcolor
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_bgcolor_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_bgcolor_Description}

      • sldBody

        java.lang.String sldBody
        
        SLD_BODY
      • exceptions

        java.lang.String exceptions
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_exceptions_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_exceptions_Description}

      • format

        java.lang.String format
        

        ${services_components_spi_ogc_WMSMapParameter_attribute_format_Title}

        ${services_components_spi_ogc_WMSMapParameter_attribute_format_Description}

      • crs

        java.lang.String crs
        

        Coordinate reference system</>

        Used in WMS1.3.0

  • Class com.supermap.services.components.spi.ogc.WMSQueryParameter extends WMSMapParameter implements Serializable

    • Serialized Fields

      • queryLayers

        java.lang.String[] queryLayers
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_query_layers_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_query_layers_Description}

      • infoFormat

        java.lang.String infoFormat
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_info_format_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_info_format_Description}

      • featureCount

        int featureCount
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_featureCount_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_featureCount_Description}

      • x

        int x
        

        X of the feature in pixel.

        The leftmost is 0, the right increases.

      • y

        int y
        

        Y of the feature in pixel.

        The top is 0, increasing downward.

      • customParameters

        java.util.Map<K,V> customParameters
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_customParameters_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_customParameters_Description}

  • Class com.supermap.services.components.spi.ogc.WMSServiceException extends java.lang.RuntimeException implements Serializable

Package com.supermap.services.metadata.smmd2007

Package com.supermap.services.ogc

  • Class com.supermap.services.ogc.ContactInformation extends java.lang.Object implements Serializable

    • Serialized Fields

      • person

        java.lang.String person
        

        The person to contact.

      • organization

        java.lang.String organization
        

        The organization.

      • position

        java.lang.String position
        

        The position.

      • addressType

        java.lang.String addressType
        

        The address type.

      • address

        java.lang.String address
        

        The address.

      • city

        java.lang.String city
        

        The city.

      • stateOrProvince

        java.lang.String stateOrProvince
        

        The province or district.

      • postCode

        java.lang.String postCode
        

        The post code.

      • country

        java.lang.String country
        

        The country.

      • voiceTelephone

        java.lang.String voiceTelephone
        

        The contact telephone.

      • facsimileTelephone

        java.lang.String facsimileTelephone
        

        The fax.

      • electronicMailAddress

        java.lang.String electronicMailAddress
        

        The E-mail address.

  • Class com.supermap.services.ogc.ServiceContact extends java.lang.Object implements Serializable

    • Serialized Fields

      • individualName

        java.lang.String individualName
        

        Contact name.

      • positionName

        java.lang.String positionName
        

        Contact position.

      • phoneNumber

        java.lang.String phoneNumber
        

        The contact telephone.

      • faxNumber

        java.lang.String faxNumber
        

        The fax.

      • deliveryPoint

        java.lang.String deliveryPoint
        

        Mail address, such as street.

      • addressCity

        java.lang.String addressCity
        

        The city.

      • addressAdministrativeArea

        java.lang.String addressAdministrativeArea
        

        Administrative division.

      • addressPostalCode

        java.lang.String addressPostalCode
        

        The post code.

      • addressCountry

        java.lang.String addressCountry
        

        The country.

      • addressElectronicMailAddress

        java.lang.String addressElectronicMailAddress
        

        email.

  • Class com.supermap.services.ogc.ServiceDescription extends java.lang.Object implements Serializable

    • Serialized Fields

      • name

        java.lang.String name
        

        The service name.

        A service name represents an instantiated service. For example, a service named "WMS" represents a WMS service instance.

        Required.

      • title

        java.lang.String title
        

        The title.

        Identifies the server. For example, the title "SuperMap Map Server" indicates that the server provides the WMS service.

        Required.

      • serviceAbstract

        java.lang.String serviceAbstract
        

        The server description.

        The more detailed server description.

        Optional.

      • keywords

        java.lang.String[] keywords
        

        Keyword.

        Uses keywords to facilitate directory searching.

        Optional.

      • onlineResource

        java.lang.String onlineResource
        

        The online resources.

        Records the service’s Web site, usually the service’s URL address.

        Required.

      • contactInformation

        ContactInformation contactInformation
        

        The service provider contact information.

        Optional.

      • fees

        java.lang.String fees
        

        The cost.

        The cost of using the service. The keyword "none" means that the service is free to use.

        Optional.

      • accessConstraints

        java.lang.String accessConstraints
        

        The access constraint.

        Access to the constraints of a service. The keyword "none" indicates that the service has no access constraints.

        Optional.

  • Class com.supermap.services.ogc.ServiceIdentification extends java.lang.Object implements Serializable

    • Serialized Fields

      • title

        java.lang.String title
        

        Service title.

      • description

        java.lang.String description
        

        Service description.

      • keywords

        java.util.List<E> keywords
        

        Service keywords.

      • fees

        java.lang.String fees
        

        Service price.

      • accessConstraints

        java.lang.String accessConstraints
        

        Service connect restrictions

      • serviceType

        java.lang.String serviceType
        

        City

      • serviceTypeVersion

        java.lang.String serviceTypeVersion
        

        Service version.

  • Class com.supermap.services.ogc.ServiceProvider extends java.lang.Object implements Serializable

    • Serialized Fields

      • providerName

        java.lang.String providerName
        

        Service provider name.

      • providerSite

        java.lang.String providerSite
        

        Service provider homepage.

      • serviceContact

        ServiceContact serviceContact
        

        Service provider contact information.

Package com.supermap.services.ogc.filter

Package com.supermap.services.ogc.filter.encode

Package com.supermap.services.providers

  • Class com.supermap.services.providers.AggregationDataProviderSetting extends DataProviderSetting implements Serializable

  • Class com.supermap.services.providers.AggregationMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • serviceInfos

        java.util.List<E> serviceInfos
        

        The information list of service endpoint.

      • mapNames

        java.lang.String[] mapNames
        

        Map name.

      • targetName

        java.lang.String targetName
        

        The name of the map after the aggregation.

      • cacheEnabled

        boolean cacheEnabled
        
        Whether to use caching.
        Since:
        8.0.0
  • Class com.supermap.services.providers.ArcGISCacheMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.ArcGISRestDataProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        rest service address, points to the root resource path of feature services. request list.

        Such as: http://localhost:6080/arcgis/rest/services/China/FeatureServer

      • token

        java.lang.String token
        
        Token.
      • httpReferer

        java.lang.String httpReferer
        
        REFERER
  • Class com.supermap.services.providers.ArcGISRestMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.ArcGISRestNetworkAnalystProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        rest service address, points to the root resource path of feature services. request list.

        Such as: http://localhost:6080/arcgis/rest/services/China/NAServer

      • token

        java.lang.String token
        
        Token.
      • httpReferer

        java.lang.String httpReferer
        
        REFERER
      • networkDataset

        java.lang.String networkDataset
        
        The network dataset
      • routeLayer

        java.lang.String routeLayer
        
        Path Analysis Layer
      • serviceAreaLayer

        java.lang.String serviceAreaLayer
        
        Service Area Analysis Layer
      • closestFacilityLayer

        java.lang.String closestFacilityLayer
        
        Closest Facility Analysis Layer
  • Class com.supermap.services.providers.BaiduMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.BaiduMapQuerySetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • ak

        java.lang.String ak
        

        The key of Baidu users apply for registration.

        Required parameter. The key needs to contain the Places API, Geocoding API permissions.

        Since:
        7.1.0
        See Also:
        Request a key address
      • sn

        java.lang.String sn
        

        Sn used in security verification.

        Nonessential parameters. If the verification method of ak is sn check, this parameter must be set.

        Since:
        7.1.0
      • suggestionUrl

        java.lang.String suggestionUrl
        

        Place Suggestion API service URL.

        Optional parameters. Default value is: http://api.map.baidu.com/place/v2/suggestion

        Since:
        7.1.0
        See Also:
        Place Suggestion API introduction
      • gecodingUrl

        java.lang.String gecodingUrl
        

        Geocoding API service URL.

        Optional parameters. Default value is: http://api.map.baidu.com/geocoder/v2/.

        Since:
        7.1.0
        See Also:
        Geocoding API introduction
  • Class com.supermap.services.providers.BingMapsMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.CloudMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.DataProviderDelayCommitSetting extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.DefaultProviderConfig extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.DelayTaskInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • id

        java.lang.String id
        
      • datasourceName

        java.lang.String datasourceName
        
      • addTime

        long addTime
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayAddFeaturesTaskInfo extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • targetFeatures

        java.util.List<E> targetFeatures
        
      • datasetName

        java.lang.String datasetName
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayDeleteFeaturesTaskInfoByIds extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • datasetName

        java.lang.String datasetName
        
      • ids

        int[] ids
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayDeleteFeaturesTaskInfoByQueryParam extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • datasetName

        java.lang.String datasetName
        
      • queryParam

        QueryParameter queryParam
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayUpdateDatasetInfoTaskInfo extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • datasetName

        java.lang.String datasetName
        
      • newDatasetInfo

        DatasetInfo newDatasetInfo
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayUpdateDatasourceInfoTaskInfo extends DelayTaskInfo implements Serializable

    • Serialized Fields

  • Class com.supermap.services.providers.DelayTaskInfo.DelayUpdateFeaturesTaskInfo extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • targetFeatures

        java.util.List<E> targetFeatures
        
      • datasetName

        java.lang.String datasetName
        
  • Class com.supermap.services.providers.DelayTaskInfo.DelayUpdateFieldInfosTaskInfo extends DelayTaskInfo implements Serializable

    • Serialized Fields

      • datasetName

        java.lang.String datasetName
        
      • newFieldInfos

        java.util.List<E> newFieldInfos
        
  • Class com.supermap.services.providers.ExcludedFieldsInDataset extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.ExcludedFieldsInDatasource extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.ExcludedFieldsInLayer extends java.lang.Object implements Serializable

    • Serialized Fields

      • layerName

        java.lang.String layerName
        
        Filtered layers
      • excludedFields

        java.lang.String excludedFields
        
        Filtered list of fields
  • Class com.supermap.services.providers.ExcludedFieldsInMap extends java.lang.Object implements Serializable

    • Serialized Fields

      • mapName

        java.lang.String mapName
        
        Filtered maps
      • excludedFieldsInLayers

        ExcludedFieldsInLayer[] excludedFieldsInLayers
        
  • Class com.supermap.services.providers.FastDFSTileProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.FilteredDatasourceInfo extends java.lang.Object implements Serializable

    • Serialized Fields

  • Class com.supermap.services.providers.GDPMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • filesPath

        java.lang.String filesPath
        
        GDP file directory.
      • bounds

        java.lang.String bounds
        

        Map range.

        Default: -20037508.3427892440,-20037508.3427892440,20037508.3427892440,20037508.3427892440.

      • dpi

        double dpi
        

        dpi.

        Default: 96.

      • tileSize

        int tileSize
        
        Slice size.
      • format

        OutputFormat format
        
        Image Format.
      • zoom0ScaleDenator

        double zoom0ScaleDenator
        

        Level 0 scale denominator.

        Default: 5.916587109091312E8

      • mapName

        java.lang.String mapName
        
        Deprecated. 

        Map name.

        The default is # filePath directory name.

  • Class com.supermap.services.providers.GeoPackageException extends java.lang.RuntimeException implements Serializable

  • Class com.supermap.services.providers.GeoPackageMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.GoogleMapLayer extends Layer implements Serializable

    • Serialized Fields

      • googleMapLanguage

        java.lang.String googleMapLanguage
        
  • Class com.supermap.services.providers.GoogleMapsMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • googleMapLanguage

        java.lang.String googleMapLanguage
        

        The language used for text annotation in the map.

        Since:
        8.0.2
      • googleMapCryptoKey

        java.lang.String googleMapCryptoKey
        

        The private key of the account.

        Since:
        8.0.2
      • googleMapClientID

        java.lang.String googleMapClientID
        

        The account with Google Maps access.

        Since:
        8.0.2
      • googleMapWidth

        java.lang.String googleMapWidth
        

        Each time you request a tile from Google Maps, the width of the tile (pixels). Since there may be a Geoogle watermark on each request for a single tile, the larger tile setting can reduce the watermark density throughout the window. However, single tile too large may affect the efficiency of tile access, because you should be based on hardware and software and network conditions, set a reasonable value.

        Since:
        8.0.2
      • googleMapHeight

        java.lang.String googleMapHeight
        

        Each time you request a tile from Google Maps, the width of the tile (pixels). Generally set the same width, height tiles .

        Since:
        8.0.2
      • googleProxyAddress

        java.lang.String googleProxyAddress
        

        Google Maps proxy address. If the service can not be normal due to network reasons, you should set this parameter, such as: 127.0.0.1.

        Since:
        8.0.2
      • googleProxyPort

        int googleProxyPort
        

        Google Maps proxy port.

        Since:
        8.0.2
  • Class com.supermap.services.providers.InvalidDatasetSignException extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.InvalidMapException extends java.lang.IllegalArgumentException implements Serializable

  • Class com.supermap.services.providers.MongoDBRealspaceProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • serverAdresses

        java.lang.String[] serverAdresses
        
        MongoDB service address.
      • database

        java.lang.String database
        
        MongoDB database name.

        The default is smtiles

        Since:
        8.0.0
      • username

        java.lang.String username
        
        The username.
        Since:
        8.0.0
      • password

        java.lang.String password
        
        The password.
        Since:
        8.0.0
      • tilesetNames

        java.lang.String[] tilesetNames
        
        Slice array.

        Optional parameters. When the parameter is empty, all the 3D slices in the MongoDB database are published.

  • Class com.supermap.services.providers.MongoDBTileProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • serverAdresses

        java.lang.String[] serverAdresses
        
      • mapName

        java.lang.String mapName
        
        Map name.

        Optional parameters.

      • tilesetName

        java.lang.String tilesetName
        
        The slice set name.

        Optional parameters. The names of the maps are the same, but its size, transparency, scale, etc. may be different, so use a slice set name to uniquely identify a slice set.

      • database

        java.lang.String database
        
        MongoDB database name.

        The default is smtiles

        Since:
        8.0.0
      • username

        java.lang.String username
        
        The username.
        Since:
        8.0.0
      • password

        java.lang.String password
        
        The password.
        Since:
        8.0.0
  • Class com.supermap.services.providers.MVTTileProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • configFilePath

        java.lang.String configFilePath
        
  • Class com.supermap.services.providers.NoSupportedVersionException extends java.lang.Exception implements Serializable

  • Class com.supermap.services.providers.OpenStreetMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.OTSTileProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • mapName

        java.lang.String mapName
        
        Map name.

        Optional parameters.

      • tilesetName

        java.lang.String tilesetName
        
        The slice set name.

        Optional parameters. The names of the maps are the same, but its size, transparency, scale, etc. may be different, so use a slice set name to uniquely identify a slice set.

      • nodeName

        java.lang.String nodeName
        
        Ali cloud node name
      • instanceName

        java.lang.String instanceName
        
        Instance name
      • accessKeyId

        java.lang.String accessKeyId
        
        KeyId
      • accessKeySecret

        java.lang.String accessKeySecret
        
        KeySecret
      • fromPublic

        boolean fromPublic
        
        Whether from the public network access
  • Class com.supermap.services.providers.ProviderSettingChecker.GetDatasetException extends java.lang.Exception implements Serializable

    • Serialized Fields

      • code

        int code
        
  • Class com.supermap.services.providers.RestAddressMatchProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        AddressMatch service address, point to the root resource path of the AddressMatch service.

      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • useCache

        boolean useCache
        
        Whether to use caching
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
  • Class com.supermap.services.providers.RestDataProviderSetting extends DataProviderSetting implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        rest service address, points to the root resource path of rest services.

      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • useCache

        boolean useCache
        
        Whether to use caching
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
  • Class com.supermap.services.providers.RestMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        rest service address, points to the root resource path of rest services.

      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • useCache

        boolean useCache
        
        Whether to use caching
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
  • Class com.supermap.services.providers.RestProviderBase.RestRequestException extends java.lang.Exception implements Serializable

    • Serialized Fields

      • code

        int code
        
      • errorMessage

        java.lang.String errorMessage
        
      • exception

        java.lang.Exception exception
        
  • Class com.supermap.services.providers.RestRealspaceProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        rest service address, points to the root resource path of rest services.

      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
      • useCache

        boolean useCache
        
        Whether to use caching
  • Class com.supermap.services.providers.RestSpatialAnalystProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        SpatialAnalyst service address, points to the root resource path of SpatialAnalyst services.

      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • useCache

        boolean useCache
        
        Whether to use caching
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
  • Class com.supermap.services.providers.RestTrafficTransferAnalystProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        TrafficTransferAnalyst service address, pointing to the root resource path of the TrafficTransferAnalyst service.

      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • userName

        java.lang.String userName
        

        The username information, when the rest service needs to be authenticated, it is necessary to fill in the information.

      • password

        java.lang.String password
        

        The password information, when the rest service needs to be authenticated, it is necessary to fill in the information. Used with user name information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • useCache

        boolean useCache
        
        Whether to use caching
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        The REST service provider requests the cache configuration
  • Class com.supermap.services.providers.RestTransportationAnalystProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • restServiceRootURL

        java.lang.String restServiceRootURL
        

        TrafficTransferAnalyst service address, pointing to the root resource path of the TrafficTransferAnalyst service.

      • httpReferer

        java.lang.String httpReferer
        
        Returns the HTTPReferer required to access the Rest service.
      • userName

        java.lang.String userName
        

        The user name information.

      • password

        java.lang.String password
        

        The password information.

      • token

        java.lang.String token
        
        The required Token to access iServer REST.
      • useCache

        boolean useCache
        
        Whether to use caching.
      • restProviderCacheConfig

        RestProviderCacheConfig restProviderCacheConfig
        
        Cache configuration.
  • Class com.supermap.services.providers.SMTilesMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.SVTilesMapProviderSetting extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.TiandituMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.TilesetMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • tileSourceInfo

        TileSourceInfo tileSourceInfo
        

        Slice source (required).

      • mapName

        java.lang.String mapName
        

        The name of the map to be published (optional).

      • tilesetName

        java.lang.String tilesetName
        

        Slice set name (optional).

  • Class com.supermap.services.providers.TPKMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.TrafficTransferAnalystSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • name

        java.lang.String name
        
        Public transport network name, such as "Beijing bus"
      • workspaceConnectString

        java.lang.String workspaceConnectString
        

        Workspace connection string.

      • transferLineSetting

        TransferLineSetting transferLineSetting
        
        Bus line environment setting.
      • transferStopSetting

        TransferStopSetting transferStopSetting
        
        Bus site environment settings.
      • transferRelationSetting

        TransferRelationSetting transferRelationSetting
        
        Bus station and line relationship setting.
      • mergeTolerance

        double mergeTolerance
        

        Bus station merge margin.

        If multiple sites of the same name are relatively close, and the distance of these sites is within the bounds of a given site, they are merged into the same site during the bus transfer analysis, called the merge site. The default merge site is 100.

      • snapTolerance

        double snapTolerance
        

        Bus station to capture tolerance.

        The bus station capture tolerance is used to determine whether the site is on the line, and if the distance from the site to the line is greater than the capture margin, it is considered not the site on the line. The default is 50.

      • walkingTolerance

        double walkingTolerance
        
        The walking threshold, the default value is 1000.
      • unit

        Unit unit
        
        Site snap tolerance, site merge tolerances and walk threshold units, the default value is meter.
  • Class com.supermap.services.providers.TransferLineSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceName

        java.lang.String datasourceName
        

        The datasource name.

      • datasetName

        java.lang.String datasetName
        

        Dataset name.

      • aliasField

        java.lang.String aliasField
        
        Bus line alias field.
      • lengthField

        java.lang.String lengthField
        
        The length field of the bus line in the bus line dataset, and the unit of the specified field is meters. If not specified, the system field "Length" is used by default.
      • lineIDField

        java.lang.String lineIDField
        
        The bus line ID field in the bus line data set, which is a mandatory field.
      • nameField

        java.lang.String nameField
        
        The name field of the bus line, which is a mandatory field.
      • lineTypeField

        java.lang.String lineTypeField
        
        A field that identifies a bus line type.
      • speedField

        java.lang.String speedField
        
        The bus speed field, which is used only to display line information, has no effect on the analysis results.
      • firstTimeField

        java.lang.String firstTimeField
        
        Bus line first bus departure time field, which is set only for the display line information, does not affect the results of the analysis .
      • lastTimeField

        java.lang.String lastTimeField
        
        Bus line last bus departure time field, which is set only for the display line information, does not affect the results of the analysis .
      • intervalField

        java.lang.String intervalField
        
        Bus line departure time interval field, which is set only for the display line information, does not affect the results of the analysis .
  • Class com.supermap.services.providers.TransferNetworkSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceName

        java.lang.String datasourceName
        

        The datasource name.

      • datasetName

        java.lang.String datasetName
        

        Net dataset name.

      • edgeIDField

        java.lang.String edgeIDField
        

        The field name that identifies the network arc ID.

        The default value is "SmEdgeID".

        Can not be modified
      • nodeIDField

        java.lang.String nodeIDField
        

        The field name that identifies the network node ID.

        The default value is “SmNodeID”.

        Can not be modified
      • fromNodeIDField

        java.lang.String fromNodeIDField
        

        Identifies the field name of the arc start node ID.

        The default value is “SmFNode”.

        Can not be modified
      • toNodeIDField

        java.lang.String toNodeIDField
        

        Identifies the field name of the arc stop node ID.

        The default value is “SmTNode”.

        Can not be modified
  • Class com.supermap.services.providers.TransferRelationSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceName

        java.lang.String datasourceName
        

        The datasource name.

      • datasetName

        java.lang.String datasetName
        

        Dataset name.

      • lineIDField

        java.lang.String lineIDField
        
        The line ID field set in the site and line relational data set, which is a mandatory field, and the field type supports 32-bit integers and 64-bit integers.
      • stopIDField

        java.lang.String stopIDField
        
        The site ID field in the site and line relational data set, which is a mandatory field, and the field type supports 32-bit integers and 64-bit integers.
      • serialNumField

        java.lang.String serialNumField
        
        The site-to-line relationship data stores sequence number of the site in the line (that is, the station is the first few points in the line). This field is an integer.
      • datasetNetworkName

        java.lang.String datasetNetworkName
        
        The name of the network dataset is useful when calculating the walking plan. Optional field, if not set, the walk program is a straight line between the two points, it may apear unreasonable program through the river, district, and so on .
      • edgeIDField

        java.lang.String edgeIDField
        
        The radian ID field is valid only if datasetNetwork is not empty.
      • nodeIDField

        java.lang.String nodeIDField
        
        The site ID field is valid only if datasetNetwork is not empty.
      • fNodeIDField

        java.lang.String fNodeIDField
        
        The start radian ID field is valid only if datasetNetwork is not empty.
      • tNodeIDField

        java.lang.String tNodeIDField
        
        The stop radian ID field is valid only if datasetNetwork is not empty.
      • datasetPathName

        java.lang.String datasetPathName
        
        The name of the dataset with the entry and exit
      • exitIDField

        java.lang.String exitIDField
        
        The entry and exit ID of the site and the ingress data set
      • exitNameCField

        java.lang.String exitNameCField
        
        Site and entry and exit data set in the import and export Chinese name
      • exitNamePYField

        java.lang.String exitNamePYField
        
        The entry and exit name of the site and the entry and exit data set
      • stationIDField

        java.lang.String stationIDField
        
        Site ID of site and ingress data set
  • Class com.supermap.services.providers.TransferStopSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceName

        java.lang.String datasourceName
        

        The datasource name.

      • datasetName

        java.lang.String datasetName
        

        Dataset name.

      • aliasField

        java.lang.String aliasField
        

        The bus site alias field, the field type is text type.

      • nameField

        java.lang.String nameField
        
        The name field of the bus line, which is a mandatory field.
      • stopIDField

        java.lang.String stopIDField
        
        The bus site ID field in the bus station data set, is a mandatory field, and the field type supports 32-bit integer and 64-bit integer.
  • Class com.supermap.services.providers.TransportationAnalystSetting extends UGCDatasetConnectionInfo implements Serializable

    • Serialized Fields

      • ruleField

        java.lang.String ruleField
        

        Indicates the field name of the network arc traffic rules.

        Network arc traffic rules can be divided into positive one-way line, reverse one-way line, double line, forbidden line and so on. In the network dataset An arc has a start node and an end node, and from the beginning node to the end node is positive, and vice versa.

        Refer to TransportationAnalystSetting.forwardSingleWayRuleValues for the traffic rule valus corresponding to the forward single way, Refer to TransportationAnalystSetting.backwardSingleWayRuleValues for the traffic rule valus corresponding to the backward sngle way, Refer to TransportationAnalystSetting.twoWayRuleValues for the traffic rule valus corresponding to the two way.

        Can be modified theoretically, but should be modified to the value specified in TransportationAnalystSetting.backwardSingleWayRuleValues, , ,
      • forwardSingleWayRuleValues

        java.lang.String[] forwardSingleWayRuleValues
        

        An array of strings representing the forward single way.

        When the value of the field specified by TransportationAnalystSetting.ruleField is one of them, the arc is the forward single way.

        Network arc traffic rules can be divided into positive one-way line, reverse one-way line, double line, forbidden line and so on. In the network dataset An arc has a start node and an end node, and from the beginning node to the end node is positive, and vice versa.

      • backwardSingleWayRuleValues

        java.lang.String[] backwardSingleWayRuleValues
        

        An array of strings representing the backward single way.

        When the value of the field specified by TransportationAnalystSetting.ruleField is one of them, the arc is the backward single way.

        Network arc traffic rules can be divided into positive one-way line, reverse one-way line, double line, forbidden line and so on. In the network dataset An arc has a start node and an end node, and from the beginning node to the end node is positive, and vice versa.

      • twoWayRuleValues

        java.lang.String[] twoWayRuleValues
        

        An array of strings representing the two way.

        When the value of the field specified by TransportationAnalystSetting.ruleField is one of them, the arc is the two way.

        Network arc traffic rules can be divided into positive one-way line, reverse one-way line, double line, forbidden line and so on. In the network dataset An arc has a start node and an end node, and from the beginning node to the end node is positive, and vice versa. The two way indicates that the traffic rules of the network arc can be reversed either forward or backward.

      • prohibitedWayRuleValues

        java.lang.String[] prohibitedWayRuleValues
        

        Indicates an array of strings representing lines.

        When the value of the field specified by TransportationAnalystSetting.ruleField is one of them, the arc is forbidden line.

        Network arc traffic rules can be divided into positive one-way line, reverse one-way line, double line, forbidden line and so on. Forbidden lines indicate that the arc is prohibited in traffic rules.

      • barrierEdges

        int[] barrierEdges
        

        The obstacle arc ID array identifies which network arcs are the obstacle arcs.

        The arc ID is not necessarily the value of the SmID field, but the value of the field specified by TransportationAnalystSetting.edgeIDField.

      • barrierNodes

        int[] barrierNodes
        

        The obstacle node ID array identifies which network nodes are the obstacle nodes.

        The node ID is not necessarily the value of the SmID field, but the value of the field specified byTransportationAnalystSetting.nodeIDField.

      • edgeIDField

        java.lang.String edgeIDField
        

        The field name that identifies the network arc ID. Once this field is set, it will take effect throughout the analysis.

        The default value is "SmEdgeID".

        Can not be modified
      • edgeNameField

        java.lang.String edgeNameField
        

        The field name that identifies the network arc name.

        Can be modified
      • nodeIDField

        java.lang.String nodeIDField
        

        The field name that identifies the network node ID. The value of this field represents the ID of a node, which takes effect throughout the analysis once set.

        The default value is “SmNodeID”.

        Can not be modified
      • nodeNameField

        java.lang.String nodeNameField
        

        The field name that identifies the network node name.

        Can be modified
      • fromNodeIDField

        java.lang.String fromNodeIDField
        

        Identifies the field name of the arc start node ID.

        The default value is “SmFNode”.

        Can not be modified
      • toNodeIDField

        java.lang.String toNodeIDField
        

        Identifies the field name of the arc stop node ID.

        The default value is “SmTNode”.

        Can not be modified
      • tolerance

        double tolerance
        

        The distance tolerance from the node to the arc.

        In principle, the network analysis can specify any point in the network as a site in the path analysis, The site should be near the network. If this point is not on the network (neither on the arc nor on the node), The network analysis will attribute the site to the network based on the distance tolerance. As shown below, the orange dot represents the network node, blue for the arc, gray point for the site, the red line segment is the distance from the site to the arc AB, and if the distance in the set distance tolerance, the site is attributed to the arc AB.

        Set the appropriate distance tolerance in order to ensure the normal network analysis, and when the specified point within the tolerance range, the point will be attributed to the network, In the network analysis, will take the corresponding arc (such as the above mentioned arc AB) of the starting node and the termination of the node as the site to be calculated respectively, And then take the minimum calculation results.

        The distance tolerance value can be calculated by the following method:

        1. Calculate the smallest circumscribed rectangle that contains all the objects in the network dataset;
        2. Calculate the height and width of the rectangular object;
        3. Take the smaller of the two by dividing by 40 to find the appropriate distance tolerance.

        The default value is 0.01, the unit is the same as the current data set coordinate unit (coordUnit).

      • weightFieldInfos

        WeightFieldInfo[] weightFieldInfos
        

        A set of weight field information,is a necessary parameter.

        Via the weight field information (WeightFieldInfo) You can get the field names that represent the forward and negative weights.

        WeightFieldInfo.backWeightField and WeightFieldInfo.forwardWeightField, theoretically can be modified
      • turnDatasetInfo

        TurnDatasetInfo turnDatasetInfo
        

        Steering table data set.

        , , can not be modified. # weightFields can be modified
      • pathGuideDescriptionLanguage

        java.lang.String pathGuideDescriptionLanguage
        
        Specify the travel guidance language by setting the properties file suffix. If it is set to zh_CN, the program will use com \ supermap \ services \ providers \ UGCTransportationAnalystProviderResource_zh_CN.properties in the text to generate travel guidance information. If it is set to en_US, and you will be the corresponding use com \ supermap \ services \ providers \ UGCTransportationAnalystProviderResource_en_US.properties. If the wrong value is set or not set, the file name without suffix is used, and the system decides which language to use.
      • poolSize

        int poolSize
        

        The maximum number of concurrency allowed for traffic transfer analysis.

        The default value is Runtime.availableProcessors()

      • autoCheckNetwork

        java.lang.Boolean autoCheckNetwork
        

        Whether to automatically check the network dataset

      • directionField

        java.lang.String directionField
        

        Flow field

      • initFacilityAnalyst

        boolean initFacilityAnalyst
        

        Whether to initialize facility network analysis

      • nodeIDFilterField

        java.lang.String nodeIDFilterField
        

        In facility network analysis upstream and downstream key facility lookup, it generates filter fields for default sourceNodeIDs parameters

  • Class com.supermap.services.providers.TransportationCheckUtil.CheckNetworkResult extends java.lang.Object implements Serializable

    • Serialized Fields

      • succeed

        boolean succeed
        
      • errorMessages

        java.util.List<E> errorMessages
        
  • Class com.supermap.services.providers.TurnDatasetInfo extends UGCDatasetConnectionInfo implements Serializable

    • Serialized Fields

      • nodeIDField

        java.lang.String nodeIDField
        

        The field name that represents the destination node ID. The default is "NodeID".

      • fromEdgeIDField

        java.lang.String fromEdgeIDField
        

        Indicates the field name to the start arc ID. The default is "FEdgeID".

      • toEdgeIDField

        java.lang.String toEdgeIDField
        

        The name of the field that represents the end of the arc ID. The default is "TEdgeID".

      • weightFields

        java.lang.String[] weightFields
        

        Indicates an array of field names.

  • Class com.supermap.services.providers.UGCAddressMatchProviderSetting extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.UGCDataProviderSetting extends DataProviderSetting implements Serializable

  • Class com.supermap.services.providers.UGCDatasetConnectionInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • workspaceConnectString

        java.lang.String workspaceConnectString
        

        Workspace connection string. It can be a relative path or an absolute path.

      • workspaceType

        java.lang.String workspaceType
        

        Workspace type, one of the strings SXWU, SXW, SMWU, SMW.

        If the value is not set or not one of the above four values, the file suffix is used to determine. If you can not judge by the suffix name, it is considered SXW type.

      • datasourceName

        java.lang.String datasourceName
        

        The datasource name.

      • datasetName

        java.lang.String datasetName
        

        Dataset name.

  • Class com.supermap.services.providers.UGCMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.UGCMapSetting extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.UGCNetworkAnalyst3DSetting extends UGCDatasetConnectionInfo implements Serializable

    • Serialized Fields

      • barrierEdges

        int[] barrierEdges
        

        ID list of arc obstacles.

      • barrierNodes

        int[] barrierNodes
        

        ID list of node obstacles.

      • directionField

        java.lang.String directionField
        
        The flow field of the 3D network dataset.
      • edgeIDField

        java.lang.String edgeIDField
        

        The 3D network data set the word that identifies the arc ID.

      • fNodeIDfield

        java.lang.String fNodeIDfield
        

        The 3D network data set the word that identifies the start arc ID.

      • tNodeIDField

        java.lang.String tNodeIDField
        
        The 3D network data set the word that identifies the stop arc ID.
      • nodeIDField

        java.lang.String nodeIDField
        
        The 3D network data set the word that identifies the node ID.
      • tolerance

        double tolerance
        

        The distance tolerance from the node to the arc.

      • weightFieldInfo3Ds

        WeightFieldInfo3D[] weightFieldInfo3Ds
        
        Weight field information collection object.
      • autoCheckNetwork

        boolean autoCheckNetwork
        
        Automatically check the validity of network data
  • Class com.supermap.services.providers.UGCPlotProviderSetting extends java.lang.Object implements Serializable

  • Class com.supermap.services.providers.UGCRealspaceProviderSetting extends RealspaceProviderSetting implements Serializable

  • Class com.supermap.services.providers.UGCSpatialAnalyst3DProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • workspaceConnectString

        java.lang.String workspaceConnectString
        

        Workspace connection string.

  • Class com.supermap.services.providers.UGCSpatialAnalystProviderSetting extends java.lang.Object implements Serializable

    • Serialized Fields

      • workspacePath

        java.lang.String workspacePath
        

        The workspace path on the server.

      • datasourceInfos

        java.util.List<E> datasourceInfos
        
      • datasourceNames

        java.lang.String[] datasourceNames
        

        The name of the data source involved in the analysis.

      • tmpDatasourceName

        java.lang.String tmpDatasourceName
        

        Temporary data source name.

  • Class com.supermap.services.providers.UGCV5TileProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • configFile

        java.lang.String configFile
        
        UGCV5 tile profile. The file name with the suffix ".sci" or ".inf".
  • Class com.supermap.services.providers.UnsupportedVersionException extends java.lang.Exception implements Serializable

  • Class com.supermap.services.providers.WFSDataProviderSetting extends DataProviderSetting implements Serializable

  • Class com.supermap.services.providers.WFSServiceException extends java.lang.RuntimeException implements Serializable

  • Class com.supermap.services.providers.WMSMapProviderSetting extends MapProviderSetting implements Serializable

    • Serialized Fields

      • defaultScale

        double defaultScale
        
        Deprecated. 

        Invalid setting item.

  • Class com.supermap.services.providers.WMTSMapLayer extends java.lang.Object implements Serializable

    • Serialized Fields

      • identifier

        java.lang.String identifier
        
        Name
      • format

        java.lang.String format
        
        The default image format used by the current Layer
      • formats

        java.lang.String[] formats
        
        A collection of image formats supported by the current Layer
      • tileMatrixSet

        java.lang.String tileMatrixSet
        
        The current Layer defaults to the scale set used
      • wgs84BoundingBox

        BoundsWithCRS wgs84BoundingBox
        
        Current Layer in the WGS84 coordinate system under the Bounds
      • boundingBoxes

        BoundsWithCRS[] boundingBoxes
        
        Bounds of the current Layer in different coordinate systems
      • tileMatrixSets

        java.lang.String[] tileMatrixSets
        
        The current scale supported by the Layer
      • styles

        java.lang.String[] styles
        
        style.
  • Class com.supermap.services.providers.WMTSMapProviderSetting extends MapProviderSetting implements Serializable

  • Class com.supermap.services.providers.WorkspaceConnectionInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • server

        java.lang.String server
        
        Database server or workspace file path.
      • username

        java.lang.String username
        
        The user name of the database.
      • password

        java.lang.String password
        
        Accesses the workspace to connect to the database or file password.
      • type

        java.lang.String type
        
        The type of workspace.
      • database

        java.lang.String database
        
        The name of the database where the workspace is connected.
      • name

        java.lang.String name
        
        The name of the workspace in the database.
      • driver

        java.lang.String driver
        
        The name of the driver that uses the ODBC connection.
  • Class com.supermap.services.providers.ZXYTilesMapProviderSetting extends MapProviderSetting implements Serializable

Package com.supermap.services.providers.aggregation

  • Class com.supermap.services.providers.aggregation.ServiceInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • type

        java.lang.String type
        

        The endpoint type of the service.

        For example, set the SuperMap Objects provided by the GIS function as an endpoint, you need to set the value of the field "UGC"; To set the WMS service as an endpoint, you need to set the value of the field to "WMS".

      • binding

        java.lang.String binding
        

        Service binding information.

        For example, set the SuperMap Objects provided by the GIS function as an endpoint, in the binding information you need to set here map name, picture output path, Image output site (URL address), etc .; set the WMS service as an endpoint, you need to set the binding information in the WMS service version number, such as "1.1.1".

      • address

        java.lang.String address
        

        Service binding address.

        For example, set the SuperMap Objects provided by the GIS function as an endpoint, you need to set the value of the field for the SuperMap workspace path, For example, "data \\ world.sxw"; set the WMS service as an endpoint, and you need to set the value of the field to the address of the WMS service.

Package com.supermap.services.providers.wfs.convert

Package com.supermap.services.rest

Package com.supermap.services.rest.commontypes

  • Class com.supermap.services.rest.commontypes.BatchGeometryOverlayPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceGeometries

        Geometry[] sourceGeometries
        

        The source geometry object data, that is the geometric object array manipulated .

      • operateGeometries

        Geometry[] operateGeometries
        

        Manipulates geometric object data array.

      • operation

        java.lang.String operation
        

        Overlay mode, the optional value for the clip, erase, identity, intersect, union, update.

  • Class com.supermap.services.rest.commontypes.CalculateMeasurePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceRoute

        Route sourceRoute
        

        Routing object.

      • point

        Point2D point
        

        The specified point object.

      • tolerance

        double tolerance
        

        Tolerance value.

      • isIgnoreGap

        boolean isIgnoreGap
        

        Whether to ignore the distance between child objects.

  • Class com.supermap.services.rest.commontypes.CheckTopoErrorPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasetCompare

        java.lang.String datasetCompare
        

        The reference data set for checking. It is set to null if the topology rule used does not need to reference the dataset.

      • topologyRules

        TopologyRule[] topologyRules
        

        Array of topology rules.

      • validRegion

        Geometry validRegion
        

        If the area is null, the entire topology dataset is checked by default, otherwise the topology of the validateRegion area is checked.

      • preprocess

        boolean preprocess
        

        Whether topology preprocessing of the data set is performed before topology checking.

  • Class com.supermap.services.rest.commontypes.ChildResourceInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • name

        java.lang.String name
        

        ${services_rest_ChildResourceInfo_attribute_name_Title}

        ${services_rest_ChildResourceInfo_attribute_name_Description}

      • resourceType

        ResourceType resourceType
        

        ${services_rest_ChildResourceInfo_attribute_resourceType_Title}

        ${services_rest_ChildResourceInfo_attribute_resourceType_Description}

      • resourceConfigID

        java.lang.String resourceConfigID
        

        ${services_rest_ChildResourceInfo_attribute_resourceConfigID_Title}

        ${services_rest_ChildResourceInfo_attribute_resourceConfigID_Description}

      • path

        java.lang.String path
        

        ${services_rest_ChildResourceInfo_attribute_path_Title}

        ${services_rest_ChildResourceInfo_attribute_path_Description}

      • supportedMediaTypes

        java.lang.String[] supportedMediaTypes
        

        ${services_rest_ChildResourceInfo_attribute_supportedMediaTypes_Title}

        ${services_rest_ChildResourceInfo_attribute_supportedMediaTypes_Description}

  • Class com.supermap.services.rest.commontypes.CostPathLinePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourcePoint

        Point2D sourcePoint
        

        Specified source point.

      • targetPoint

        Point2D targetPoint
        

        Specified target point.

      • smoothMethod

        SmoothMethod smoothMethod
        

        Specified smooth way to smooth the least-cost path.

      • smoothDegree

        int smoothDegree
        

        Specified smoothness. (1 means no smoothing, the higher the number, the higher the smoothness, but the efficiency will be reduced, it is recommended to set the range [1,3])

      • resultSetting

        DataReturnOption resultSetting
        

        Returns value setting parameters, sets whether to return records, whether to create a result data set.

      • maxUpslopeDegree

        double maxUpslopeDegree
        

        The maximum uphill angle when calculating the shortest path between two points (source and target).

      • maxDownslopeDegree

        double maxDownslopeDegree
        

        The maximum downhill angle when calculating the shortest path between two points (source and target).

  • Class com.supermap.services.rest.commontypes.CutFillPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • cutFillType

        CutFillType cutFillType
        

        The types of cut and fill analysis. The default one is doing cut and fill analysis based on result raster data.

      • afterCutFillDataset

        java.lang.String afterCutFillDataset
        

        The result dataset after doing cut and fill analysis is valid if the type is GRID.

      • line3D

        Geometry3D line3D
        

        The route of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.

      • bufferRadius

        double bufferRadius
        

        The buffer radius of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.

      • isRoundHead

        boolean isRoundHead
        

        Whether use a round buffer of the cut and fill route or not. The default value is false. It is valid if the type is LINE3DANDBUFFERRADIUS.

      • region

        Geometry region
        

        The region of cut and fill analysis is valid if the type is REGIONANDALTITUDE.

      • baseAltitude

        double baseAltitude
        

        The specified result eveluation of cut and fill analysis is valid if the type is REGIONANDALTITUDE.

      • resultDataset

        java.lang.String resultDataset
        

        The result dataset of a cut and fill analysis.

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.

      • buildPyramid

        boolean buildPyramid
        

        Whether creating image pyramid or not for the result raster dataset.

      • region3D

        Geometry3D region3D
        

        3D region, valid when cutFillTyoe is REGION3D.

  • Class com.supermap.services.rest.commontypes.DatasetBufferPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • filterQueryParameter

        QueryParameter filterQueryParameter
        

        An attribute filter that filters the point data center point object. Only points that meet the filter criteria are involved in the analysis.

      • bufferAnalystParameter

        BufferAnalystParameter bufferAnalystParameter
        

        Buffer analysis parameters, provide the necessary parameter information for the buffer analysis, sees BufferAnalystParameter.

      • isAttributeRetained

        boolean isAttributeRetained
        

        Whether to retain the attribute field. Whether to retain the field properties of the object for the buffer analysis. This parameter is invalid when the result data set is merged. That is valid when the isUnion parameter is false.

      • isUnion

        boolean isUnion
        

        Whether to merge the result surface object.

      • dataReturnOption

        DataReturnOption dataReturnOption
        

        Returns records.

  • Class com.supermap.services.rest.commontypes.DatasetContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasetInfo

        Named datasetInfo
        

        The dataset information.

        The default value is null.

      • childUriList

        java.util.List<E> childUriList
        

        The list of links that point to child resources of the dataset.

        Child resources of the dataset resource include the feature resource and the field resource.

      • supportAttachments

        boolean supportAttachments
        
        Whether to support the attachment.
      • supportFeatureMetadatas

        boolean supportFeatureMetadatas
        
        Whether the dataset feature supports to get the meta info.
  • Class com.supermap.services.rest.commontypes.DatasetCopyInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • srcDatasetName

        java.lang.String srcDatasetName
        

        Source dataset name.

        The source of the data set.

      • srcDatasourceName

        java.lang.String srcDatasourceName
        

        Source datasource name.

        The source of the source data set.

      • destDatasetName

        java.lang.String destDatasetName
        

        Target dataset name.

        The name of the dataset to be created.

  • Class com.supermap.services.rest.commontypes.DatasetCreateInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasetName

        java.lang.String datasetName
        

        Name of the data set.

      • datasetType

        DatasetType datasetType
        

        Type of the data set.

  • Class com.supermap.services.rest.commontypes.DatasetExtractPostParameter extends PointDatasetExtractPostParameter implements Serializable

    • Serialized Fields

      • zValueFieldName

        java.lang.String zValueFieldName
        

        The field name used to record the third dimension information in the point data set.

        When an contour is extracted, the dot data in the point set is interpolated using the values in the field to obtain the raster dataset (intermediate result), and then the contours are extracted from the raster dataset.

      • resolution

        double resolution
        

        The resolution of the intermediate result (raster dataset).

  • Class com.supermap.services.rest.commontypes.DatasetOverlayPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceDatasetFilter

        QueryParameter sourceDatasetFilter
        

        The operational data set (first dataset) filter condition can be null.

      • sourceDatasetFields

        java.lang.String[] sourceDatasetFields
        

        A collection of field names that need to be reserved in the source dataset.

      • operateDataset

        java.lang.String operateDataset
        

        Operational the data set.

      • operateDatasetFilter

        QueryParameter operateDatasetFilter
        

        The operational data set (second dataset) filter condition can be null.

      • operateDatasetFields

        java.lang.String[] operateDatasetFields
        

        A collection of field names that need to be reserved in the operational dataset.

      • operateRegions

        Geometry[] operateRegions
        

        Operating area. After the operation area is set, and only the objects in the area are analyzed.

      • operation

        java.lang.String operation
        

        Overlay, select one of clip, erase, identity, intersect, union, update, xor.

      • dataReturnOption

        DataReturnOption dataReturnOption
        

        The result return settings.

      • tolerance

        double tolerance
        

        The tolerance of the overlay analysis. After the overlay analysis, if the distance between the two nodes is less than this value, the two nodes are merged.

  • Class com.supermap.services.rest.commontypes.DatasetResourceContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • name

        java.lang.String name
        
        Dataset name.
      • path

        java.lang.String path
        
        Data set resource path
      • datasetInfo

        DatasetInfo datasetInfo
        

        Data set information.

      • childResourceInfos

        java.util.List<E> childResourceInfos
        

        The information of the child resource.

  • Class com.supermap.services.rest.commontypes.DatasetsContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasetCount

        int datasetCount
        

        The size of the dataset collection, that is, the number of datasets that are contained.

        Default is 0.

      • datasetNames

        java.util.List<E> datasetNames
        

        A list of dataset names in the dataset collection.

      • childUriList

        java.util.List<E> childUriList
        

        The list of URIs corresponding to the dataset name, that is, the access path of its child resource (dataset resource).

  • Class com.supermap.services.rest.commontypes.DatasetSpatialQuery3DPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceDatasetFilter

        QueryParameter sourceDatasetFilter
        

        The filter of the operated dataset (the first dataset), which can be null.

      • sourceDatasetFields

        java.lang.String[] sourceDatasetFields
        

        The fields to be retained from the source dataset.

      • operateDataset

        java.lang.String operateDataset
        

        The operate dataset.

      • operateDatasetFilter

        QueryParameter operateDatasetFilter
        

        The filter of the operate dataset (the second dataset), which can be null.

      • operateDatasetFields

        java.lang.String[] operateDatasetFields
        

        The fields to be retained from the operate dataset.

      • operateRegion

        Geometry operateRegion
        

        The range to perform the operation. The analysis will be executed only within the specified region if it is not null.

      • bottomAltitude

        double bottomAltitude
        

        The altitude of the bottom.

      • extendedHeight

        double extendedHeight
        

        The height to be extended.

      • dataReturnOption

        DataReturnOption dataReturnOption
        

        Settings for the returning result.

      • positionMode

        java.lang.String positionMode
        

        Query mode, options: UNKNOWN, IDENTICAL, DISJOINT, INTERSECTS, WITHIN, CONTAINS, INTERSECTSORCANTAINS.

  • Class com.supermap.services.rest.commontypes.DatasetUpdateInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • description

        java.lang.String description
        

        Description of the dataset.

      • prjCoordSys

        PrjCoordSys prjCoordSys
        

        The projection coordinate system of the data set

  • Class com.supermap.services.rest.commontypes.DatasourceContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceInfo

        DatasourceInfo datasourceInfo
        

        Data source information.

      • childUriList

        java.util.List<E> childUriList
        

        The list of sub resource URIs for the atasource resource.

  • Class com.supermap.services.rest.commontypes.DatasourcesContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • datasourceCount

        int datasourceCount
        

        The number of data sources in the data source collection.

        Default is 0.

      • datasourceNames

        java.util.List<E> datasourceNames
        

        A list of data source names in the data source collection.

      • childUriList

        java.util.List<E> childUriList
        

        List of URIs for data source access in the data source collection.

  • Class com.supermap.services.rest.commontypes.DatasourceUpdateInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • description

        java.lang.String description
        

        Description of the data source.

      • coordUnit

        Unit coordUnit
        

        Coordinate units in the data source.

      • distanceUnit

        Unit distanceUnit
        

        The distance unit in the data source.

  • Class com.supermap.services.rest.commontypes.DomainComponentInfo extends java.lang.Object implements Serializable

  • Class com.supermap.services.rest.commontypes.DomainResourceConfig extends ResourceConfig implements Serializable

  • Class com.supermap.services.rest.commontypes.ExtendPluginInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • verifierClasss

        java.util.List<E> verifierClasss
        

        The extended security validator implements the class name collection.

      • resourcesConfigFileNames

        java.util.List<E> resourcesConfigFileNames
        

        Extended resource. The collection of the path (including the name) of the resource configuration file.

      • encodingClasses

        java.util.List<E> encodingClasses
        

        The extended expression generator implements the name collection of the class.

      • decoderClasses

        java.util.List<E> decoderClasses
        

        The extended parameter parser implements a collection of class names.

      • componentName

        java.lang.String componentName
        
        Business component name, each extension module corresponds to a business component.
      • name

        java.lang.String name
        
        The extension, the only sign of an extension.
  • Class com.supermap.services.rest.commontypes.ExtractPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • extractParameter

        ExtractParameter extractParameter
        

        The parameter settings of the contour / isosurface when extracted.

      • resultSetting

        DataReturnOption resultSetting
        

        Returns result of the extracted result setting.

  • Class com.supermap.services.rest.commontypes.FeaturesContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • featureCount

        int featureCount
        

        The number of features in the feature set.

        The number of sub-resources of the features resource.

      • geometryType

        GeometryType geometryType
        

        The geometric type of the feature in the feature set.

      • childUriList

        java.util.List<E> childUriList
        

        The list of sub resource URIs for the features resource.

        The access path for all the elements in the feature set.

      • startIndex

        int startIndex
        

        The starting position of the feature in the feature set.

  • Class com.supermap.services.rest.commontypes.FieldContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • fieldInfo

        FieldInfo fieldInfo
        

        Field information.

      • childUriList

        java.util.List<E> childUriList
        

        Field resource sub-resource URI list, that is, the field of various types of statistical statistical resources of the URI access path.

  • Class com.supermap.services.rest.commontypes.FieldsContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • fieldNames

        java.util.List<E> fieldNames
        

        A list of the names of the fields.

      • childUriList

        java.util.List<E> childUriList
        

        The access path of the field, that is, the URI of the child resource.

  • Class com.supermap.services.rest.commontypes.FloodPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • height

        double height
        

        The height of the submerged height, ie the elevation value of the submerged water level.

      • region

        Geometry region
        

        The valid calculationarea. After specifying this area, only the flooded area is calculated in the area.

  • Class com.supermap.services.rest.commontypes.GenerateSpatialDataPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • routeIDField

        java.lang.String routeIDField
        

        The route identification field used to generate the spatial data in the routing data set.

      • eventTable

        java.lang.String eventTable
        

        The event table name used to generate spatial data.

      • eventRouteIDField

        java.lang.String eventRouteIDField
        

        The route identification field used to generate the event table for the spatial data.

      • measureField

        java.lang.String measureField
        

        The scale field of the event table used to generate the spatial data is meaningful only if the event is a point event.

      • measureStartField

        java.lang.String measureStartField
        

        The start scale field of the event table used to generate the spatial data is meaningful only if the event is a line event.

      • measureEndField

        java.lang.String measureEndField
        

        The end scale field of the event table used to generate the spatial data is meaningful only if the event is a line event.

      • measureOffsetField

        java.lang.String measureOffsetField
        

        Scale offset field.

      • errorInfoField

        java.lang.String errorInfoField
        

        Error message field, written directly to the original event table, is used to describe the error message of the event failed to generate the corresponding point or line.

      • retainedFields

        java.lang.String[] retainedFields
        

        The set of fields to be retained in the result spatial data (except for the system fields). Note that when generating spatial data, whether to specify a reserved field, a route ID field, a scale offset field, a scale value field (point event for the tick field, line event is the start and end scale fields) are retained in the result space data ; Returns the all user fields if the retainFields parameter is not specified or the retainFields parameter array length is 0.

        Since:
        7.0.0

      • dataReturnOption

        DataReturnOption dataReturnOption
        

        The result return settings.

  • Class com.supermap.services.rest.commontypes.GeometryBufferPostParameter extends java.lang.Object implements Serializable

  • Class com.supermap.services.rest.commontypes.GeometryExtractPostParameter extends ExtractPostParameter implements Serializable

    • Serialized Fields

      • points

        Point2D[] points
        

        Geographical coordinates.

      • zValues

        double[] zValues
        

        Elevation value.

      • resolution

        double resolution
        

        Resolution.

  • Class com.supermap.services.rest.commontypes.GeometryOverlayPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceGeometry

        Geometry sourceGeometry
        

        The source geometry object data, that is the geometric object manipulated .

      • operateGeometry

        Geometry operateGeometry
        

        Manipulates geometric object data.

      • operation

        java.lang.String operation
        

        Overlay mode, the optional value for the clip, erase, identity, intersect, union, update.

  • Class com.supermap.services.rest.commontypes.GeometrySpatialQuery3DPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceGeometry

        Geometry sourceGeometry
        

        The source geometry, i.e., the geometry to be operated.

      • bottomAltitudeSource

        double bottomAltitudeSource
        
      • extendedHeightSource

        double extendedHeightSource
        
      • operateGeometry

        Geometry operateGeometry
        

        The operate geometry.

      • bottomAltitudeOperate

        double bottomAltitudeOperate
        
      • extendedHeightOperate

        double extendedHeightOperate
        
  • Class com.supermap.services.rest.commontypes.GetFeatureResultContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • featureCount

        int featureCount
        

        The number of elements.

      • totalCount

        int totalCount
        
      • featureUriList

        java.util.List<E> featureUriList
        

        The URI of the feature resource.

      • features

        java.util.List<E> features
        
  • Class com.supermap.services.rest.commontypes.GridDatasetUpdateInfo extends DatasetUpdateInfo implements Serializable

    • Serialized Fields

      • noValue

        double noValue
        

        The raster values for cells that do not have data in the raster dataset.

        The default is 0.

  • Class com.supermap.services.rest.commontypes.GridExpressionPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • expression

        java.lang.String expression
        

        A custom raster operation expression.

      • extractRegion

        Geometry extractRegion
        

        User-specified valid calculation area.

        If it is null, it means that all regions are calculated. If the range of data sets participating in the operation is inconsistent, the intersection of the ranges of all data sets will be used as the calculation area.

      • isZip

        boolean isZip
        

        Whether the result data set is zipped. True means zipped.

      • ignoreNoValue

        boolean ignoreNoValue
        

        whether to ignore the valueless grid data. true means that no value data is ignored, that is, no value grid does not participate in the operation.

      • targetDatasource

        java.lang.String targetDatasource
        

        Specified data source of the stored result dataset.

      • resultGridName

        java.lang.String resultGridName
        

        Specified result dataset.

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.

  • Class com.supermap.services.rest.commontypes.ImageDatasetUpdateInfo extends DatasetUpdateInfo implements Serializable

    • Serialized Fields

      • palette

        java.util.List<E> palette
        

        The color palette of the image data.

  • Class com.supermap.services.rest.commontypes.InterpolationDensityPostParameter extends InterpolationPostParameter implements Serializable

  • Class com.supermap.services.rest.commontypes.InterpolationIDWPostParameter extends InterpolationPostParameter implements Serializable

    • Serialized Fields

      • power

        int power
        
        Distance power calculation, the default value is 2.
  • Class com.supermap.services.rest.commontypes.InterpolationKrigingPostParameter extends InterpolationPostParameter implements Serializable

    • Serialized Fields

      • angle

        double angle
        
        Angle of rotation in Kelujin algorithm.
      • exponent

        Exponent exponent
        
        The order of the trend plane equation in the sample data for interpolation is the default value of exp1.
      • mean

        double mean
        
        The sum of the interpolation field, that is, the sum of the interpolation point field values divided by the number of sampling points.
      • nugget

        double nugget
        
        Block gold effect value.
      • range

        double range
        
        Autocorrelation threshold.
      • sill

        double sill
        
        Base station value.
      • variogramMode

        VariogramMode variogramMode
        
        Kriging (Kriging) interpolation when the semi-variable function type, the default value is SPHERICAL.
      • type

        InterpolationAlgorithmType type
        
        The type of interpolation algorithm, the default value is KRIGING.
  • Class com.supermap.services.rest.commontypes.InterpolationPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • filterQueryParameter

        QueryParameter filterQueryParameter
        
        Data set filter.
      • zValueFieldName

        java.lang.String zValueFieldName
        
        The field name that stores the value for the interpolation analysis, and the interpolation analysis does not support the field of the text type
      • zValueScale

        double zValueScale
        
        The scaling ratio used to perform the interpolation analysis.
      • outputDatasourceName

        java.lang.String outputDatasourceName
        
        The data source used to store the resulting data set.
      • outputDatasetName

        java.lang.String outputDatasetName
        
        Specifies the name of the resulting dataset.
      • pixelFormat

        PixelFormat pixelFormat
        
        Specifies the pixel format in which the resulting raster dataset is stored, and the interpolation analysis does not support the BIT64 pixel format.
      • bounds

        Rectangle2D bounds
        
        The range of interpolation analysis, is used to determine the scope of the results of the operation.
      • resolution

        double resolution
        
        The resolution used when interpolating the operation.
      • searchMode

        SearchMode searchMode
        
        When interpolating operations, look for ways to participate in arithmetic points.
      • searchRadius

        double searchRadius
        
        The search range of participating calculation point.
      • expectedCount

        int expectedCount
        
        The number of points to be searched.
      • maxPointCountForInterpolation

        int maxPointCountForInterpolation
        
        When the block is found, the maximum number of points involved in the interpolation.
      • maxPointCountInNode

        int maxPointCountInNode
        
        When a block is found, the maximum number of points is found in a single block.
      • inputPoints

        Point3D[] inputPoints
        
        The discrete point coordinates (including the Z value) for interpolation analysis, and interpolation analysis directly by discrete points do not need to specify zValueFieldName
      • clipParam

        ClipParameter clipParam
        
        The parameters of the interpolation analysis which are cut
  • Class com.supermap.services.rest.commontypes.InterpolationRBFPostParameter extends InterpolationPostParameter implements Serializable

    • Serialized Fields

      • smooth

        double smooth
        
        Smoothing coefficient, the range of 0 to 1, the default value of 0.100000001490116.
      • tension

        double tension
        
        Tension coefficient, the default value is 40.0.
  • Class com.supermap.services.rest.commontypes.KernelDensityAnalystPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • bounds

        Rectangle2D bounds
        
        The range of density analysis, it is the range of raster datasets which is used to determine the results of the run.
      • resultGridDatasetResolution

        double resultGridDatasetResolution
        
        The resolution of density analysis results raster data.
      • searchRadius

        double searchRadius
        
        The radius of the search used to calculate the density in the grid neighborhood.
      • fieldName

        java.lang.String fieldName
        
        The field name of the measured value used to perform the density analysis. Density analysis does not support fields for text types.
      • targetDatasource

        java.lang.String targetDatasource
        
        Specified data source of the stored result dataset.
      • resultGridName

        java.lang.String resultGridName
        
        Specified result dataset.
      • deleteExistResultDataset

        boolean deleteExistResultDataset
        
        Whether to delete an existing result dataset.
  • Class com.supermap.services.rest.commontypes.MapContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • minScale

        double minScale
        

        ${services_rest_commontypes_MapContent_attribute_minScale_Title}

        ${services_rest_commontypes_MapContent_attribute_minScale_Description}

      • scale

        double scale
        

        ${services_rest_commontypes_MapContent_attribute_mapScale_Title}

        ${services_rest_commontypes_MapContent_attribute_mapScale_Description}

      • maxScale

        double maxScale
        

        ${services_rest_commontypes_MapContent_attribute_maxScale_Title}

        ${services_rest_commontypes_MapContent_attribute_maxScale_Description}

      • name

        java.lang.String name
        

        ${services_rest_commontypes_MapContent_attribute_mapName_Title}

        ${services_rest_commontypes_MapContent_attribute_mapName_Description}

      • center

        Point2D center
        

        ${services_rest_commontypes_MapContent_attribute_center_Title}

        ${services_rest_commontypes_MapContent_attribute_center_Description}

      • bounds

        Rectangle2D bounds
        

        ${services_rest_commontypes_MapContent_attribute_mapBounds_Title}

        ${services_rest_commontypes_MapContent_attribute_mapBounds_Description}

      • viewBounds

        Rectangle2D viewBounds
        

        ${services_rest_commontypes_MapContent_attribute_viewBounds_Title}

        ${services_rest_commontypes_MapContent_attribute_viewBounds_Description}

      • viewer

        Rectangle viewer
        

        ${services_rest_commontypes_MapContent_attribute_viewer_Title}

        ${services_rest_commontypes_MapContent_attribute_viewer_Description}

      • prjCoordSys

        PrjCoordSys prjCoordSys
        

        ${services_rest_commontypes_MapContent_attribute_projectionCoordSystem_Title}

        ${services_rest_commontypes_MapContent_attribute_projectionCoordSystem_Description}

      • dynamicPrjCoordSyses

        java.util.List<E> dynamicPrjCoordSyses
        
      • cacheEnabled

        boolean cacheEnabled
        

        ${services_rest_commontypes_MapContent_attribute_isCacheEnabled_Title}

        ${services_rest_commontypes_MapContent_attribute_isCacheEnabled_Description}

      • customParams

        java.lang.String customParams
        

        ${services_rest_commontypes_MapContent_attribute_customParams_Title}

        ${services_rest_commontypes_MapContent_attribute_customParams_Description}

      • userToken

        UserInfo userToken
        

        ${services_rest_commontypes_MapContent_attribute_userToken_Title}

        ${services_rest_commontypes_MapContent_attribute_userToken_Description}

      • clipRegion

        Geometry clipRegion
        

        ${services_rest_commontypes_MapContent_attribute_clipRegion_Title}

        ${services_rest_commontypes_MapContent_attribute_clipRegion_Description}

      • clipRegionEnabled

        boolean clipRegionEnabled
        

        ${services_rest_commontypes_MapContent_attribute_clipRegionEnabled_Title}

        ${services_rest_commontypes_MapContent_attribute_clipRegionEnabled_Description}

      • customEntireBounds

        Rectangle2D customEntireBounds
        

        ${services_rest_commontypes_MapContent_attribute_customBounds_Title}

        ${services_rest_commontypes_MapContent_attribute_customBounds_Description}

      • customEntireBoundsEnabled

        boolean customEntireBoundsEnabled
        

        ${services_rest_commontypes_MapContent_attribute_customBoundsEnabled_Title}

        ${services_rest_commontypes_MapContent_attribute_customBoundsEnabled_Description}

      • angle

        double angle
        

        ${services_rest_commontypes_MapContent_attribute_angle_Title}

        ${services_rest_commontypes_MapContent_attribute_angle_Description}

      • antialias

        boolean antialias
        

        ${services_rest_commontypes_MapContent_attribute_antialias_Title}

        ${services_rest_commontypes_MapContent_attribute_antialias_Description}

      • backgroundStyle

        Style backgroundStyle
        

        ${services_rest_commontypes_MapContent_attribute_backgroundStyle_Title}

        ${services_rest_commontypes_MapContent_attribute_backgroundStyle_Description}

      • colorMode

        MapColorMode colorMode
        

        ${services_rest_commontypes_MapContent_attribute_mapColorMode_Title}

        ${services_rest_commontypes_MapContent_attribute_mapColorMode_Description}

      • coordUnit

        Unit coordUnit
        

        ${services_rest_commontypes_MapContent_attribute_coordUnit_Title}

        ${services_rest_commontypes_MapContent_attribute_coordUnit_Description}

      • distanceUnit

        Unit distanceUnit
        

        ${services_rest_commontypes_MapContent_attribute_distanceUnit_Title}

        ${services_rest_commontypes_MapContent_attribute_distanceUnit_Description}

      • description

        java.lang.String description
        

        ${services_rest_commontypes_MapContent_attribute_description_Title}

        ${services_rest_commontypes_MapContent_attribute_description_Description}

      • dynamicProjection

        boolean dynamicProjection
        

        ${services_rest_commontypes_MapContent_attribute_dynamicProjection_Title}

        ${services_rest_commontypes_MapContent_attribute_dynamicProjection_Description}

      • markerAngleFixed

        boolean markerAngleFixed
        

        ${services_rest_commontypes_MapContent_attribute_markerAngleFixed_Title}

        ${services_rest_commontypes_MapContent_attribute_markerAngleFixed_Description}

      • maxVisibleTextSize

        double maxVisibleTextSize
        

        ${services_rest_commontypes_MapContent_attribute_maxVisibleTextSize_Title}

        ${services_rest_commontypes_MapContent_attribute_maxVisibleTextSize_Description}

      • maxVisibleVertex

        int maxVisibleVertex
        

        ${services_rest_commontypes_MapContent_attribute_maxVisibleVertex_Title}

        ${services_rest_commontypes_MapContent_attribute_maxVisibleVertex_Description}

      • minVisibleTextSize

        double minVisibleTextSize
        

        ${services_rest_commontypes_MapContent_attribute_minVisibleTextSize_Title}

        ${services_rest_commontypes_MapContent_attribute_minVisibleTextSize_Description}

      • overlapDisplayed

        boolean overlapDisplayed
        

        ${services_rest_commontypes_MapContent_attribute_overlapDisplayed_Title}

        ${services_rest_commontypes_MapContent_attribute_overlapDisplayed_Description}

      • overlapDisplayedOptions

        OverlapDisplayedOptions overlapDisplayedOptions
        

        The map's gland filtering display option is valid when MapContent.overlapDisplayed is false.

      • paintBackground

        boolean paintBackground
        

        ${services_rest_commontypes_MapContent_attribute_paintBackground_Title}

        ${services_rest_commontypes_MapContent_attribute_paintBackground_Description}

      • textAngleFixed

        boolean textAngleFixed
        

        ${services_rest_commontypes_MapContent_attribute_textAngleFixed_Title}

        ${services_rest_commontypes_MapContent_attribute_textAngleFixed_Description}

      • textOrientationFixed

        boolean textOrientationFixed
        

        ${services_rest_commontypes_MapContent_attribute_textOrientationFixed_Title}

        ${services_rest_commontypes_MapContent_attribute_textOrientationFixed_Description}

      • visibleScales

        double[] visibleScales
        

        Returns the visible scale array of the map.

      • visibleScalesEnabled

        boolean visibleScalesEnabled
        
        Returns whether or not to use a fixed scale to display the map.
      • autoAvoidEffectEnabled

        boolean autoAvoidEffectEnabled
        

        Whether to enable automatic avoidance effect.

  • Class com.supermap.services.rest.commontypes.MediaTypeMappingInfo extends java.lang.Object implements Serializable

  • Class com.supermap.services.rest.commontypes.MQFeatureContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • messageID

        java.lang.String messageID
        

        Message id

      • messageStatus

        MQMessageStatus messageStatus
        

        Message status.

      • commitTime

        java.lang.String commitTime
        

        Message submission time. If the message has been submitted to indicate the time at which the message was submitted. If the message is not submitted, the time the message will be submitted.

  • Class com.supermap.services.rest.commontypes.MQFeaturesContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • mqFeatureCount

        int mqFeatureCount
        

        The number of features in the message queue feature collection.

        The number of sub-resources of the MQfeatures resource.

      • childUriList

        java.util.List<E> childUriList
        

        The list of sub resource URIs for the MQfeatures resource.

        The access path for all features in the message queue feature collection.

  • Class com.supermap.services.rest.commontypes.PhysiognomyPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • extractRegion

        Geometry extractRegion
        

        Generates a geomorphic area

      • targetDatasource

        java.lang.String targetDatasource
        

        Target data source.

      • resultGridName

        java.lang.String resultGridName
        

        Target data set.

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        Whether to delete an existing dataset of the same name

  • Class com.supermap.services.rest.commontypes.PlumbProfilePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • startPoint

        Point2D startPoint
        
        Specifies the starting point of the cutting line.
      • endPoint

        Point2D endPoint
        
        Specified ending point of the cutting line
      • modelDatasets

        java.lang.String[] modelDatasets
        
      • surfaceGrid

        java.lang.String surfaceGrid
        
      • returnDatasetOrRecordset

        boolean returnDatasetOrRecordset
        
        Return dataset, or record set flag.
  • Class com.supermap.services.rest.commontypes.PointDatasetExtractPostParameter extends ExtractPostParameter implements Serializable

    • Serialized Fields

      • filterQueryParameter

        QueryParameter filterQueryParameter
        

        Filtering parameters for filtering points, only the points that meet the criteria can be used to make the difference.

  • Class com.supermap.services.rest.commontypes.ProfilePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • lineDataset

        java.lang.String lineDataset
        

        The dataset for a given profile analysis must be a line dataset

      • line

        Geometry line
        

        Line segment or polyline for profiling.

      • resampleTolerance

        double resampleTolerance
        

        Specified resampling tolerance.

  • Class com.supermap.services.rest.commontypes.ProximityAnalystMinDistancePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • inputGeometries

        Geometry[] inputGeometries
        
        Specifies the set of geometric objects to be calculated, currently only supports 2D point objects
      • inputFilterQueryParameter

        QueryParameter inputFilterQueryParameter
        
        Optional parameters for filtering elements in a dataset
      • referenceDatasetName

        java.lang.String referenceDatasetName
        
        Refer to the name of the dataset where the feature set is located (either a 2D point, a line, a face dataset, or a 2D network dataset)
      • referenceFilterQueryParameter

        QueryParameter referenceFilterQueryParameter
        
        Optional parameters that filter the elements in the reference dataset the default to null when not set , that is, all the elements in the reference dataset are evaluated as reference elements When not null, only the elements that meet the filter criteria are evaluated.
      • createResultDataset

        boolean createResultDataset
        
        Whether to create a result dataset. When true, you must specify the correct result dataset name and the resulting data source name.
      • resultDatasetName

        java.lang.String resultDatasetName
        
        Result dataset name.
      • resultDatasourceName

        java.lang.String resultDatasourceName
        
        The data source name of the resulting data set.
      • minDistance

        double minDistance
        
        Specifies the minimum distance of the query range
      • maxDistance

        double maxDistance
        
        Specifies the maximum distance of the query range
  • Class com.supermap.services.rest.commontypes.ProximityAnalystPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • clipRegion

        Geometry clipRegion
        
        Result data crop area, which can be null, indicates that the results are not cropped
      • createResultDataset

        boolean createResultDataset
        
        Whether to create a result dataset. When true, you must specify the correct result dataset name and the resulting data source name.
      • resultDatasetName

        java.lang.String resultDatasetName
        
        The data source name of the resulting data set.
      • resultDatasourceName

        java.lang.String resultDatasourceName
        
        Result dataset name.
      • filterQueryParameter

        QueryParameter filterQueryParameter
        
        Treats the points in the analysis data set to filter, and it is the optional parameters. the default is null when not set , that is, all points in the dataset for analysis. When not null, only point objects that meet the filter criteria are analyzed.
      • points

        Point2D[] points
        

        Coordinate point string. When use the array of points to be analyzed, it is a required parameter.

      • returnResultRegion

        boolean returnResultRegion
        
        Whether to return an array of result fields.
  • Class com.supermap.services.rest.commontypes.RequestEntityParamInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • indiscerptible

        boolean indiscerptible
        
        Whether the parameter type can be split.
      • fieldMapping

        java.util.Map<K,V> fieldMapping
        
        Each field name and field type of parameter typeis mapped, where the key is the field name and the value is the field type.
  • Class com.supermap.services.rest.commontypes.ResourceConfig extends java.lang.Object implements Serializable

  • Class com.supermap.services.rest.commontypes.ReverseCutFillPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • volume

        double volume
        

        Specify the volume of the fill or digging.

      • isFill

        boolean isFill
        

        Specifies whether to perform a fill calculation. If true is the fill calculation, false means the calculation of the excavation.

      • validRegion

        Geometry validRegion
        

        Specified valid calculation area. When the area is specified, only the area is filled or cut in the area, and if the parameter is empty, it is calculated over the entire raster dataset.

  • Class com.supermap.services.rest.commontypes.RouteLocatorPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • sourceRoute

        Route sourceRoute
        

        Routing object.

      • type

        LocateType type
        

        Route targeting type.

      • measure

        double measure
        

        The M value for the anchor point.

      • offset

        double offset
        

        Fixed point offset.

      • isIgnoreGap

        boolean isIgnoreGap
        

        Whether to ignore the distance between child objects.

      • startMeasure

        double startMeasure
        

        The starting M value of the positioning line.

      • endMeasure

        double endMeasure
        

        The end of the positioning line M value.

      • routeIDField

        java.lang.String routeIDField
        
        Route identification field.
      • routeID

        java.lang.String routeID
        
        Routing object identifier.
  • Class com.supermap.services.rest.commontypes.SpatialAnalyst3DSceneResourceContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • name

        java.lang.String name
        

        3D scene name

      • path

        java.lang.String path
        
        3D analysis of the scene resource path
      • childResourceInfos

        java.util.List<E> childResourceInfos
        

        Sub-data source information.

  • Class com.supermap.services.rest.commontypes.StatisticResult extends java.lang.Object implements Serializable

    • Serialized Fields

      • result

        double result
        

        The value of the statistical result.

      • mode

        StatisticMode mode
        

        Use the field statistics method.

  • Class com.supermap.services.rest.commontypes.SymbolContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • resourceParameter

        ResourceParameter resourceParameter
        

        ${services_rest_commontypes_SymbolContent_attribute_resourceParameter_Title}

        ${services_rest_commontypes_SymbolContent_attribute_resourceParameter_Description}

      • resourceImageUrl

        java.lang.String resourceImageUrl
        

        ${services_rest_commontypes_SymbolContent_attribute_resourceImageUrl_Title}

        ${services_rest_commontypes_SymbolContent_attribute_resourceImageUrl_Description}

  • Class com.supermap.services.rest.commontypes.TerrainAspectPostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • terrainAnalystSetting

        TerrainAnalystSetting terrainAnalystSetting
        

        Terrain analysis environment settings.

      • resultDatasetName

        java.lang.String resultDatasetName
        

        Result dataset name.

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.

  • Class com.supermap.services.rest.commontypes.TerrainCurvaturePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.

      • averageCurvatureName

        java.lang.String averageCurvatureName
        

        Output the name of the average curvature dataset.

      • profileCurvatureName

        java.lang.String profileCurvatureName
        

        Output the name of the profile curvature data set.

      • planCurvatureName

        java.lang.String planCurvatureName
        

        Output the name of the plane curvature data set.

      • zFactor

        double zFactor
        

        Elevation scaling factor.

  • Class com.supermap.services.rest.commontypes.TerrainSlopePostParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • terrainAnalystSetting

        TerrainAnalystSetting terrainAnalystSetting
        

        Terrain analysis environment settings.

      • resultDatasetName

        java.lang.String resultDatasetName
        

        Result dataset name.

      • deleteExistResultDataset

        boolean deleteExistResultDataset
        

        If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.

      • slopeType

        SlopeType slopeType
        

        Result of the unit type of the slope.

      • zFactor

        double zFactor
        

        Elevation scaling factor.

  • Class com.supermap.services.rest.commontypes.TrafficNetworkResourceContent extends java.lang.Object implements Serializable

    • Serialized Fields

      • networkName

        java.lang.String networkName
        

        Public transport network name.

      • childResourceInfos

        java.util.List<E> childResourceInfos
        

        Sub-data source information.

  • Class com.supermap.services.rest.commontypes.URLBindingInfo extends java.lang.Object implements Serializable

  • Class com.supermap.services.rest.commontypes.VectorDatasetUpdateInfo extends DatasetUpdateInfo implements Serializable

    • Serialized Fields

      • isFileCache

        boolean isFileCache
        

        Whether to use the file form of the cache.

        File cache can improve the browsing speed, and only for database-based data source is valid.

      • charset

        Charset charset
        

        The character set used by the vector dataset.

        The default is UTF-8.

  • Class com.supermap.services.rest.commontypes.ViewShedPostParameter3D extends java.lang.Object implements Serializable

    • Serialized Fields

      • viewPoint

        Point3D viewPoint
        
      • targetPoint

        Point3D targetPoint
        
      • headingAngle

        double headingAngle
        
      • pitchAngle

        double pitchAngle
        
      • resultDataset

        java.lang.String resultDataset
        
      • deleteExistResultDataset

        boolean deleteExistResultDataset
        
      • buildPyramid

        boolean buildPyramid
        

Package com.supermap.services.rest.management

  • Class com.supermap.services.rest.management.RequestQueryResult extends java.lang.Object implements Serializable

    • Serialized Fields

      • currentCount

        int currentCount
        

        The number of service access records currently returned.

      • totalCount

        int totalCount
        

        Total number of service records.

      • records

        InstanceAccessRecord[] records
        

        Returns the record details for the currently returned service, and the same number as currentCount.

Package com.supermap.services.security

  • Class com.supermap.services.security.RolePermissions extends java.lang.Object implements Serializable

    • Serialized Fields

      • publishEnabled

        boolean publishEnabled
        

        Whether it has administrative rights to a collection of components or components

        Since:
        6.1.3
      • instanceAccessPermissions

        MixedPermissions instanceAccessPermissions
        

        Service access.

        Since:
        6.1.3
      • componentManagerPermissions

        MixedPermissions componentManagerPermissions
        

        Component and component collection management rights.

        Since:
        6.1.3

Package com.supermap.services.util.log

Package com.supermap.services.wcs

Package com.supermap.services.wfs

  • Class com.supermap.services.wfs.DatasetNamespaceConfig extends java.lang.Object implements Serializable

  • Class com.supermap.services.wfs.NamespaceConfig extends java.util.HashMap<java.lang.String,com.supermap.services.wfs.DatasourceNamespaceConfig> implements Serializable

  • Class com.supermap.services.wfs.WFSConfig extends java.lang.Object implements Serializable

    • Serialized Fields

      • namespaceConfig

        NamespaceConfig namespaceConfig
        
        WFS Namespace configuration.
      • maxFeatures

        int maxFeatures
        

        getFeature operation The maximum number of return elements. Defaults is 2000, and if set to 0 or -1, it means that all records are returned by default.

      • version

        java.lang.String version
        

        WFS service version number

        Since:
        7.1.0

Package com.supermap.services.wms

  • Class com.supermap.services.wms.InitException extends java.lang.Exception implements Serializable

  • Class com.supermap.services.wms.SLDConfig extends java.lang.Object implements Serializable

    • Serialized Fields

      • pointStyles

        java.lang.String[] pointStyles
        

        Supported point style collection.

      • lineStyles

        java.lang.String[] lineStyles
        

        Supported line style collection.

      • polygonStyles

        java.lang.String[] polygonStyles
        

        Supported fill style collection.

      • textStyles

        java.lang.String[] textStyles
        

        Supported text style collection.

  • Class com.supermap.services.wms.WMSConfig extends java.lang.Object implements Serializable

    • Serialized Fields

      • mapName

        java.lang.String mapName
        
        Deprecated. 
        Map name.
      • serviceDescription

        ServiceDescription serviceDescription
        
        Service description info.
      • version

        java.lang.String version
        

        The WMS service version. Such as "1.1.1".

      • srs

        java.lang.String[] srs
        
        The specific coordinate system of the WMS interface, when is 1.1.1 it is valid. Optional parameters.
      • crs

        java.lang.String[] crs
        
        The specific coordinate system of the WMS interface, when is 1.3.0 it is valid. Optional parameters.
      • cacheEnabled

        boolean cacheEnabled
        
        Whether the cache is available. True means the response result of the tiles getting operation will be saved to the disk, when there is the same request, it will use the cache images.
      • sld

        SLDConfig sld
        

        Supported style information configuration.

      • useStandardBGColor

        boolean useStandardBGColor
        
        Whether to use the wms standard way to process the default value of the bgcolor parameter.
        If useStandardBGColor is true, in the getMap operation, when the bgcolor parameter is null or not set, set bgcolor to "0xffffff"
        If useStandardBGColor is false, in the getMap operation, when the bgcolor parameter is null or not set, set the bgcolor to the front color of the background style in the default configuration of the map.

Package com.supermap.services.wmts

  • Class com.supermap.services.wmts.LayerMatrixSetMap extends java.lang.Object implements Serializable

    • Serialized Fields

      • layerName

        java.lang.String layerName
        

        The layer name.

      • tileMatrixSetLink

        java.lang.String tileMatrixSetLink
        

        The name of the tile matrix set.

      • title

        java.lang.String title
        

        The caption of the map layer.

  • Class com.supermap.services.wmts.TileMatrix extends java.lang.Object implements Serializable

    • Serialized Fields

      • identifier

        java.lang.String identifier
        

        The tile matrix name.

      • scaleDenominator

        double scaleDenominator
        

        The scale denominator.

        If the scale denominator is 2000, the tile matrix corresponds to a map scale of 1:2000.

      • resolution

        double resolution
        

        Tile matrix resolution.

      • topLeftCorner

        java.lang.String topLeftCorner
        

        the coordinates of the top-left corner.

        Ie the upper left corner of the tile matrix. Format is "x y", there is a space between x and y, with such a string to represent.

      • tileWidth

        int tileWidth
        

        The width of each tile, in pixels. SuperMap iServer currently provides a tile width of 512 pixels.

      • tileHeight

        int tileHeight
        

        The height of each tile, in pixels. SuperMap iServer currently provides a tile height of 512 pixels.

      • matrixWidth

        int matrixWidth
        

        The width of the tile matrix, represented by the number of tiles in the X direction.

      • matrixHeight

        int matrixHeight
        

        The height of the tile matrix, represented by the number of tiles in the Y direction.

  • Class com.supermap.services.wmts.TileMatrixSet extends java.lang.Object implements Serializable

    • Serialized Fields

      • identifier

        java.lang.String identifier
        

        The name of the tile matrix set.

      • supportedCRS

        java.lang.String supportedCRS
        

        Supported coordinate system. Each tile matrix corresponds to 1 supported coordinate system.

      • tileMatrixs

        java.util.List<E> tileMatrixs
        

        The tile matrix list contained in the collection.

      • wellKnownScaleSet

        java.lang.String wellKnownScaleSet
        

        General scale set. Each tile matrix corresponds to 1 or 0 general scale sets.

      • scales

        java.lang.String scales
        

        The scale information of the scale set.

      • dpi

        java.lang.Double dpi
        

        The dpi specified in the WMTS standard is 90.7142857142857, that is, 1 pixel represents 0.28 mm.

      • tileWidth

        java.lang.Integer tileWidth
        

        The width of the tile, the default value is 256.

      • tileHeight

        java.lang.Integer tileHeight
        

        The height of the tile, the default value is 256.

      • matrixList

        java.util.List<E> matrixList
        

        The tile matrix is used to avoid the incorrect number of tiles.

  • Class com.supermap.services.wmts.WMTSConfig extends java.lang.Object implements Serializable

    • Serialized Fields

      • identification

        ServiceIdentification identification
        

        Service description.

      • provider

        ServiceProvider provider
        

        The information of the service provider.

      • customEntireBounds

        java.lang.String customEntireBounds
        

        Configure the full range of the map in WMTS service. It's needed that the range of the WMTS service should be consistent with the base map for some third-party client side such as OpenLayers 2.10 overlaying WMTS service.

      • maps

        java.lang.String maps
        

        The map names which are allowed publishing, multiple map names are separated by comma.

      • tileMatrixSets

        TileMatrixSet[] tileMatrixSets
        

        The set of the all scales supported by WMTS service. If the scale set is null or some of the scale set is null, it uses a 256x256 pixel to represent the full map on level 0; 2x2 256x256 pixels to represent it in level 1, and so on, multiplied by 2 gradually.

      • pixelSizes

        java.lang.String pixelSizes
        
        Deprecated. 

        When it doesn't use general scales, it will configure to use the pixel values of the corresponding customized scale, while multiple values are separated by comma.

      • wellKnownScaleSet

        java.lang.String wellKnownScaleSet
        
        Deprecated. 

        The corresponding general scale set of the tile matrix set.

      • dpi

        java.lang.Double dpi
        
        Deprecated. 

        The dpi specified in the WMTS standard is 90.7142857142857, that is, 1 pixel represents 0.28 mm.

      • tileHeight

        java.lang.Integer tileHeight
        
        Deprecated. 

        The height of the tile, the default value is 256.

      • tileWidth

        java.lang.Integer tileWidth
        
        Deprecated. 

        The width of the tile, the default value is 256.

      • scales

        java.lang.String scales
        
        Deprecated. 

        The scale information of the scale set.

      • verifyMode

        VerifyMode verifyMode
        

        Specify the verification mode

        Since:
        7.1.0
  • Class com.supermap.services.wmts.WMTSFeatureInfo extends java.lang.Object implements Serializable

    • Serialized Fields

      • fieldNames

        java.lang.String[] fieldNames
        

        The attribute field name of the feature.

        is a String array, which corresponds to the WMTSFeatureInfo.fieldValues property, that is, the property field value of the corresponding position in the fieldNames array is the value in the same position of the fieldValues array.

      • fieldValues

        java.lang.String[] fieldValues
        

        The attribute field value of the feature.

        is a String array, which corresponds to the WMTSFeatureInfo.fieldNames property, that is, the property field value of the corresponding position in the fieldNames array is the value in the same position of the fieldValues array.

  • Class com.supermap.services.wmts.WMTSQueryParameter extends java.lang.Object implements Serializable

    • Serialized Fields

      • infoFormat

        java.lang.String infoFormat
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_info_format_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_info_format_Description}

      • bounds

        Rectangle2D bounds
        

        The geographic extent

      • width

        int width
        

        The tile width

      • height

        int height
        

        The tile height

      • featureCount

        int featureCount
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_featureCount_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_featureCount_Description}

      • x

        int x
        

        X of the feature in pixel.

        The leftmost is 0, the right increases.

      • y

        int y
        

        Y of the feature in pixel.

        The top is 0, increasing downward.

      • customParameters

        java.util.Map<K,V> customParameters
        

        ${services_components_spi_ogc_WMSQueryParameter_attribute_customParameters_Title}

        ${services_components_spi_ogc_WMSQueryParameter_attribute_customParameters_Description}

  • Class com.supermap.services.wmts.WMTSServiceException extends java.lang.RuntimeException implements Serializable

Package com.supermap.services.wps