gws.common.template

class gws.common.template.TemplateQualityLevel(*args, **kwargs)

Quality level for a template

name = ''

level name

dpi = None

dpi value

class gws.common.template.Config(*args, **kwargs)

dataModel = None

user-editable template attributes

mimeTypes = None

mime types this template can generate

path = None

path to a template file

subject = ''

template purpose

qualityLevels = None

list of quality levels supported by the template

text = ''

template content

title = ''

template title

class gws.common.template.TemplateProps(*args, **kwargs)

class gws.common.template.TemplateOutput(*args, **kwargs)

class gws.common.template.TemplateLegendMode

html = 'html'

image = 'image'

class gws.common.template.FeatureFormatConfig(*args, **kwargs)

Feature format

description = None

template for feature descriptions

category = None

feature category

label = None

feature label on the map

teaser = None

template for feature teasers (short descriptions)

title = None

feature title

class gws.common.template.LayerFormatConfig(*args, **kwargs)

Layer format

description = None

template for the layer description

class gws.common.template.Object

props

configure()

dpi_for_quality(quality)

normalize_context(context: dict) → dict

render(context: dict, mro: gws.types.MapRenderOutput = None, out_path: str = None, legends: dict = None, format: str = None) → gws.types.TemplateOutput

add_headers_and_footers(context: dict, in_path: str, out_path: str, format: str) → str

gws.common.template.from_path(root, path, shared=True)

gws.common.template.from_config(root, cfg, shared: bool = False, parent: gws.types.IObject = None) → gws.types.ITemplate

gws.common.template.bundle(target: gws.types.IObject, configs: List[gws.types.ext.template.Config], defaults: List[gws.types.ext.template.Config] = None) → List[gws.types.ITemplate]

gws.common.template.find(templates: List[gws.types.ITemplate], subject: str = None, category: str = None, mime: str = None) → Optional[gws.types.ITemplate]