Class: SchemaOrg::GeoCircle

Inherits:
Base
  • Object
show all
Includes:
Mixins::GeoCircle, _GeoCircle
Defined in:
lib/schema_org/types/geo_circle.rb,
sig/schema_org.rbs

Overview

https://schema.org/GeoCircle

A GeoCircle is a GeoShape representing a circular geographic area. As it is a GeoShape it provides the simple textual property 'circle', but also allows the combination of postalCode alongside geoRadius. The center of the circle can be indicated via the 'geoMidpoint' property, or more approximately using 'address', 'postalCode'.

Constant Summary collapse

SCHEMA_NAME =
"GeoCircle"
SCHEMA_TYPES =
[self, SchemaOrg::GeoShape, SchemaOrg::StructuredValue, SchemaOrg::Intangible, SchemaOrg::Thing].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixins::GeoCircle

#geo_midpoint, #geo_midpoint=, #geo_radius, #geo_radius=, schema_property_definitions

Methods included from Mixins::GeoShape

#address, #address=, #address_country, #address_country=, #box, #box=, #circle, #circle=, #elevation, #elevation=, #line, #line=, #polygon, #polygon=, #postal_code, #postal_code=, schema_property_definitions

Methods included from Mixins::StructuredValue

schema_property_definitions

Methods included from Mixins::Intangible

schema_property_definitions

Methods included from Mixins::Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, schema_property_definitions, #subject_of, #subject_of=, #url, #url=

Methods included from _GeoCircle

#additional_type, #additional_type=, #address, #address=, #address_country, #address_country=, #alternate_name, #alternate_name=, #box, #box=, #circle, #circle=, #description, #description=, #disambiguating_description, #disambiguating_description=, #elevation, #elevation=, #geo_midpoint, #geo_midpoint=, #geo_radius, #geo_radius=, #identifier, #identifier=, #image, #image=, #line, #line=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #polygon, #polygon=, #postal_code, #postal_code=, #potential_action, #potential_action=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.new(**properties) ⇒ GeoCircle

Parameters:

Returns:



32
33
34
# File 'lib/schema_org/types/geo_circle.rb', line 32

def new(**properties)
  super
end

.schema_nameString

Returns:

  • (String)


19
20
21
# File 'lib/schema_org/types/geo_circle.rb', line 19

def schema_name
  SCHEMA_NAME
end

.schema_type?(other_type) ⇒ Boolean

Parameters:

  • (Object)

Returns:



27
28
29
30
# File 'lib/schema_org/types/geo_circle.rb', line 27

def schema_type?(other_type)
  Base.schema_type_argument!(other_type)
  SCHEMA_TYPES.include?(other_type)
end

.schema_types::Array[::Class]

Returns:

  • (::Array[::Class])


23
24
25
# File 'lib/schema_org/types/geo_circle.rb', line 23

def schema_types
  SCHEMA_TYPES
end

Instance Method Details

#schema_type?Boolean

Parameters:

  • (Object)

Returns:



51104
# File 'sig/schema_org.rbs', line 51104

def schema_type?: (untyped) -> bool

#schema_types::Array[::Class]

Returns:

  • (::Array[::Class])


51103
# File 'sig/schema_org.rbs', line 51103

def schema_types: () -> ::Array[::Class]