TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider Interface Reference

Inheritance diagram for TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider:

Public Member Functions
RasterSymbol	GetSymbol (string symbolCode, double scale, SymbolColorScheme symbolColorScheme, bool dropShadow, Color? dropShadowColor, SymbolColorOverride? symbolColorOverride, SortedDictionary< string, string > customParameters)
	General symbol color scheme to use.
string	GetProviderType ()
	Get string describing what kind of symbols the symbol provider generates.
List< string >	GetAvailableSymbols ()
	Create a list of all the symbol codes that can be generated by the provider.
bool	SetCustomErrorSymbol (string symbolCode, double scale)
	Set a custom default error symbol.

Properties
double	BaseSymbolScaling [get]
	The base symbol scale factor to use.

Member Function Documentation

GetAvailableSymbols()

List< string > TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider.GetAvailableSymbols

(

)

Create a list of all the symbol codes that can be generated by the provider.

Returns

Implemented in TPG.GeoFramework.SymbolManagement.CanvasToRasterSymbolProvider, TPG.GeoFramework.SymbolManagement.Providers.BitMapFileSymbolProvider, TPG.GeoFramework.SymbolManagenment.Providers.BitmapUriSymbolProvider, and TPG.GeoFramework.SymbolManagenment.Providers.RasterSymbolPointProvider.

GetProviderType()

string TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider.GetProviderType

(

)

Get string describing what kind of symbols the symbol provider generates.

Returns

Implemented in TPG.GeoFramework.SymbolManagement.CanvasToRasterSymbolProvider, TPG.GeoFramework.SymbolManagement.Providers.BitMapFileSymbolProvider, TPG.GeoFramework.SymbolManagenment.Providers.BitmapUriSymbolProvider, and TPG.GeoFramework.SymbolManagenment.Providers.RasterSymbolPointProvider.

GetSymbol()

RasterSymbol TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider.GetSymbol	(	string	symbolCode,
		double	scale,
		SymbolColorScheme	symbolColorScheme,
		bool	dropShadow,
		Color?	dropShadowColor,
		SymbolColorOverride?	symbolColorOverride,
		SortedDictionary< string, string >	customParameters
	)

General symbol color scheme to use.

Gets the raster symbol that corresponds to the given parameters.

Parameters

symbolCode	The unique code of the symbol.
scale	Scale to use when generating symbol.
symbolColorScheme	Color scheme to use.
dropShadow	Indicates whether the symbol should use drop shadow effect.
dropShadowColor	The color to use for drop shadows.
symbolColorOverride
customParameters	Parameters used by specific renderers, typically extracted from the style of the element to render

Returns

The raster symbol-

Implemented in TPG.GeoFramework.SymbolManagement.CanvasToRasterSymbolProvider, TPG.GeoFramework.SymbolManagement.Providers.BitMapFileSymbolProvider, TPG.GeoFramework.SymbolManagenment.Providers.BitmapUriSymbolProvider, and TPG.GeoFramework.SymbolManagenment.Providers.RasterSymbolPointProvider.

SetCustomErrorSymbol()

bool TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider.SetCustomErrorSymbol	(	string	symbolCode,
		double	scale
	)

Set a custom default error symbol.

Parameters

symbolCode	The unique code of the symbol.
scale	Scale to use when generating symbol.

Returns

Returns true if symbol vas set successfully

Implemented in TPG.GeoFramework.SymbolManagement.CanvasToRasterSymbolProvider, TPG.GeoFramework.SymbolManagement.Providers.BitMapFileSymbolProvider, TPG.GeoFramework.SymbolManagenment.Providers.BitmapUriSymbolProvider, and TPG.GeoFramework.SymbolManagenment.Providers.RasterSymbolPointProvider.

Property Documentation

BaseSymbolScaling

double TPG.GeoFramework.Symbols.Contracts.Providers.IRasterSymbolProvider.BaseSymbolScaling

get

The base symbol scale factor to use.

Implemented in TPG.GeoFramework.SymbolManagement.CanvasToRasterSymbolProvider, TPG.GeoFramework.SymbolManagement.Providers.BitMapFileSymbolProvider, TPG.GeoFramework.SymbolManagenment.Providers.BitmapUriSymbolProvider, and TPG.GeoFramework.SymbolManagenment.Providers.RasterSymbolPointProvider.

---

The documentation for this interface was generated from the following file:

• Src/Layers/Symbol/TPG.GeoFramework.Symbols.Contracts/Providers/IRasterSymbolProvider.cs