Schema

Data

class simplekml.Data(name=None, value=None, displayname=None)

Data of extended data used to add custom data to KML Features.

The arguments are the same as the properties.

displayname

The name that is displayed to the user, accepts string.

name

Data name, accepts string.

value

Data value, accepts string.

ExtendedData

class simplekml.ExtendedData

Data of a schema that is used to add custom data to KML Features.

The arguments are the same as the properties.

newdata(name, value, displayname=None)

Creates a new simplekml.Data and attaches it to this schemadata.

Returns an instance of simplekml.Data class.

Args:
  • name: string name of simplefield (required)
  • value: int, float or string for value of field (required)
  • displayname: string for pretty name that will be displayed (default None)
schemadata

Extra data for the feature, accepts simplekml.SchemaData.

GxSimpleArrayData

class simplekml.GxSimpleArrayData(name, values=None)

Data of a simplekml.GxSimpleArrayField.

The arguments are the same as the properties.

name

Name of field, accepts string.

newvalue(value)

Adds a value to the gxsimpledarraydata.

GxSimpleArrayField

class simplekml.GxSimpleArrayField(name=None, type='string', displayname=None)

Custom array field for gx:track, forms part of a schema.

Args:
displayname

Pretty name of field that is shown in google earth, accepts string.

name

Name of field, accepts string.

type

Type of field, accepts string from simplekml.Types constants.

Schema

class simplekml.Schema(name=None)

Custom KML schema that is used to add custom data to KML Features.

The arguments are the same as the properties.

id

Unique id of the schema.

name

Name of schema, accepts string.

newgxsimplearrayfield(name, type, displayname=None)

Creates a new simplekml.GxSimpleArrayField and attaches it to this schema.

Returns an instance of simplekml.GxSimpleArrayField class.

Args:
  • name: string name of simplefield (required)
  • type: string type of field (required)
  • displayname: string for pretty name that will be displayed (default None)
newsimplefield(name, type, displayname=None)

Creates a new simplekml.SimpleField and attaches it to this schema.

Returns an instance of simplekml.SimpleField class.

Args:
  • name: string name of simplefield (required)
  • type: string type of field (required)
  • displayname: string for pretty name that will be displayed (default None)

SchemaData

class simplekml.SchemaData(schemaurl=None)

Data of a schema that is used to add custom data to KML Features.

The arguments are the same as the properties.

newgxsimplearraydata(name, value)

Creates a new simplekml.GxSimpleArrayData and attaches it to this schemadata.

Returns an instance of simplekml.GxSimpleArrayData class.

Args:
  • name: string name of simplefield (required)
  • value: int, float or string for value of field (required)
newsimpledata(name, value)

Creates a new simplekml.SimpleData and attaches it to this schemadata.

Returns an instance of simplekml.SimpleData class.

Args:
  • name: string name of simplefield (required)
  • value: int, float or string for value of field (required)
schemaurl

Schema url, accepts string.

SimpleData

class simplekml.SimpleData(name, value)

Data of a schema.

The arguments are the same as the properties.

name

Name of field, accepts string.

value

Value of field, accepts int, float or string.

SimpleField

class simplekml.SimpleField(name=None, type='string', displayname=None)

Custom field, forms part of a schema.

The arguments are the same as the properties.

displayname

Pretty name of field that is shown in google earth, accepts string.

name

Name of field, accepts string.

type

Type of field, accepts string from simplekml.Types constants.