====== ThinkGeo.MapSuite.Mvc.LayerOverlay ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Mvc.Overlay ***ThinkGeo.MapSuite.Mvc.LayerOverlay** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} LayerOverlay() ** * //Initialize an instance of the LayerOverlay class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} LayerOverlay(String) ** * //Initialize an instance of the LayerOverlay class with the overlay identifier specified.// == Remarks == * //N/A// == Parameters == * //id// * Type:String * Description:The identifier string used to retrieve the overlay for collection.
** {{wiki:PublicMethod.gif|}} LayerOverlay(String,Boolean,TileType) ** * //Initialize an instance of the LayerOverlay class with the overlay identifier, IsBaseOverlay boolean value and the value indicating whether to use tiling.// == Remarks == * //N/A// == Parameters == * //id// * Type:String * Description:The identifier string used to retrieve the overlay for collection. * //isBaseOverlay// * Type:Boolean * Description:A boolean value that indicates whether this overlay is a base overlay. * //tileType// * Type:[[ThinkGeo.MapSuite.Mvc.TileType|TileType]] * Description:The TileType that indicates whether this overlay uses tiling.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} SetBaseEpsgProjection(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //epsgProjection// * Type:String * Description:A string that represents the projection of the LayerOverlay.
** {{wiki:PublicMethod.gif|}} GetBaseEpsgProjection() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:An EPSG string that indicates the projection of the LayerOverlay. == Parameters ==
** {{wiki:PublicMethod.gif|}} DataBindTo(String,String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //controllerName// * Type:String * Description:N/A * //actionName// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //If you have several layers, with one justified up and to the right and another justified down and to the left, this method will combine all of the current extents to make one composite extent.// == Return Value == * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:The smallest extent that includes all of the features of all layers in the LayerOverlay. == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Object,RectangleShape,GeographyUnit) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:The GeoCanvas object that the layers will draw on. * //nativeImage// * Type:Object * Description:The image object to which all of the layers will be drawn. Usually it is a bitmap. * //canvasExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:The extent in which the features of the layers will be drawn. * //mapUnit// * Type:[[ThinkGeo.MapSuite.GeographyUnit|GeographyUnit]] * Description:The geographic unit that the map will use to draw.
** {{wiki:PublicMethod.gif|}} Redraw() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GenerateCacheImages(ZoomLevel,RectangleShape,GeographyUnit) ** * //N/A// == Remarks == * //This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.// == Return Value == * Type:Void * Description:N/A == Parameters == * //zoomLevel// * Type:[[ThinkGeo.MapSuite.Layers.ZoomLevel|ZoomLevel]] * Description:The zoomlevel at which the images will be generated. * //cacheExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:The extent of the region for which the cached images will be generated. * //mapUnit// * Type:[[ThinkGeo.MapSuite.GeographyUnit|GeographyUnit]] * Description:The unit of map.
** {{wiki:PublicMethod.gif|}} GenerateCacheImages(Double,RectangleShape,GeographyUnit) ** * //N/A// == Remarks == * //This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site.// == Return Value == * Type:Void * Description:N/A == Parameters == * //scale// * Type:Double * Description:The scale that is used to calculate the coordinates of the images. * //cacheExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:The extent of the region for which the cache images will be generated. * //mapUnit// * Type:[[ThinkGeo.MapSuite.GeographyUnit|GeographyUnit]] * Description:The unit of map.
** {{wiki:PublicMethod.gif|}} ToJson() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} FromJson(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //jsonString// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Object,RectangleShape,GeographyUnit) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:The GeoCanvas object that the layers will draw on. * //nativeImage// * Type:Object * Description:The image object to which all of the layers will be drawn. Usually it is a bitmap. * //canvasExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:The extent in which the features of the layers will be drawn. * //mapUnit// * Type:[[ThinkGeo.MapSuite.GeographyUnit|GeographyUnit]] * Description:The geographic unit that the map will use to draw.
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibrary(Page) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //page// * Type:Page * Description:N/A
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //page// * Type:Page * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} TileWidth ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} TileHeight ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} TransitionEffect ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.TransitionEffect|TransitionEffect]] ** {{wiki:PublicProperty.gif|}} TransitionEffectDelayInMilliseconds ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} TileType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.TileType|TileType]] ** {{wiki:PublicProperty.gif|}} TileMargin ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} ServerCache ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.ServerCache|ServerCache]] ** {{wiki:PublicProperty.gif|}} ClientCache ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.ClientCache|ClientCache]] ** {{wiki:PublicProperty.gif|}} WebImageFormat ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.WebImageFormat|WebImageFormat]] ** {{wiki:PublicProperty.gif|}} JpegQuality ** * //N/A// == Remarks == * //The JpegQuality property determines the quality of the JPEG image that is sent to the browser if the WebImageFormat is Jpeg. Setting this property to a lower value will reduce the image filesize. The value must be between 1 - 100. The default is 100.// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} IsMultiThreadDisabled ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Layers ** * //N/A// == Remarks == * //The Layers property holds all of the layers that are used by the Draw method. The Draw method loops through all layers to filter out features and draw with specified styles to the image that will be sent to the browser.// == Return Value == * Type:[[ThinkGeo.MapSuite.GeoCollection[[ThinkGeo.MapSuite.Layers.Layer, ThinkGeo.MapSuite, Version=10.0.0.0, Culture=neutral, PublicKeyToken=0828af5241fb4207]]|GeoCollection]] ** {{wiki:PublicProperty.gif|}} IsVisible ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} WrapDateline ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.WrapDatelineMode|WrapDatelineMode]] ** {{wiki:PublicProperty.gif|}} ActionTriggers ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Mvc.ActionTrigger|ActionTrigger]]> ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Opacity ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Id ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} OnClientAutoRefreshTick ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Attribution ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} OverlayType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} ExtraParameter ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} Projection ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} Binding ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Mvc.ActionBinding|ActionBinding]] ** {{wiki:ProtectedProperty.gif|}} AutoRefreshMilliseconds ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Double ==== Public Events ====