RenderinstructionSymbol class

Rendering instruction for bitmap symbols and icons on the map.

This class handles the rendering of bitmap-based symbols such as POI icons, directional arrows, and other graphical elements. Symbols can be defined once with an ID and reused throughout the theme, supporting positioning, rotation, and scaling.

Key features:

  • Reusable symbols with unique identifiers
  • Bitmap scaling and positioning control
  • Rotation support with optional map alignment
  • Support for both node (POI) and way (area) symbols
Inheritance
Implemented types

Constructors

RenderinstructionSymbol(int level)
Creates a new symbol rendering instruction for the specified drawing level.

Properties

bitmapSrc String?
getter/setter pairinherited
boundary ↔ MapRectangle?
The boundary of this object in pixels relative to the center of the corresponding node or way. This is a cache and will be calculated by asking. Do NOT clone this.
getter/setter pairinherited
display MapDisplay
Display mode controlling when this instruction should be rendered.
getter/setter pairinherited
dy double
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
id String?
Unique identifier for this symbol, allowing reuse across the theme.
getter/setter pair
level int
latefinalinherited
positioning MapPositioning
Positioning of the symbol relative to its anchor point.
getter/setter pair
priority int
getter/setter pairinherited
rotateWithMap bool
if false (default) the symbol will always drawn in the same direction regardless of the map rotation. For example an exclamation symbol (!) will always have the dot points towards the bottom of the screen. If true the symbol rotates with the map.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scale ↔ Scale
getter/setter pairinherited
serial int
finalinherited
theta double
Rotation angle of the symbol in radians.
getter/setter pair

Methods

baseSrcMixinClone(BaseSrcMixin base) → void
inherited
baseSrcMixinScale(BaseSrcMixin base, int zoomlevel) → void
inherited
bitmapSrcMixinClone(BitmapSrcMixin base) → void
inherited
bitmapSrcMixinScale(BitmapSrcMixin base, int zoomlevel) → void
inherited
bitmapSrcMixinToString() String
inherited
forZoomlevel(int zoomlevel, int level) RenderinstructionSymbol
Creates a zoom level specific copy of this symbol instruction.
override
getBitmapColor() int
inherited
getBitmapHeight() int
inherited
getBitmapWidth() int
inherited
getBoundary([RenderInfo<Renderinstruction>? renderInfo]) → MapRectangle
Returns the boundary of this object around the center of the area or the poi. If the boundary cannot determined exactly we need to estimate it. This method is used only if the renderinstruction adds itself to label or clash (see LayerContainer)
override
getType() String
Returns the type identifier for this rendering instruction.
override
matchNode(LayerContainer layerContainer, NodeProperties nodeProperties) → void
Checks the nodeProperties and adds itself to the layerContainer if there is something to draw.
override
matchWay(LayerContainer layerContainer, WayProperties wayProperties) → void
Checks the wayProperties and adds itself to the layerContainer if there is something to draw.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parse(XmlElement rootElement) → void
Parses XML attributes to configure this symbol rendering instruction.
renderinstructionScale(Renderinstruction base, int zoomlevel) → void
Scales rendering parameters based on zoom level and base instruction.
inherited
secondPass(SymbolSearcher symbolSearcher) → void
Captions needs to find their assigned symbol to correctly render themself around the symbol. After all rules has been created a second pass is executed where captions are able to find their assigned symbol.
inherited
setBitmapColorFromNumber(int color) → void
inherited
setBitmapHeight(int bitmapHeight) → void
inherited
setBitmapMinZoomLevel(int bitmapMinZoomLevel) → void
inherited
setBitmapPercent(int bitmapPercent) → void
inherited
setBitmapSrc(String bitmapSrc) → void
inherited
setBitmapWidth(int bitmapWidth) → void
inherited
setDy(double value) → void
inherited
setScaleFromValue(String value) → void
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited