Variable sp_instanceConst

Type Declaration

• ReadonlyallowWebServiceAccess: true

• Readonlydisplay: "title"

• Readonlyextends: "sys_metadata"

• Readonlyextensible: true

• Readonlylabel: "Instance"

• Readonlyname: "sp_instance"

• Readonlyschema: {
      active: Typed<boolean, { label: "Active" }>;
      advanced_placeholder_dimensions: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Admin can dynamically define the height and width based on Instance option.";
                      label: "Advance placeholder configuration";
                      language: "en";
                      plural: "Advance placeholder configurations";
                  },
              ];
          },
      >;
      async_load: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "Deferred loading will only be active when the checkbox is selected.";
                      label: "Select the checkbox to defer load this widget";
                      language: "en";
                      plural: "Select the checkbox to defer load this widgets";
                  },
              ];
          },
      >;
      async_load_device_type: Typed<
          "mobile"
          | "desktop"
          | "tablet",
          {
              choices: {
                  desktop: { label: "Desktop"; sequence: 1 };
                  mobile: { label: "Mobile"; sequence: 3 };
                  tablet: { label: "Tablet"; sequence: 2 };
              };
              dropdown: "dropdown_without_none";
              label: "Device type";
              maxLength: 1024;
          },
      >;
      async_load_trigger: Typed<
          "viewport"
          | "parallel",
          {
              choices: {
                  parallel: {
                      label: "Parallel | The widget starts loading as soon as the page finishes loading";
                      sequence: 2;
                  };
                  viewport: {
                      label: "Viewport | The widget will only load when it comes into view on the screen";
                      sequence: 1;
                  };
              };
              dropdown: "dropdown_without_none";
              label: "In which order do you want to load the widget?";
          },
      >;
      class_name: Typed<
          string,
          {
              label: [
                  {
                      hint: "Use with page or theme level CSS";
                      label: "Bootstrap class name";
                      language: "en";
                      plural: "Bootstrap class names";
                  },
              ];
          },
      >;
      color: Typed<
          "default"
          | "primary"
          | "warning"
          | "danger"
          | "success"
          | "info",
          {
              choices: {
                  danger: { label: "Danger"; sequence: 6 };
                  default: { label: "Default"; sequence: 1 };
                  info: { label: "Info"; sequence: 4 };
                  primary: { label: "Primary"; sequence: 2 };
                  success: { label: "Success"; sequence: 3 };
                  warning: { label: "Warning"; sequence: 5 };
              };
              columnType: "bootstrap_color";
              dropdown: "dropdown_with_none";
              label: "Bootstrap color";
          },
      >;
      css: Typed<
          string
          | number,
          { columnType: "css"; label: "CSS"; maxLength: 65000 },
      >;
      glyph: Typed<string | number, { columnType: "glyphicon"; label: "Glyph" }>;
      id: Typed<
          string,
          {
              label: [
                  {
                      hint: "Identifier for $sp.getWidgetFromRectangle(id)";
                      label: "ID";
                      language: "en";
                      plural: "IDs";
                  },
              ];
              unique: true;
          },
      >;
      order: Typed<number, { label: "Order" }>;
      placeholder_dimensions: Typed<
          string,
          {
              columnType: "json";
              label: [
                  {
                      hint: "Placeholder Dimensions Configuration For Deferred widget";
                      label: "Placeholder dimensions";
                      language: "en";
                      plural: "Placeholder dimensions";
                  },
              ];
              maxLength: 4000;
          },
      >;
      placeholder_dimensions_script: Typed<
          string
          | ScriptModule<Function>,
          {
              label: [
                  {
                      hint: "Placeholder configuration script";
                      label: "Placeholder configuration script";
                      language: "en";
                      plural: "Placeholder configuration scripts";
                  },
              ];
              maxLength: 4000;
          },
      >;
      placeholder_template: Typed<
          string
          | number,
          {
              columnType: "xml";
              label: [
                  {
                      hint: "Placeholder template for Defer widget";
                      label: "Placeholder template";
                      language: "en";
                      plural: "Placeholder templates";
                  },
              ];
              maxLength: 65000;
          },
      >;
      preserve_placeholder_size: Typed<
          boolean,
          {
              label: [
                  {
                      hint: "To avoid layout shift and retain the original placeholder, select the checkbox.";
                      label: "Limit widget size to placeholder";
                      language: "en";
                      plural: "Limit widget size to placeholders";
                  },
              ];
          },
      >;
      roles: Typed<(string | Role)[], { array: true; label: "Roles" }>;
      short_description: Typed<
          string,
          { label: "Short description"; maxLength: 255 },
      >;
      size: Typed<
          "md"
          | "lg"
          | "xs"
          | "sm",
          {
              choices: {
                  lg: { label: "Large"; sequence: 4 };
                  md: { label: "Medium"; sequence: 3 };
                  sm: { label: "Small"; sequence: 2 };
                  xs: { label: "Extra Small"; sequence: 1 };
              };
              dropdown: "dropdown_with_none";
              label: "Bootstrap size";
          },
      >;
      sp_column: Typed<
          | string
          | Record<"sp_column">
          | ExplicitKey<"sp_column">
          | TableBrand<"sp_column">,
          { cascadeRule: "delete"; label: "Column"; referenceTable: "sp_column" },
      >;
      sp_widget: Typed<
          | string
          | Record<"sp_widget">
          | ExplicitKey<"sp_widget">
          | TableBrand<"sp_widget">,
          {
              label: "Widget";
              referenceQual: "javascript://'data_tableIN' + GlideDBObjectManager.getTables(current.getRecordClassName()).toArray().join()";
              referenceTable: "sp_widget";
          },
      >;
      sys_id: Typed<
          string,
          { columnType: "GUID"; label: "Sys ID"; maxLength: 32; primary: true },
      >;
      title: Typed<string, { label: "Title"; maxLength: 100 }>;
      url: Typed<string, { label: "HREF / URL"; maxLength: 255 }>;
      widget_parameters: Typed<
          string
          | number,
          {
              columnType: "script_server";
              label: "Additional options, JSON format";
              maxLength: 65000;
          },
      >;
  }