| Package | com.esri.baserver.tasks.stdgeographies |
| 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 | |
| classification : Classification Deprecated Since Business Analyst API for Flex 2.1: Please Use com.esri.bacore.thematicmapping.symbolization.TMClassificationProvider.classification
Classification instance responsible for calculation class breaks (this property is deprecated). | ThematicMappingLayer | ||
| colorRamp : ColorRamp
Color Ramp to thematically shade this layer with. | TMLayer | |
| colorRampSchemas : Array [static] [read-only]
Predefined collection of Business Analyst Server color ramp schemas. | ThematicMappingLayer | ||
| dataHierarchy : String
Name of a data hierarchy used for summarization. | 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 | |
| intersectAnalysisExtentWithMapExtent : Boolean
Defines how to compose an extent to perform the query when analysis extent is specified. | TMLayer | |
| isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | ThematicMappingLayer | ||
| 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 | |
| lastClassificationResults : ClassificationResults Deprecated Since Business Analyst API for Flex 2.1: Please Use com.esri.bacore.thematicmapping.symbolization.TMClassificationProvider.lastClassificationResults [read-only]
Last classification results (this property is deprecated). | ThematicMappingLayer | ||
| mapExtentDrift : Number
Fraction of linear drift of map extent which is ignored in the auto-update mode. | TMLayer | |
| numBreaks : int Deprecated Since Business Analyst API for Flex 2.1: Please Use com.esri.bacore.thematicmapping.symbolization.TMClassificationProvider.classification.numBreaks
Number of class breaks (this property is deprecated). | ThematicMappingLayer | ||
| 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 | |
| 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 Business Analyst Server 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 Business Analyst Server dataset which is the first dataset in the dataset list is used.
The default value is null.
public function get activeDatasetID():String public function set activeDatasetID(value:String):void| classification | property |
classification:ClassificationClassification instance responsible for calculation class breaks (this property is deprecated).
The default value is an instance of the TMClassification type.
public function get classification():Classification public function set classification(value:Classification):voidSee also
| colorRampSchemas | property |
colorRampSchemas:Array [read-only] Predefined collection of Business Analyst Server color ramp schemas.
public static function get colorRampSchemas():Array| dataHierarchy | property |
dataHierarchy:String| Since : | Community Analyst API for Flex 2.2. |
Name of a data hierarchy used for summarization. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String public function set dataHierarchy(value:String):voidSee also
| 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| isFullErrorMessage | property |
isFullErrorMessage:BooleanProduce an error message with stack trace (true) or without stack trace (false).
public function get isFullErrorMessage():Boolean public function set isFullErrorMessage(value:Boolean):void| lastClassificationResults | property |
lastClassificationResults:ClassificationResults [read-only] Last classification results (this property is deprecated).
The default value is an empty collection of classification results.
public function get lastClassificationResults():ClassificationResults| numBreaks | property |
numBreaks:intNumber of class breaks (this property is deprecated).
The default value is 5.
public function get numBreaks():int public function set numBreaks(value:int):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| 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 Business Analyst Server 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