مرجع ضبط مرئيات المنتدى

ملاحظة: تتوفّر ميزة "التمثيل البصري للمنتدى" في "معاينة المطوِّر". لمعرفة المزيد من المعلومات عن الميزات والتحسينات القادمة خلال هذه الفترة، انتقِل إلى صفحة معاينة المطوِّر.

تحدد تهيئة التصورات البيانات وسمات النمط المطلوبة من خلال التصور.

ويُتوقَّع أن يتم ضبط الإعدادات على شكل ملف JSON بالبنية التالية:

{
  "data": [{
    "id": string,
    "label": string,
    "elements": [{
      "type": enum(DataElement),
      "id": string,
      "label": string,
      "options": object(DataElementOptions)
    }]
  }],
  "style": [{
    "id": string,
    "label": string,
    "elements": [{
      "type": enum(StyleElement),
      "id": string,
      "label": string,
      "defaultValue": string | object
    }]
  }],
  "interactions": [{
    "id": string,
    "supportedActions": array(enum(InteractionType))
  }],
  "features": {
   "enableComparisonDateRange": boolean
  }
}

اسم الحقل	Type	الوصف
data[]	Array(object)	تكوين البيانات للعرض المرئي. تؤثر هذه الإعدادات في جزء البيانات في لوحة الموقع.
data[].id	string	رقم تعريف قسم البيانات. يجب أن تكون هذه سلسلة غير فارغة بدون مسافات.
data[].label	string	تصنيف قسم البيانات.
data[].elements[]	string	عناصر البيانات المطلوب عرضها.
data[].elements[].type	string enum(DataElement)	نوع عنصر البيانات المطلوب عرضه
data[].elements[].id	string	رقم تعريف عنصر البيانات. يجب أن تكون هذه سلسلة غير فارغة بدون مسافات.
data[].elements[].label	string	تصنيف التلميح لعنصر البيانات.
data[].elements[].options	object(DataElementOptions)	خيارات البيانات للعنصر. ويعتمد ذلك على نوع عنصر البيانات.
style[]	Array(object)	إعداد النمط الذي يتطلبه التمثيل البصري. تؤثر هذه الإعدادات في جزء النمط في لوحة الخصائص. يمثل كل كائن في الصفيفة عنصر نمط لعرضه. يحدد ترتيب العناصر ترتيب عرضها.
style[].id	string	رقم تعريف قسم النمط. يجب أن تكون هذه سلسلة غير فارغة بدون مسافات.
style[].label	string	تصنيف قسم النمط.
style[].elements	Array(object)	عناصر النمط المطلوب عرضها.
style[].elements[].id	string	رقم تعريف عنصر النمط. يجب أن تكون هذه سلسلة غير فارغة بدون مسافات.
style[].elements[].type	string enum(StyleElement)	نوع عنصر النمط. مثلاً أداة اختيار الخط
style[].elements[].label	string	التلميح أو التصنيف لعنصر النمط. هذا هو نص التسمية لعنصر مربع الاختيار ونص التلميح لأنواع العناصر الأخرى.
style[].elements[].options	Array(object)	تمثّل هذه السمة options للعنصر. يصلح هذا فقط لنوعَين SELECT_SINGLE وSELECT_RADIO من عناصر النمط.
style[].elements[].defaultValue	string OR object	القيمة التلقائية لعنصر النمط. وسيتم تجاهل القيم غير الصالحة.*
interactions[]	Array(object)	تمثّل هذه السمة ضبط التفاعلات في التمثيل البصري. تحدد هذه الإعدادات ما إذا كان يمكن استخدامها كفلتر أم لا.
interactions[].id	string	رقم تعريف عنصر التفاعل. يجب أن تكون هذه سلسلة غير فارغة بدون مسافات.
interactions[].supportedActions	Array (enum(InteractionType)	التفاعلات المحتملة المدعومة
features	object	الميزات التي تريد تفعيلها أو إيقافها في التمثيل البصري
features.enableComparisonDateRange	boolean	فعِّل مقارنة النطاقات الزمنية. ويتم ضبط القيمة تلقائيًا على false في حال عدم تحديد ذلك.

*defaultValue هي سلسلة لجميع العناصر باستثناء أدوات اختيار الألوان. بالنسبة إلى الألوان، يجب أن يكون defaultValue كائنًا للتنسيق:

{
    color: `string`
}

DataElement

يمكن أن تكون قيم عناصر البيانات واحدة مما يلي:

قيمة التعداد	الوصف
المقياس	لعرض عنصر في حقل المقياس.
السمة	يعرض عنصر حقل سمة.
MAX_RESULTS	تحدد الحد الأقصى لصفوف البيانات التي يمكن طلبها من خلال هذا التصور

خيارات DataElement

يمكن أن تكون قيم عناصر البيانات واحدة مما يلي:

قيمة التعداد	نوع الخيار	الخيارات المتاحة
المقياس	الكائن	الحد الأقصى: عدد - الحد الأقصى لعدد المقاييس الحد الأدنى: الرقم - الحد الأدنى لعدد المقاييس المطلوبة
السمة	الكائن	max: number - أقصى عدد مسموح به للأبعاد. الحد الأدنى: الرقم - الحد الأدنى لعدد الأبعاد المطلوبة supportedTypes: قائمة الأنواع المتوافقة. يمكن أن يتضمن supportedTypes TIME أو GEO أو DEFAULT.
MAX_RESULTS	الكائن	max: number - الحد الأقصى لعدد الصفوف التي يمكن أن يطلبها التصور. القيمة التلقائية: 2,500

StyleElement

يمكن أن تكون قيم عناصر النمط واحدة مما يلي:

قيمة التعداد	الوصف	نوع بيانات defaultValue (الإعداد)	نوع بيانات واحد (value) (رسالة)	القيمة التلقائية
FONT_COLOR	عرض أداة اختيار لون الخط القيم الصالحة هي رموز الألوان الست عشرية.	STRING | ‏OBJECT<Color>	STRING | ‏OBJECT<Color>	يتم تحديدها حسب الموضوع.
FONT_SIZE	عرض أداة اختيار حجم الخط القيم الصالحة هي وحدات البكسل التالية: 8، 9، 10، 11، 12، 14، 16، 18، 20، 24، 28، 30، 32، 36، 40، 44، 48، 60، 72، 84، 96.	NUMBER	NUMBER	12
FONT_FAMILY	يعرض أداة اختيار مجموعة الخطوط. القيم الصالحة هي الخطوط التالية: Arial وBoogaloo وBubblegum Sans وChewy وComic Sans MS و ول علينا قريبًا وCormorant Unicase وCourier New وDroid وDroid Sans وEater وUbuntu وUbuntu وUbuntu وUbuntu وUbuntu وGrite Vibes و Indie Flower وLato وLordan و Montserrat وOoleo Script وOpen Sans وOrbiten وPerbiten وPerbit	STRING	STRING	يتم تحديدها حسب الموضوع.
مربّع اختيار	يعرض مربّع اختيار.	BOOLEAN	BOOLEAN	false
إدخال النص	عرض مربّع إدخال نص	STRING	STRING	""
منطقة النص	يؤدي إلى عرض منطقة إدخال نص كبيرة.	STRING	STRING	""
SELECT_SINGLE	يعرض قائمة منسدلة بقيم محددة مسبقًا.	STRING (للقيم الافتراضية والخيارات.label والخيارات.القيمة)	STRING	غير محدّدة
SELECT_RADIO	يعرض أداة اختيار الراديو بقيم محدّدة مسبقًا.	STRING (للقيم الافتراضية والخيارات.label والخيارات.القيمة)	STRING	غير محدّدة
FILL_COLOR	يعرض أداة اختيار لون التعبئة. القيم الصالحة هي رموز الألوان الست عشرية.	STRING | ‏OBJECT<Color>	OBJECT<Color>	يتم تحديدها حسب الموضوع.
BORDER_COLOR	يعرض أداة اختيار لون الحدود. القيم الصالحة هي رموز الألوان الست عشرية.	STRING | ‏OBJECT<Color>	OBJECT<Color>	يتم تحديدها حسب الموضوع.
AXIS_COLOR	يعرض أداة اختيار ألوان المحور. القيم الصالحة هي رموز الألوان الست عشرية.	STRING | ‏OBJECT<Color>	OBJECT<Color>	يتم تحديدها حسب الموضوع.
GRID_COLOR	عرض أداة اختيار الألوان على شكل شبكة القيم الصالحة هي رموز الألوان الست عشرية.	STRING | ‏OBJECT<Color>	OBJECT<Color>	يتم تحديدها حسب الموضوع.
تعتيم	لعرض أداة اختيار التعتيم، الوحدة هي %. تتراوح القيم الصالحة من 0 إلى 1 بزيادات تساوي 0.1	NUMBER	NUMBER	1
LINE_WEIGHT	لعرض أداة اختيار عرض الخط. تتراوح القيم الصالحة من 0 إلى 5. سيتم عرض القيمة "0" على أنّها "بدون" في القائمة المنسدلة.	NUMBER	NUMBER
LINE_STYLE	لعرض منتقي نمط الخط القيم التلقائية المقبولة: solid وdashed وdotted وdouble.	STRING	STRING	"solid"
BORDER_RADIUS	لعرض أداة اختيار نصف قطر الحدود. القيم الصالحة هي: 0 و1 و2 و3 و4 و5 و10 و15 و20 و25 و30 و40 و50 و60 و70 و80 و90 و100	NUMBER	NUMBER	يتم تحديدها حسب الموضوع.
الفترة الزمنية	عرض أداة اختيار الفاصل الزمني القيم هي أعداد صحيحة.	NUMBER	NUMBER	0

تهيئ عناصر النمط الرموز المعروضة في علامة التبويب Style ضمن لوحة "الخصائص".

ملاحظة: يطلُب "SELECT_SINGLE" و"SELECT_RADIO" منك تحديد العناصر للاختيار من بينها في القائمة المنسدلة.

خيارات عناصر النمط

تتيح بعض عناصر النمط الخيارات

options: array(options)

قيمة التعداد	كائن الخيارات
SELECT_SINGLE	{ label: `string`, value: `string` }
SELECT_RADIO	{ label: `string`, value: `string` }
الفترة الزمنية	{ max: `number`, min: `number` }

أنواع البيانات

الكائن<Color>

{
  color: STRING<Color>,
  opacity: NUMBER<Opacity>
}

سلسلة<اللون>

قيمة سلسلة تحتوي على رمز لون ست عشري.

مثال

"color": "#0000ff"

NUMBER<Opacity>

قيمة رقم من 0 إلى 1 بمضاعَفات 0.10

مثال

"opacity": 0.2

InteractionType

تعمل أنواع التفاعل على ضبط خيارات التفاعل المتاحة في نمط Data في لوحة الموقع. في الوقت الحالي، لا يتوفّر سوى "FILTER".

قيمة التعداد	الوصف
"FILTER"	يسمح هذا الإعداد للمستخدمين باستخدام العروض المرئية كفلتر.

مثال على الإعدادات

{
  "data": [{
    "id": "concepts",
    "label": "concepts",
    "elements": [
      {
        "id": "dimension1",
        "label": "first dimension",
        "type": "DIMENSION",
        "options": {
          "min": 1,
          "max": 3,
          "supportedTypes": ["DEFAULT"]
        }
      },
      {
        "id": "metric",
        "label": "metric",
        "type": "METRIC",
        "options": {
          "min": 1,
          "max": 3
        }
      }
    ]
  }],
  "style": [
    {
      "id": "colors",
      "label": "Highlight Colors",
      "elements": [
        {
          "id": "accentColor",
          "label": "Accent Color",
          "type": "SELECT_SINGLE",
          "defaultValue": "rain",
          "options": [
            {
              "label": "Summer",
              "value": "summer"
            },
            {
              "label": "Fall",
              "value": "fall"
            }
          ]
        },
        {
          "id": "reverseColor",
          "label": "Show reverse color",
          "defaultValue": false,
          "type": "CHECKBOX"
        },
        {
          "id": "fillColor",
          "label": "Fill Color",
          "defaultValue": {
            "color": "#0000ff"
          },
          "type": "FILL_COLOR"
        },
        {
          "id": "textOpacity",
          "label": "Text Opacity",
          "defaultValue": 0.2,
          "type": "OPACITY"
        },
        {
          "id": "customText",
          "label": "Custom Text",
          "defaultValue": "0.2",
          "type": "TEXTINPUT"
        }
      ]
    },
    {
      "id": "text",
      "label": "Highlight Text",
      "elements": [
        {
          "id": "textFontSize",
          "label": "Font size",
          "defaultValue": 10,
          "type": "FONT_SIZE"
        },
        {
          "id": "font",
          "label": "Font family",
          "defaultValue": "Arial",
          "type": "FONT_FAMILY"
        }
      ]
    }
  ],
  "interactions": [
    {
      "id": "interactionsConfigId",
      "supportedActions": ["FILTER"]
    }
  ],
  "features": {
    "enableComparisonDateRange": false
  }
}