Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend Caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.ColorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

The item descriptions in the created legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend Caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend Caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a Caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.ColorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a Caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a Caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.RasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery::colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

The item descriptions in the created legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery::colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator::rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

The item descriptions in the created legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

The item descriptions in the created legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

The item descriptions in the legend will be generated automatically from the raster attribute table. For each legend item, the description is the concatenation of all attributes that are of type String. The strings will be separated by line breaks. A corresponding legend caption will be generated from the names of the string attributes.

If prependRasterValue is True, the raster value, a colon and a tab will be prepended to each item description; also, the separator between the other strings will then be a line break followed by a tab. Of course, the concrete raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Example:

Let us assume that the DataSetInfo has the following raster attribute table

Since the Height attribute is not a string, it is not used in the auto-generated item descriptions.

If prependRasterValue is True the generated legend would look something like this:

and otherwise just like this:

Legend items where all the string attributes are empty will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The auto-generated item descriptions makes this method convenient to use in an application that can open arbitrary geodata files, for example a general map viewer like Carmenta Explorer. But in an application where the developer has more knowledge of the available data, it may be better to use an overloaded variant where you can supply your own itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and the color table of the DataSetInfo, so the method is appropriate when your configuration does not modify the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and a given color scheme that refers to the table. The method is appropriate when your ReadOperator overrides the native color scheme of the geodata by using a defined ImageQuery.colorFromAttributeTable, which should be reused as the colorFromAttributeTable parameter for this method. The typical case occurs when the raster attribute table is defined in a separate .vat.dbf file and has three columns Red, Green and Blue containing real numbers between 0 and 1, which do not agree with the built-in color scheme of the main geodata files. The colorFromAttributeTable should then be a color attribute variable created from this Expression:

     "rgb(" +
         string(int(255 * Red)) + "," +
         string(int(255 * Green)) + "," +
         string(int(255 * Blue)) + ")"

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.

Remarks

This method creates a legend from the raster attribute table and an explicit raster visualizer, so the method is appropriate when your configuration uses a VisualizationOperator with a raster visualizer to override the built-in color table of the dataset.

Each item description in the legend will be generated by evaluating the itemDescription with the corresponding attribute set in the raster attribute table. So the string attribute variable usually just refers to one attribute. Legend items that would get an empty description will be omitted from the created legend; this is useful especially for some geodata formats where the raster attribute table always must contain 256 rows even when much fewer raster values are used.

The legend will get a caption that is generated from the attribute names in a way that is analogous with how the item descriptions are generated from the attribute values. So if your itemDescription just picks one of the attribute values, the generated caption will be the corresponding attribute name. But you can also use application code to modify the caption afterwards.

If prependRasterValue is True, the raster value will be prepended to each item description, separated by a colon and a tab. The raster value is normally not interesting for an end user of the application, but it can be useful for a developer who needs to manipulate the data. For example, to create a buffer zone around water areas, the raster value that represents water must be assigned to the BufferZoneOperator.rasterValue.

Note that there are overloaded variants of this method for which you do not have to specify any itemDescription parameter.