| Package | com.esri.bao.tasks.thematicmapping |
| Class | public class ThematicMappingLayer |
| Inheritance | ThematicMappingLayer  TMLayer com.esri.ags.layers.GraphicsLayer |
Default MXML PropertygraphicProvider
| Property | Defined By | ||
|---|---|---|---|
| activeDatasetID : String
Active dataset ID. | ThematicMappingLayer | ||
 | additionalFields : ArrayCollection [read-only]
Additional fields of the thematic layer requested in every query. | TMLayer | |
| analysisExtent : Geometry
Spatial/geographic extent on which to perform the query. | TMLayer | |
| attributesProvider : TMAttributesProvider [read-only]
Provider of thematic mapping attributes. | TMLayer | |
| autoUpdate : Boolean
The mode of applying updates to thematic layer. | TMLayer | |
| bestLayer : IGeographyLayerInfo [read-only]
Geography layer which is best to show for the current map extent. | TMLayer | |
| borderSymbol : SimpleLineSymbol
The symbol to draw borders around features. | TMLayer | |
| canUpdateVisualState : Boolean [read-only]
Returns true if the visual state of this layer can be modified. | TMLayer | |
| colorRamp : ColorRamp
Color Ramp to thematically shade this layer with. | TMLayer | |
| colorRampSchemas : Array [static] [read-only]
Predefined collection of Community Analyst color ramp schemas. | ThematicMappingLayer | ||
| disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | ThematicMappingLayer | ||
| geographyLayer : IGeographyLayerInfo [read-only]
A geography layer whose features are currently shown in this layer. | TMLayer | |
| geographyLevelAliasName : String [read-only]
Alias name of the geography level whose layer is currently shown in this layer. | TMLayer | |
| geographyLevelName : String
Name of the geography level whose layer is currently shown in this layer. | TMLayer | |
| geographyLevels : GeographyLevels [read-only]
Available geography levels. | TMLayer | |
| geographyLevelsFilter : Function [write-only]
Filter for geography levels available in thematic layer. | TMLayer | |
| initializeSummarizations : Boolean
Whether request summarization variables or not while initialization the query task associated with this layer. | ThematicMappingLayer | ||
| intersectAnalysisExtentWithMapExtent : Boolean
Defines how to compose an extent to perform the query when analysis extent is specified. | TMLayer | |
| isReady : Boolean [read-only]
Is true if this layer is ready for show on map. | TMLayer | |
| isUpdating : Boolean [read-only]
Is true if this layer is now updating. | TMLayer | |
| mapExtentDrift : Number
Fraction of linear drift of map extent which is ignored in the auto-update mode. | TMLayer | |
| proxyUrl : String
The URL to proxy the request through. | ThematicMappingLayer | ||
| queryTaskProvider : TMQueryTaskProvider [read-only]
Provider of thematic mapping query task. | TMLayer | |
| requestTimeout : int
The request timeout in seconds. | ThematicMappingLayer | ||
| showMissingValuesAsZeroes : Boolean
Specifies how to convert missing values of attributes with attributes provider: to zeros (true) or to NaN (false). | TMLayer | |
| spatialRelationship : SpatialRelEnum
The spatial selection method used for selection geography layer features in query task. | TMLayer | |
| summarizations : TMSummarizations
Summarization variables available for the current account. | ThematicMappingLayer | ||
| symbolizationProvider : TMSymbolizationProvider
Symbolization provider associated with this thematic layer. | TMLayer | |
| tmValueField : String
Name of the calculated field which will contain a value to render the thematic layer by. | TMLayer | |
| token : String
Token for accessing a secure HTTP client. | ThematicMappingLayer | ||
| tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | ThematicMappingLayer | ||
| url : String
The base URL to the Community Analyst HTTP Service. | ThematicMappingLayer | ||
| valueCalculator : ValueCalculator
Calculator of value to thematically shade this layer by. | TMLayer | |
| where : String
Query WHERE clause. | TMLayer | |
| zIndex : int
The base z-index of features of this layer. | TMLayer | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the ThematicMappingLayer class. | ThematicMappingLayer | ||
| applyUpdates(forceUpdates:Boolean = false):Boolean
Applies updates collected on this layer. | TMLayer | |
| createDescription(graphic:Graphic, descriptionStyle:ValueDescriptionStyle):Object [static]
Creates fields describing value calculation properties for the given graphic feature of a thematic layer. | TMLayer | |
| createDescriptionFields(graphic:Graphic, descriptionStyle:ValueDescriptionStyle):Array [static]
Creates an array of fields describing value calculation properties for the given graphic feature of a thematic layer. | TMLayer | |
| executeQueryTask(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):Boolean
Executes a query for the given geography layer. | TMLayer | |
| getLegendInfos(responder:IResponder = null):AsyncToken [override]
Gets legend infos. | TMLayer | |
| initializeQueryTask(responder:IResponder):Boolean
Initializes the query task associated with this layer. | TMLayer | |
| isGeographyLevelAvailable(name:String):Boolean
Tests the geography level to be available for the current map scale. | TMLayer | |
| prepareQuery():Query
Prepares base query parameters. | TMLayer | |
| suspendUpdates():void
Suspends auto updates for this layer. | TMLayer | |
| updateTooltips():Boolean
Immediately updates graphic tooltips if this is possible. | TMLayer | |
| updateVisualState():Boolean
Immediately updates the visual state of this layer if this is possible. | TMLayer | |
| Method | Defined By | ||
|---|---|---|---|
[override]
Creates the default symbolization provider to be used together with this thematic layer. | ThematicMappingLayer | ||
| activeDatasetID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesactiveDatasetID:StringActive dataset ID. Null value means the default Community Analyst dataset.
The default value is null.
public function get activeDatasetID():String public function set activeDatasetID(value:String):void| colorRampSchemas | property |
colorRampSchemas:Array [read-only] Predefined collection of Community Analyst color ramp schemas.
public static function get colorRampSchemas():Array| disableClientCaching | property |
disableClientCaching:BooleanIf true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from being loaded from the browser's cache.
The default value is false.
public function get disableClientCaching():Boolean public function set disableClientCaching(value:Boolean):void| initializeSummarizations | property |
initializeSummarizations:BooleanWhether request summarization variables or not while initialization the query task associated with this layer.
The default value is true.
public function get initializeSummarizations():Boolean public function set initializeSummarizations(value:Boolean):void| proxyUrl | property |
proxyUrl:StringThe URL to proxy the request through.
public function get proxyUrl():String public function set proxyUrl(value:String):void| requestTimeout | property |
requestTimeout:intThe request timeout in seconds. A value less than or equal to zero prevents request timeout.
The default value is -1.
public function get requestTimeout():int public function set requestTimeout(value:int):void| summarizations | property |
summarizations:TMSummarizationsSummarization variables available for the current account.
Bu default, summarization variables are populated when the query task of this layer is initialized.
You can avoid requesting summarization variables while initialization either
assigning the false value to the initializeSummarizations property or
assigning a custom collection of summarization variables to this property.
public function get summarizations():TMSummarizations public function set summarizations(value:TMSummarizations):void| token | property |
token:StringToken for accessing a secure HTTP client.
public function get token():String public function set token(value:String):void| tokenProvider | property |
tokenProvider:ITokenProviderProvider responsible for updating the security token if the last one expires.
public function get tokenProvider():ITokenProvider public function set tokenProvider(value:ITokenProvider):void| url | property |
url:StringThe base URL to the Community Analyst HTTP Service.
public function get url():String public function set url(value:String):void| ThematicMappingLayer | () | Constructor |
public function ThematicMappingLayer()Creates a new instance of the ThematicMappingLayer class.
| createDefaultSymbolizationProvider | () | method |
override protected function createDefaultSymbolizationProvider():TMSymbolizationProviderCreates the default symbolization provider to be used together with this thematic layer.
The default symbolization provider is associated with a thematic layer if a user doesn't associate its own symbolization provider.
ReturnsTMSymbolizationProvider — A new instance of the TMClassificationProvider class.
|
See also