This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.clusterpointstyle [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== ThinkGeo.MapSuite.PortableCore.ClusterPointStyle ====== | ||
- | |||
- | |||
- | |||
- | <!-- Class --> | ||
- | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | ||
- | **[[ThinkGeo.MapSuite.PortableCore.Style]] | ||
- | ***[[ThinkGeo.MapSuite.PortableCore.PointBaseStyle]] | ||
- | ****[[ThinkGeo.MapSuite.PortableCore.PointStyle]] | ||
- | *****[[ThinkGeo.MapSuite.PortableCore.ClusterPointStyle]] | ||
- | ===== Members Summary ===== | ||
- | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClusterPointStyle()|ClusterPointStyle]] | | | | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClusterPointStyle(GeoImage)|ClusterPointStyle]] | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]] | | | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClusterPointStyle(GeoFont, Int32, GeoSolidBrush)|ClusterPointStyle]] | [[ThinkGeo.MapSuite.PortableCore.GeoFont|GeoFont]], Int32, [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]] | | | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClusterPointStyle(PointSymbolType, GeoSolidBrush, Int32)|ClusterPointStyle]] | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]], [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]], Int32 | | | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClusterPointStyle(PointSymbolType, GeoSolidBrush, GeoPen, Int32)|ClusterPointStyle]] | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]], [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]], [[ThinkGeo.MapSuite.PortableCore.GeoPen|GeoPen]], Int32 | | | | ||
- | |||
- | ==== Protected Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | |||
- | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.Feature|Feature]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | This method draws the shapes on the canvas you provided. | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | This method draws a sample feature on the canvas you provided. | | ||
- | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.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}}[[#ToString()|ToString]] | | Object | | | ||
- | |||
- | ==== Protected Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.Feature|Feature]]>, [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Style|Style]](overriden) | | | ||
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.PortableCore.Style|Style]](overriden) | | | ||
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]] | | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.PointStyleAdvanced|PointStyleAdvanced]] | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CellSize|CellSize]] | Int32 | | | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterFont|CharacterFont]] | [[ThinkGeo.MapSuite.PortableCore.GeoFont|GeoFont]] | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the font that is used for the character if the PointType is Character. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterIndex|CharacterIndex]] | Int32 | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CharacterSolidBrush|CharacterSolidBrush]] | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]] | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the SolidBrush used to color the font character for the point. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomPointStyles|CustomPointStyles]] | Collection<[[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]]> | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | 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.PortableCore.DrawingLevel|DrawingLevel]] | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Filters|Filters]] | Collection<String> | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Image|Image]] | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]] | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the image used if the PointType property is NativeImage. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#ImageScale|ImageScale]] | Double | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the scale of the image you want to draw. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | This property gets and sets the active status of the style. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | This property gets and set the name of the style. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#PointType|PointType]] | [[ThinkGeo.MapSuite.PortableCore.PointType|PointType]] | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the type of point you want to draw. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]] | Collection<String> | [[ThinkGeo.MapSuite.PortableCore.Style|Style]] | This property gets the collection of fields that are required for the style. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#RotationAngle|RotationAngle]] | Single | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | This property gets and sets the angle of rotation for the drawing of the point. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolPen|SymbolPen]] | [[ThinkGeo.MapSuite.PortableCore.GeoPen|GeoPen]] | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | This property gets and sets the SolidBrush used to draw the oultine of the Symbol. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolSize|SymbolSize]] | Single | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | This property gets and sets the size of the symbol if the PointType is Symbol. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolSolidBrush|SymbolSolidBrush]] | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]] | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | This property gets and sets the SolidBrush used to color the interior of the Symbol. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SymbolType|SymbolType]] | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]] | [[ThinkGeo.MapSuite.PortableCore.PointStyle|PointStyle]] | This property gets and sets the type of symbol you want to use if the PointType is Symbol. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TextStyle|TextStyle]] | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]] | | | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#XOffsetInPixel|XOffsetInPixel]] | Single | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | This property gets and sets the X pixel offset for drawing each feature. | | ||
- | | {{wiki:PublicProperty.gif|Public Property}}[[#YOffsetInPixel|YOffsetInPixel]] | Single | [[ThinkGeo.MapSuite.PortableCore.PointBaseStyle|PointBaseStyle]] | 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.PortableCore.Style|Style]] | | | ||
- | |||
- | ==== Public Events ==== | ||
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
- | |||
- | ===== Public Constructors ===== | ||
- | ==== ClusterPointStyle() ==== | ||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | |||
- | [[#Public Constructors|Go Back]] | ||
- | ==== ClusterPointStyle(GeoImage) ==== | ||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | image | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> | | | ||
- | |||
- | [[#Public Constructors|Go Back]] | ||
- | ==== ClusterPointStyle(GeoFont, Int32, GeoSolidBrush) ==== | ||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | characterFont | [[ThinkGeo.MapSuite.PortableCore.GeoFont|GeoFont]]<!-- ThinkGeo.MapSuite.PortableCore.GeoFont --> | | | ||
- | | characterIndex | Int32<!-- System.Int32 --> | | | ||
- | | characterSolidBrush | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoSolidBrush --> | | | ||
- | |||
- | [[#Public Constructors|Go Back]] | ||
- | ==== ClusterPointStyle(PointSymbolType, GeoSolidBrush, Int32) ==== | ||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | symbolType | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.PortableCore.PointSymbolType --> | | | ||
- | | symbolSolidBrush | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoSolidBrush --> | | | ||
- | | symbolSize | Int32<!-- System.Int32 --> | | | ||
- | |||
- | [[#Public Constructors|Go Back]] | ||
- | ==== ClusterPointStyle(PointSymbolType, GeoSolidBrush, GeoPen, Int32) ==== | ||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | symbolType | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.PortableCore.PointSymbolType --> | | | ||
- | | symbolSolidBrush | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoSolidBrush --> | | | ||
- | | symbolPen | [[ThinkGeo.MapSuite.PortableCore.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.PortableCore.GeoPen --> | | | ||
- | | symbolSize | Int32<!-- System.Int32 --> | | | ||
- | |||
- | [[#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.PortableCore.Style|Style]]<!-- ThinkGeo.MapSuite.PortableCore.Style --> | A cloned style. | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} --> | This parameter represents the features you want to draw on the canvas. | | ||
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | ||
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | The labels will be drawn in all layers. | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.BaseShape} --> | This parameter represents the shapes you want to draw on the canvas. | | ||
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter represents the canvas you want to draw the shapes on. | | ||
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | ||
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | The labels will be drawn in all layers. | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | ||
- | | drawingExtent | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF --> | | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.Style --> | ||
- | [[#Public Methods|Go Back]] | ||
- | ==== DrawSample(GeoCanvas) ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ Description ^ | ||
- | | Void<!-- System.Void --> | | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.Style --> | ||
- | [[#Public Methods|Go Back]] | ||
- | ==== GetType() ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ Description ^ | ||
- | | Type<!-- System.Type --> | | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | |||
- | <!-- System.Object --> | ||
- | [[#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.PortableCore.Style|Style]]<!-- ThinkGeo.MapSuite.PortableCore.Style --> | A cloned style. | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.Style --> | ||
- | [[#Protected Methods|Go Back]] | ||
- | ==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ Description ^ | ||
- | | Void<!-- System.Void --> | | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | features | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} --> | | | ||
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
- | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | | | ||
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.Style(overriden) --> | ||
- | [[#Protected Methods|Go Back]] | ||
- | ==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ Description ^ | ||
- | | Void<!-- System.Void --> | | | ||
- | |||
- | === Parameters === | ||
- | ^ Name ^ Type ^ Description ^ | ||
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
- | | drawingExtent | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF --> | | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.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 ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.PointStyleAdvanced|PointStyleAdvanced]]<!-- ThinkGeo.MapSuite.PortableCore.PointStyleAdvanced --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CellSize ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Int32<!-- System.Int32 --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.ClusterPointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CharacterFont ==== | ||
- | This property gets and sets the font that is used for the character if the PointType is Character. | ||
- | === Remarks === | ||
- | This property allows you to set the font from which to select a character index if you choose the Character PointType. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.GeoFont|GeoFont]]<!-- ThinkGeo.MapSuite.PortableCore.GeoFont --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CharacterIndex ==== | ||
- | This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property. | ||
- | === Remarks === | ||
- | You need to specify the index position of the character you want to use from the font you selected. For example, if you choose 1, then we will use the first character in the font you set in the CharacterFont property. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Int32<!-- System.Int32 --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CharacterSolidBrush ==== | ||
- | This property gets and sets the SolidBrush used to color the font character for the point. | ||
- | === Remarks === | ||
- | This brush is used to draw the character. It is only used if the PointType is Character. If you need a brush other than the SolidBrush, you should look in the advanced property of the class. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoSolidBrush --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== CustomPointStyles ==== | ||
- | 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 styles on top of each other. When we draw the feature, 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.PortableCore.PointBaseStyle|PointBaseStyle]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.PointBaseStyle} --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== DrawingLevel ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.DrawingLevel|DrawingLevel]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingLevel --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== Filters ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.Style --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== Image ==== | ||
- | This property gets and sets the image used if the PointType property is NativeImage. | ||
- | === Remarks === | ||
- | This property is where you can set the image for the points if the PointType is NativeImage. It uses a GeoImage, so you can either reference a file or supply a stream. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== ImageScale ==== | ||
- | This property gets and sets the scale of the image you want to draw. | ||
- | === Remarks === | ||
- | This property allows you to scale the image up and down depending on how large or small you want it. It can be changed dynamically, so you could change it at every scale level to resize the bitmap based on the current scale. A scale of 1 would be the original size, while a scale of 2 would double the size. A scale of .5 would reduce the size of the image by half, and so on. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Double<!-- System.Double --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#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.PortableCore.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.PortableCore.Style --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== PointType ==== | ||
- | This property gets and sets the type of point you want to draw. | ||
- | === Remarks === | ||
- | When using the PointStyle you choose between a bitmap, a font or a predefined symbol to represent the point. Each of these options has corresponding properties on the point symbol. If you set the type to character, then you need to set the properties that start with "Character," such as "CharacterFont." The same is true for the symbol. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.PointType|PointType]]<!-- ThinkGeo.MapSuite.PortableCore.PointType --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#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.PortableCore.Style --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== RotationAngle ==== | ||
- | This property gets and sets the angle of rotation for the drawing of the point. | ||
- | === Remarks === | ||
- | This property controls the rotation of the bitmap, character or symbol, depending on the PointType. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Single<!-- System.Single --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== SymbolPen ==== | ||
- | This property gets and sets the SolidBrush used to draw the oultine of the Symbol. | ||
- | === Remarks === | ||
- | This pen is used to draw the outline of the Symbol. By default the pen draws a transparent (invisible) color, which just leaves you with a fill. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.PortableCore.GeoPen --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== SymbolSize ==== | ||
- | This property gets and sets the size of the symbol if the PointType is Symbol. | ||
- | === Remarks === | ||
- | The allows you to make the symbol larger and smaller. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Single<!-- System.Single --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== SymbolSolidBrush ==== | ||
- | This property gets and sets the SolidBrush used to color the interior of the Symbol. | ||
- | === Remarks === | ||
- | This brush is used to draw the interior of the symbol. It is only used if the PointType is Symbol. If you need a brush other than the SolidBrush, you should look in the advanced property of the class. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.GeoSolidBrush|GeoSolidBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoSolidBrush --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== SymbolType ==== | ||
- | This property gets and sets the type of symbol you want to use if the PointType is Symbol. | ||
- | === Remarks === | ||
- | You can choose between a number of predefined symbols. The symbols are simple geometric objects that are typically used for abstract representations on a map. If there is a specific symbol you need that is not part of our symbol collection, you can submit it to us and we will consider adding it. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.PointSymbolType|PointSymbolType]]<!-- ThinkGeo.MapSuite.PortableCore.PointSymbolType --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== TextStyle ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.PortableCore.TextStyle --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.ClusterPointStyle --> | ||
- | [[#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 is useful to allow 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 better align it with raster satellite data. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Single<!-- System.Single --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#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 is useful to allow 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 better align it with raster satellite data. | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Single<!-- System.Single --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.PointBaseStyle --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ===== Protected Properties ===== | ||
- | ==== FiltersCore ==== | ||
- | === Return Value === | ||
- | ^ Return Type ^ | ||
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
- | |||
- | <!-- ThinkGeo.MapSuite.PortableCore.Style --> | ||
- | [[#Protected Properties|Go Back]] | ||
- | ===== Public Events ===== | ||
- | __NOTOC__ | ||
- | [[Category:MapSuitePortableCore]] | ||
- | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
- | [[Category:UpdateDocumentation]] | ||
8501 Wade Blvd Ste 550
Frisco, TX 75034
United States
sales@thinkgeo.com
1-785-727-4133
Online Store
- Desktop
WPF
WinForms
- Web
WebAPI HTML5/JavaScript
ASP.NET MVC
WebForms with AJAX
- Mobile
iOS
Android™
World Street
World Imagery
Routing
Geocoding
Reverse Geocoding
Elevation
Quick Start Guides
Documentation
Blogs
Discussion Forums
Customer Portal
About Us
News & Announcemets
Privacy Policy
Copyright 2003-2017 ThinkGeo LLC.
All rights reserved.