From 0e71717cfc40443717849a94b8c269960c01f45d Mon Sep 17 00:00:00 2001 From: springmeyer Date: Mon, 30 Jul 2012 18:32:27 -0700 Subject: [PATCH] moved deprecated items to the bottom --- API-changes-between-v2.0-and-v2.1.md | 65 ++++++++++++++-------------- 1 file changed, 32 insertions(+), 33 deletions(-) diff --git a/API-changes-between-v2.0-and-v2.1.md b/API-changes-between-v2.0-and-v2.1.md index 5dfc703..9a09845 100644 --- a/API-changes-between-v2.0-and-v2.1.md +++ b/API-changes-between-v2.0-and-v2.1.md @@ -1,3 +1,35 @@ +## Removed + + * `PointDatasource` - Use `MemoryDatasource` instead. PointDatasource was an incomplete wrapper around MemoryDatasource, and is obsolete now that `Feature` objects can leverage WKB and WKT to create geometries and features can be added to MemoryDatasources. + * `GlyphSymbolizer` - functionality can now be achieved with the `TextSymbolizer` + * `MarkersSymbolizer` + * `marker-type` is removed, built in ellipse and arrow types now can be referenced like `file="shape://ellipse"` and `file="shape://arrow"` - although this interface is unstable and may continue to change. + * `ShieldSymbolizer` attribute `no_text` - Simply leave the text empty if you don't want any text to be rendered. + +## Changed + + * `MarkersSymbolizer` + * `width` and `height` are now optional expressions rather than raw floats and their values represent diameter in pixels not radii. If not set they will be `None`, but the default ellipse has a `radius` of `10` meaning that if you set `width="20"` and `height="20"` then there will be no change in the rendering size of the ellipse. The arrow default dimensions can be maintained with `width="27" height="12"`. Altering width or height will scale the marker, but ideally you should use `transform="scale(x,y)" instead. + +## Added + + * `Expression` - you can now use the built in keyword of `[mapnik::geometry_type]` to filter features by geometry type either by name or integer key. The mapping is `0:no geometry`, `1:point`, '2:linestring`, `3:polygon`, and `4:collection`. A collection indicates that the `Feature` has more than one geometry of different types. So a `Feature` with three linestrings will be reported as `linestring` but a `Feature` with a point and a linestring will be reported as a `collection`. - for more details see [#546](https://github.com/mapnik/mapnik/issues/546) + * To All symbolizers (in most cases) + * `comp-op` - All symbolizers now support compositing in the AGG and Cairo renderers + * `clip` - All(most) symbolizers - boolean of whether to clip geometries before rendering (defaults to `true`) + * `smooth` - bezier smooth value - 0-1, 0 (default) means no smoothing, 1 means fully smoothed, higher values create wild loopbacks + * `LineSymbolizer` + * `offset` - offset lines either in positive (right side) or negative (left side) + * [`TextSymbolizer`](https://github.com/mapnik/mapnik/wiki/TextSymbolizer) + * New placement alogrithm: `list` + * Text formatting + + Changes documented in TextSymbolizer documentation + * Python Bindings: + * `mapnik.Image.get_pixel()` - get unsigned int value representing the rgba value, useful for fast pixel comparisons + * `mapnik.Grid.get_pixel()` - get int value representing the feature id encoded in the grid pixels + * bindings for text placement and formatting work + ## Deprecated * `TextSymbolizer` - most attributes moved to either `format` or `placements` properties @@ -43,36 +75,3 @@ * `mode` is deprecated, now use `comp-op` which supports [many more compositing modes](https://github.com/mapnik/mapnik/blob/master/include/mapnik/image_compositing.hpp#L42-79) * `scaling=fast` is deprecated. It has always been a synonym for `near`, use `near` going forward * `scaling` is now exposed in python as enumerations of `mapnik.scaling_method` not as bare strings - -## Removed - - * `PointDatasource` - Use `MemoryDatasource` instead. PointDatasource was an incomplete wrapper around MemoryDatasource, and is obsolete now that `Feature` objects can leverage WKB and WKT to create geometries and features can be added to MemoryDatasources. - * `GlyphSymbolizer` - functionality can now be achieved with the `TextSymbolizer` - * `MarkersSymbolizer` - * `marker-type` is removed, built in ellipse and arrow types now can be referenced like `file="shape://ellipse"` and `file="shape://arrow"` - although this interface is unstable and may continue to change. - * `ShieldSymbolizer` attribute `no_text` - Simply leave the text empty if you don't want any text to be rendered. - -## Changed - - * `MarkersSymbolizer` - * `width` and `height` are now optional expressions rather than raw floats and their values represent diameter in pixels not radii. If not set they will be `None`, but the default ellipse has a `radius` of `10` meaning that if you set `width="20"` and `height="20"` then there will be no change in the rendering size of the ellipse. The arrow default dimensions can be maintained with `width="27" height="12"`. Altering width or height will scale the marker, but ideally you should use `transform="scale(x,y)" instead. - -## Added - - * `Expression` - you can now use the built in keyword of `[mapnik::geometry_type]` to filter features by geometry type either by name or integer key. The mapping is `0:no geometry`, `1:point`, '2:linestring`, `3:polygon`, and `4:collection`. A collection indicates that the `Feature` has more than one geometry of different types. So a `Feature` with three linestrings will be reported as `linestring` but a `Feature` with a point and a linestring will be reported as a `collection`. - for more details see [#546](https://github.com/mapnik/mapnik/issues/546) - * To All symbolizers (in most cases) - * `comp-op` - All symbolizers now support compositing in the AGG and Cairo renderers - * `clip` - All(most) symbolizers - boolean of whether to clip geometries before rendering (defaults to `true`) - * `smooth` - bezier smooth value - 0-1, 0 (default) means no smoothing, 1 means fully smoothed, higher values create wild loopbacks - * `LineSymbolizer` - * `offset` - offset lines either in positive (right side) or negative (left side) - * [`TextSymbolizer`](https://github.com/mapnik/mapnik/wiki/TextSymbolizer) - * New placement alogrithm: `list` - * Text formatting - - Changes documented in TextSymbolizer documentation - * Python Bindings: - * `mapnik.Image.get_pixel()` - get unsigned int value representing the rgba value, useful for fast pixel comparisons - * `mapnik.Grid.get_pixel()` - get int value representing the feature id encoded in the grid pixels - * bindings for text placement and formatting work - \ No newline at end of file