From f47ded9eee5c1a2edc1077a39d5a82cb33bf465f Mon Sep 17 00:00:00 2001 From: Dane Springmeyer Date: Tue, 23 Sep 2014 16:23:48 -0700 Subject: [PATCH] Add docs for raster-colorizer - refs #74 --- 2.3.0/reference.json | 16 ++++++++++++---- latest/reference.json | 16 ++++++++++++---- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/2.3.0/reference.json b/2.3.0/reference.json index f0e336b..1d516b5 100644 --- a/2.3.0/reference.json +++ b/2.3.0/reference.json @@ -1522,24 +1522,32 @@ "linear", "exact" ], - "doc": "TODO" + "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", + "default-value": "linear", + "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", - "doc": "TODO" + "doc": "This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent", + "default-value": "transparent", + "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent" }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", - "doc": "TODO" + "doc": "This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data.", + "default-value": "1.1920928955078125e-07", + "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", - "doc": "TODO" + "doc": "Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`.", + "default-value": "", + "default-meaning": "No colorization will happen without supplying stops." } }, "point": { diff --git a/latest/reference.json b/latest/reference.json index fabdafb..e9a1fd1 100644 --- a/latest/reference.json +++ b/latest/reference.json @@ -1683,24 +1683,32 @@ "linear", "exact" ], - "doc": "TODO" + "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", + "default-value": "linear", + "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", - "doc": "TODO" + "doc": "This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent", + "default-value": "transparent", + "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent" }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", - "doc": "TODO" + "doc": "This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data.", + "default-value": "1.1920928955078125e-07", + "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", - "doc": "TODO" + "doc": "Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`.", + "default-value": "", + "default-meaning": "No colorization will happen without supplying stops." } }, "point": {