thinkgeo.mapsuite.core.areastyle
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.areastyle [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.AreaStyle ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class is used to draw area features. | ||
| - | === Remarks === | ||
| - | You should use this class to draw area features. You can specify a fill brush to draw the interior and an outline pen to draw the border. You can optionally choose to use only the outline pen or the fill brush, which enables you to generate different effects. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.Style]] | ||
| - | ***[[ThinkGeo.MapSuite.Core.AreaStyle]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.HueFamilyAreaStyle]] | ||
| - | ****[[ThinkGeo.MapSuite.Core.QualityFamilyAreaStyle]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AreaStyle()|AreaStyle]] | | | This is the constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AreaStyle(GeoSolidBrush)|AreaStyle]] | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | | This is the constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AreaStyle(GeoPen)|AreaStyle]] | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | | This is the constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AreaStyle(GeoPen, GeoSolidBrush)|AreaStyle]] | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]], [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | | This is the constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AreaStyle(GeoPen, GeoSolidBrush, PenBrushDrawingOrder)|AreaStyle]] | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]], [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]], [[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | | This is the constructor for the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the features on the canvas you provided. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the shapes on the canvas you provided. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws a sample feature on the canvas you provided. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method returns the column data for each feature that is required for the style to properly draw. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Uri)|LoadStyle]] | Uri | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Stream)|LoadStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(String)|SaveStyle]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(Stream)|SaveStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. The default implementation method uses serialization. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|DrawCore]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method draws the features on the canvas you provided. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method draws a sample feature on the canvas you provided. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method returns the column data for each feature that is required for the style to properly draw. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Advanced|Advanced]] | [[ThinkGeo.MapSuite.Core.AreaStyleAdvanced|AreaStyleAdvanced]] | | This property lets you access the advanced properties of the style. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomAreaStyles|CustomAreaStyles]] | Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]> | | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingLevel|DrawingLevel]] | [[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]] | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FillSolidBrush|FillSolidBrush]] | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | | This property gets and sets the solid brush you want to use to fill in the area features. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Filters|Filters]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]] | Boolean | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and sets the active status of the style. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and set the name of the style. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OutlinePen|OutlinePen]] | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]] | | This property gets and sets the outline pen you want to use to outline the features. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PenBrushDrawingOrder|PenBrushDrawingOrder]] | [[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]] | | This property gets and sets the pen and brush drawing order. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets the collection of fields that are required for the style. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#XOffsetInPixel|XOffsetInPixel]] | Single | | This property gets and sets the X pixel offset for drawing each feature. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#YOffsetInPixel|YOffsetInPixel]] | Single | | This property gets and sets the Y pixel offset for drawing each feature. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== AreaStyle() ==== | ||
| - | This is the constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor does not specify an outline pen or fill brush. | ||
| - | === Remarks === | ||
| - | If you use this constructor, you will need to set the properties of the fill brush and outline pen manually. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== AreaStyle(GeoSolidBrush) ==== | ||
| - | This is the constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a fill brush without an outline. | ||
| - | === Remarks === | ||
| - | This constructor allows you to specify just a fill brush. In this way, the area you draw will not have an outline. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | fillSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the solid brush you want to fill the area with. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== AreaStyle(GeoPen) ==== | ||
| - | This is the constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify an outline pen without a filled-in area. | ||
| - | === Remarks === | ||
| - | This constructor allows you to specify just an outline pen. In this way, the area you draw will have an outline, but a transparent interior (no fill). | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outlinePen | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | This parameter is the outline pen you want to use to outline the area. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== AreaStyle(GeoPen, GeoSolidBrush) ==== | ||
| - | This is the constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify an outline pen with a filled-in area. | ||
| - | === Remarks === | ||
| - | This constructor allows you to specify a fill brush and an outline pen. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outlinePen | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | This parameter is the outline pen you want to use to outline the area. | | ||
| - | | fillSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the solid brush you wish to fill the area with. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== AreaStyle(GeoPen, GeoSolidBrush, PenBrushDrawingOrder) ==== | ||
| - | This is the constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify an outline pen with a filled-in area. It also lets you select whether the pen or brush is used first. | ||
| - | === Remarks === | ||
| - | This constructor allows you to specify a fill brush and an outline pen. It also allows you to specify which is drawn first. If the pen is drawn first, the outline will be thinner than if the pen is drawn last. The effect is subtle but noticeable. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | outlinePen | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | This parameter is the outline pen you want to use to outline the area. | | ||
| - | | fillSolidBrush | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | This parameter is the solid brush you wish to fill the area with. | | ||
| - | | penBrushDrawingOrder | [[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]]<!-- ThinkGeo.MapSuite.Core.PenBrushDrawingOrder --> | This parameter allows you to choose whether the outline pen or the fill brush is drawn first. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== CloneDeep() ==== | ||
| - | Create a copy of style using the deep clone process. | ||
| - | === Remarks === | ||
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | This method draws the features on the canvas you provided. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | This method draws the shapes on the canvas you provided. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | shapes | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} --> | This parameter represents the shapes you want to draw on the canvas. | | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the shapes on. | | ||
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== DrawSample(GeoCanvas, DrawingRectangleF) ==== | ||
| - | This method draws a sample feature on the canvas you provided. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
| - | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== DrawSample(GeoCanvas) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetRequiredColumnNames() ==== | ||
| - | This method returns the column data for each feature that is required for the style to properly draw. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. | ||
| - | |||
| - | In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore we read that property and add it to the collection. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadStyle(Uri) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | styleUri | Uri<!-- System.Uri --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadStyle(Stream) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | styleStream | Stream<!-- System.IO.Stream --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== SaveStyle(String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | filePathName | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== SaveStyle(Stream) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | stream | Stream<!-- System.IO.Stream --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== CloneDeepCore() ==== | ||
| - | Create a copy of style using the deep clone process. The default implementation method uses serialization. | ||
| - | === Remarks === | ||
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | This method draws the features on the canvas you provided. | ||
| - | === Remarks === | ||
| - | This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. | ||
| - | |||
| - | When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ==== | ||
| - | This method draws a sample feature on the canvas you provided. | ||
| - | === Remarks === | ||
| - | This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area. | ||
| - | |||
| - | When implementing this virtual method, consider the canvas size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
| - | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetRequiredColumnNamesCore() ==== | ||
| - | This method returns the column data for each feature that is required for the style to properly draw. | ||
| - | === Remarks === | ||
| - | This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. | ||
| - | |||
| - | In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore we read that property and add it to the collection. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Advanced ==== | ||
| - | This property lets you access the advanced properties of the style. | ||
| - | === Remarks === | ||
| - | This property lets you access the advanced properties of the style. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.AreaStyleAdvanced|AreaStyleAdvanced]]<!-- ThinkGeo.MapSuite.Core.AreaStyleAdvanced --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== CustomAreaStyles ==== | ||
| - | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. | ||
| - | === Remarks === | ||
| - | Using this collection, you can stack multiple area styles on top of each other. When we draw the features, we will draw them in order that they exist in the collection. You can use these stacks to create drop shadow effects, multiple colored outlines, etc. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.AreaStyle} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingLevel ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]<!-- ThinkGeo.MapSuite.Core.DrawingLevel --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== FillSolidBrush ==== | ||
| - | This property gets and sets the solid brush you want to use to fill in the area features. | ||
| - | === Remarks === | ||
| - | This solid brush is used to fill in the area features that will draw. You can also optionally specify an outline pen to give the area an outline. The default solid brush has a fill color of transparent, which means it will not draw anything. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.Core.GeoSolidBrush --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Filters ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsActive ==== | ||
| - | This property gets and sets the active status of the style. | ||
| - | === Remarks === | ||
| - | If the style is not active then it will not draw. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Name ==== | ||
| - | This property gets and set the name of the style. | ||
| - | === Remarks === | ||
| - | This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OutlinePen ==== | ||
| - | This property gets and sets the outline pen you want to use to outline the features. | ||
| - | === Remarks === | ||
| - | This outline pen is used to outline the features that will draw. You can also optionally specify a fill brush to give the area a solid fill. The default outline pen color is transparent, which means it will not draw anything. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== PenBrushDrawingOrder ==== | ||
| - | This property gets and sets the pen and brush drawing order. | ||
| - | === Remarks === | ||
| - | This property controls whether the outline pen or the fill brush is drawn first. The default is for the fill brush to be drawn first. If you have the outline pen draw first then the thickness of the pen will be smaller, creating a subtle but noticeable effect. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PenBrushDrawingOrder|PenBrushDrawingOrder]]<!-- ThinkGeo.MapSuite.Core.PenBrushDrawingOrder --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RequiredColumnNames ==== | ||
| - | This property gets the collection of fields that are required for the style. | ||
| - | === Remarks === | ||
| - | This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== XOffsetInPixel ==== | ||
| - | This property gets and sets the X pixel offset for drawing each feature. | ||
| - | === Remarks === | ||
| - | This property allows you to specify an X offset. When combined with a Y offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== YOffsetInPixel ==== | ||
| - | This property gets and sets the Y pixel offset for drawing each feature. | ||
| - | === Remarks === | ||
| - | This property allows you to specify a Y offset. When combined with an X offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.AreaStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== FiltersCore ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.areastyle.1440040127.txt.gz ยท Last modified: 2015/09/17 08:55 (external edit)
