Interface: GeopointProperty
Hierarchy
↳
GeopointProperty
Properties
Field
• Optional Field: ComponentType<FieldProps<GeoPoint, any, any>>
If you need to render a custom field, you can create a component that
takes FieldProps as props. You receive the value, a function to
update the value and additional utility props such as if there is an error.
You can customize it by passing custom props that are received
in the component.
Inherited from
Defined in
lib/src/types/properties.ts:145
Preview
• Optional Preview: ComponentType<PropertyPreviewProps<GeoPoint, any, Record<string, any>>>
Configure how a property is displayed as a preview, e.g. in the collection view. You can customize it by passing custom props that are received in the component.
Inherited from
Defined in
lib/src/types/properties.ts:152
columnWidth
• Optional columnWidth: number
Width in pixels of this column in the collection view. If not set the width is inferred based on the other configurations
Inherited from
Defined in
lib/src/types/properties.ts:111
customProps
• Optional customProps: any
Additional props that are passed to the components defined in field
or in preview.
Inherited from
Defined in
lib/src/types/properties.ts:158
dataType
• dataType: "geopoint"
Datatype of the property
Overrides
Defined in
lib/src/types/properties.ts:576
defaultValue
• Optional defaultValue: GeoPoint
This value will be set by default for new entities.
Inherited from
Defined in
lib/src/types/properties.ts:163
description
• Optional description: string
Property description, always displayed under the field
Inherited from
Defined in
lib/src/types/properties.ts:92
disabled
• Optional disabled: boolean | PropertyDisabledConfig
Is this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties (including custom messages, clear value on disabled or hide the field completely)
Inherited from
Defined in
lib/src/types/properties.ts:131
editable
• Optional editable: boolean
Should this property be editable in the collection editor.
If the property has been defined in code, it defaults to false otherwise,
it defaults to true.
Inherited from
Defined in
lib/src/types/properties.ts:170
fieldConfig
• Optional fieldConfig: string
You can use this prop to reuse a property that has been defined
in the top level of the CMS in the prop fields.
All the configuration will be taken from the inherited config, and
overwritten by the current property config.
Inherited from
Defined in
lib/src/types/properties.ts:100
hideFromCollection
• Optional hideFromCollection: boolean
Do not show this property in the collection view
Inherited from
BaseProperty.hideFromCollection
Defined in
lib/src/types/properties.ts:116
longDescription
• Optional longDescription: string
Longer description of a field, displayed under a popover
Inherited from
Defined in
lib/src/types/properties.ts:105
name
• Optional name: string
Property name (e.g. Product)
Inherited from
Defined in
lib/src/types/properties.ts:87
readOnly
• Optional readOnly: boolean
Is this a read only property. When set to true, it gets rendered as a preview.
Inherited from
Defined in
lib/src/types/properties.ts:122
validation
• Optional validation: PropertyValidationSchema
Rules for validating this property