https://docs-vrgeo-version3.netlify.app/assets/js/7812bb04.9292fd49.js

1"use strict";(globalThis.webpackChunkvrgs_docs_v_3_1=globalThis.webpackChunkvrgs_docs_v_3_1||[]).push([[17655],{48901(e,t,r){r.r(t),r.d(t,{assets:()=>h,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"properties/properties-attributes","title":"Attributes Properties","description":"This page documents the properties available for attributes in VRGS. These properties appear in the Properties panel when an object of this type is selected.","source":"@site/versioned_docs/version-3.3/properties/properties-attributes.md","sourceDirName":"properties","slug":"/properties/properties-attributes","permalink":"/docs/3.3/properties/properties-attributes","draft":false,"unlisted":false,"editUrl":"https://github.com/vrgeoscience/vrgs_docs_v3/tree/master/versioned_docs/version-3.3/properties/properties-attributes.md","tags":[],"version":"3.3","sidebarPosition":72,"frontMatter":{"id":"properties-attributes","title":"Attributes Properties","sidebar_label":"Attributes","sidebar_position":72},"sidebar":"docs","previous":{"title":"Annotations & Multimedia","permalink":"/docs/3.3/properties/properties-annotations-and-multimedia"},"next":{"title":"Geological Objects","permalink":"/docs/3.3/properties/properties-geological-objects"}}');var i=r(74848),n=r(28453);const o={id:"properties-attributes",title:"Attributes Properties",sidebar_label:"Attributes",sidebar_position:72},l="Attributes Properties",h={},c=[{value:"Attributes",id:"attributes",level:2},{value:"Attributes : Log Scale",id:"attributes--log-scale",level:3},{value:"Attributes : Fixed Range",id:"attributes--fixed-range",level:3},{value:"Attributes : Use Filter",id:"attributes--use-filter",level:3},{value:"Attributes : Invert Filter",id:"attributes--invert-filter",level:3},{value:"Attributes : Scale Colours",id:"attributes--scale-colours",level:3},{value:"Attributes : Repeat Colours",id:"attributes--repeat-colours",level:3},{value:"Attributes : Reverse",id:"attributes--reverse",level:3},{value:"Attributes : Show Contours",id:"attributes--show-contours",level:3},{value:"Attributes : Name",id:"attributes--name",level:3},{value:"Attributes : Colour Map",id:"attributes--colour-map",level:3},{value:"Attributes : Layer Type",id:"attributes--layer-type",level:3},{value:"Attributes : Minimum Value",id:"attributes--minimum-value",level:3},{value:"Attributes : Maximum Value",id:"attributes--maximum-value",level:3},{value:"Attributes : Range Minimum",id:"attributes--range-minimum",level:3},{value:"Attributes : Range Maximum",id:"attributes--range-maximum",level:3},{value:"Attributes : Filter Minimum",id:"attributes--filter-minimum",level:3},{value:"Attributes : Filter Maximum",id:"attributes--filter-maximum",level:3},{value:"Attributes : Contour Levels",id:"attributes--contour-levels",level:3},{value:"Attributes : Colour Blend",id:"attributes--colour-blend",level:3}];function a(e){const t={br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"attributes-properties",children:"Attributes Properties"})}),"\n",(0,i.jsx)(t.p,{children:"This page documents the properties available for attributes in VRGS. These properties appear in the Properties panel when an object of this type is selected."}),"\n",(0,i.jsx)(t.h2,{id:"attributes",children:"Attributes"}),"\n",(0,i.jsx)(t.p,{children:"Properties available for CAttributeLayer objects:"}),"\n",(0,i.jsx)(t.h3,{id:"attributes--log-scale",children:"Attributes : Log Scale"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Log Scale"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Switch to Logarithmic colour scale"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Switch to Logarithmic colour scale"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure log scale for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--fixed-range",children:"Attributes : Fixed Range"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Fixed Range"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Use a fixed range for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Use a fixed range for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure fixed range for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--use-filter",children:"Attributes : Use Filter"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Use Filter"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Use a filter for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Use a filter for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure use filter for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--invert-filter",children:"Attributes : Invert Filter"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Invert Filter"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Invert the filter for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Invert the filter for this attribute)"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure invert filter for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--scale-colours",children:"Attributes : Scale 

1Colours"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Scale Colours"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Scale the colour ramp to the extents of the filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Scale the colour ramp to the extents of the filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure scale colours for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--repeat-colours",children:"Attributes : Repeat Colours"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Repeat Colours"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Cycle Through the colours"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Cycle Through the colours"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure repeat colours for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--reverse",children:"Attributes : Reverse"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Reverse"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Reverse the colour map"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Reverse the colour map"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure reverse for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--show-contours",children:"Attributes : Show Contours"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Show Contours"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Show contours for the displayed attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Show contours for the displayed attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure show contours for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--name",children:"Attributes : Name"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Name"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Name"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Name"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure name for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--colour-map",children:"Attributes : Colour Map"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Colour Map"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Colour map for the mesh"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Colour map for the mesh"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure colour map for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--layer-type",children:"Attributes : Layer Type"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Layer Type"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Type of Layer"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Type of Layer"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure layer type for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--minimum-value",children:"Attributes : Minimum Value"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Minimum Value"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Minimum Value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Minimum Value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure minimum value for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--maximum-value",children:"Attributes : Maximum Value"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Maximum Value"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Maximum Value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Maximum Value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure maximum value for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--range-minimum",children:"Attributes : Range Minimum"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Range Minimum"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Minimum possible value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Minimum possible value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure range minimum for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--range-maximum",children:"Attributes : Range Maximum"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Range Maximum"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Maximum possible value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Maximum possible value of this attribute"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure range maximum for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--filter-minimum",children:"Attributes : Filter Minimum"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Filter Minimum"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Minimum value for filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Minimum value for filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure filter minimum for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--filter-maximum",children:"Attributes : Filter Maximum"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Filter Maximum"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Maximum value for filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Maximum value for filter"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure filter maximum for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--contour-levels",children:"Attributes : Contour Levels"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Contour Levels"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Number of contour levels"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Number of contour levels"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure contour levels for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"attributes--colour-blend",children:"Attributes : Colour Blend"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Property name:"})," ",(0,i.jsx)(t.code,{children:"Colour Blend"}),(0,i.jsx)(t.br,{}),"\n",(0,i.jsx)(t.strong,{children:"Description (in app):"})," Blend colour with RGB"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"What it does"}),(0,i.jsx)(t.br,{}),"\n","Blend colour with RGB"]}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"When to use it"}),(0,i.jsx)(t.br,{}),"\n","Use this property to configure colour blend for the CAttributeLayer object."]}),"\n",(0,i.jsx)(t.hr,{})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453(e,t,r){r.d(t,{R:()=>o,x:()=>l});var s=r(96540);const i={},n=s.createContext(i);function o(e){const t=s.useContext(n);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]);