ModelOptions

open_in_new

Settings for what options are enabled on a given model. Most of these options are set at the account level but may be overridden for specific models.

GraphQL Schema definition

  • type ModelOptions {
  • # How much of the address information should be available
  • # if the model is public.
  • addressVisibility: AddressVisibility!
  • # The background color for presentation.
  • backgroundColor: ModelBackgroundColor!
  • # Whether or not visitors to this model can see the dollhouse mode in the showcase
  • # player.
  • dollhouseEnabled: Boolean!
  • dollhouseOverride: SettingOverride!
  • # Whether or not visitors to this model can see labels in dollhouse mode of the
  • # showcase player.
  • dollhouseLabelsEnabled: Boolean!
  • dollhouseLabelsOverride: SettingOverride!
  • # Whether or not visitor to this model can see the highlight reel.
  • highlightReelEnabled: Boolean!
  • highlightReelOverride: SettingOverride!
  • # Whether or not visitors to this model can see floorplan mode in the showcase
  • # player.
  • floorplanEnabled: Boolean!
  • floorplanOverride: SettingOverride!
  • # Whether or not visitors to this model can see labels in the showcase player.
  • labelsEnabled: Boolean!
  • labelsOverride: SettingOverride!
  • # The mode of interaction visitors will have with measurements.
  • measurements: MeasurementsMode!
  • # Whether or not visitors to this model can see the room boundaries in the
  • # Showcase player.
  • roomBoundsEnabled: Boolean!
  • roomBoundsOverride: SettingOverride!
  • # Whether or not social sharing is enabled for this model.
  • # This may be explicit via socialSharingOverride or inherited from the
  • # organization.
  • socialSharingEnabled: Boolean!
  • socialSharingOverride: SettingOverride!
  • # Whether or not the tour will auto play for visitors.
  • tourAutoplayEnabled: Boolean!
  • tourAutoplayOverride: SettingOverride!
  • # Whether or not visitors to this model can playback the tour in the showcase
  • # player.
  • tourButtonsEnabled: Boolean!
  • tourButtonsOverride: SettingOverride!
  • # The units visitors will see measurements in.
  • unitType: Units!
  • # Whether or not vr is enabled for this model.
  • # This may be explicit via vrOverride or inherited from the organization.
  • vrEnabled: Boolean!
  • vrOverride: SettingOverride!
  • # Whether or not this model supports VR views.
  • # If this is `false` then `vrEnabled` will also be false regardless of the
  • # `vrOverride` setting.
  • #
  • # @deprecated v2024.06.20
  • vrSupported: Boolean!
  • }

Require by